aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/python/pipsupport.h
blob: 35e6e765aac83897105f180ecb87caf06cbcca2b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include <utils/filepath.h>
#include <utils/qtcprocess.h>

#include <QFutureWatcher>
#include <QTimer>
#include <QUrl>

namespace Python::Internal {

class PipPackageInfo
{
public:
    QString name;
    QString version;
    QString summary;
    QUrl homePage;
    QString author;
    QString authorEmail;
    QString license;
    Utils::FilePath location;
    QStringList requiresPackage;
    QStringList requiredByPackage;
    Utils::FilePaths files;

    void parseField(const QString &field, const QStringList &value);
};

class PipPackage
{
public:
    explicit PipPackage(const QString &packageName = {},
                        const QString &displayName = {},
                        const QString &version = {})
        : packageName(packageName)
        , displayName(displayName.isEmpty() ? packageName : displayName)
        , version(version)
    {}
    QString packageName;
    QString displayName;
    QString version;
};

class Pip : public QObject
{
public:
    static Pip *instance(const Utils::FilePath &python);

    QFuture<PipPackageInfo> info(const PipPackage &package);

private:
    Pip(const Utils::FilePath &python);

    Utils::FilePath m_python;
};

class PipInstallTask : public QObject
{
    Q_OBJECT
public:
    explicit PipInstallTask(const Utils::FilePath &python);
    void setRequirements(const Utils::FilePath &requirementFile);
    void setWorkingDirectory(const Utils::FilePath &workingDirectory);
    void addPackage(const PipPackage &package);
    void setPackages(const QList<PipPackage> &packages);
    void setTargetPath(const Utils::FilePath &targetPath);
    void setUpgrade(bool upgrade);
    void setSilent(bool silent);
    void run();

signals:
    void finished(bool success);

private:
    void cancel();
    void handleDone();
    void handleOutput();
    void handleError();

    QString packagesDisplayName() const;

    const Utils::FilePath m_python;
    QList<PipPackage> m_packages;
    Utils::FilePath m_requirementsFile;
    Utils::FilePath m_targetPath;
    Utils::Process m_process;
    bool m_upgrade = false;
    bool m_silent = false;
    QFutureInterface<void> m_future;
    QFutureWatcher<void> m_watcher;
    QTimer m_killTimer;
};

void setupPipSupport(QObject *guard);

} // Python::Internal