aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/python/pipsupport.cpp
blob: bc3886145609c67797c8aaa1f9901998acacb106 (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#include "pipsupport.h"

#include "pythontr.h"
#include "pythonutils.h"

#include <coreplugin/messagemanager.h>
#include <coreplugin/progressmanager/processprogress.h>

#include <projectexplorer/project.h>
#include <projectexplorer/projectmanager.h>
#include <projectexplorer/target.h>

#include <QtTaskTree/QTaskTree>

#include <utils/algorithm.h>
#include <utils/mimeutils.h>
#include <utils/qtcprocess.h>

using namespace Core;
using namespace QtTaskTree;
using namespace Utils;

namespace Python::Internal {

QString PipInstallerData::packagesDisplayName() const
{
    return requirementsFile.isEmpty()
               ? Utils::transform(packages, &PipPackage::displayName).join(", ")
               : requirementsFile.toUserOutput();
}

Group pipInstallerTask(const PipInstallerData &data)
{
    const auto onSetup = [data](Process &process) {
        if (data.packages.isEmpty() && data.requirementsFile.isEmpty())
            return SetupResult::StopWithError;

        QStringList arguments = {"-m", "pip", "install"};
        if (!data.requirementsFile.isEmpty()) {
            arguments << "-r" << data.requirementsFile.toUrlishString();
        } else {
            for (const PipPackage &package : std::as_const(data.packages)) {
                QString pipPackage = package.packageName;
                if (!package.version.isEmpty())
                    pipPackage += "==" + package.version;
                arguments << pipPackage;
            }
        }

        if (!data.targetPath.isEmpty()) {
            QTC_ASSERT(data.targetPath.isSameDevice(data.python), return SetupResult::StopWithError);
            arguments << "-t" << data.targetPath.path();
        } else if (!isVenvPython(data.python)) {
            arguments << "--user"; // add --user to global pythons, but skip it for venv pythons
        }

        if (data.upgrade)
            arguments << "--upgrade";

        QString operation;
        if (!data.requirementsFile.isEmpty()) {
            operation = data.upgrade ? Tr::tr("Update Requirements") : Tr::tr("Install Requirements");
        } else if (data.packages.count() == 1) {
            //: %1 = package name
            operation = data.upgrade ? Tr::tr("Update %1")
                                       //: %1 = package name
                                       : Tr::tr("Install %1");
            operation = operation.arg(data.packages.first().displayName);
        } else {
            operation = data.upgrade ? Tr::tr("Update Packages") : Tr::tr("Install Packages");
        }

        process.setCommand({data.python, arguments});
        process.setTerminalMode(data.silent ? TerminalMode::Off : TerminalMode::Run);
        if (!data.workingDirectory.isEmpty())
            process.setWorkingDirectory(data.workingDirectory);
        auto progress = new ProcessProgress(&process);
        progress->setDisplayName(operation);

        MessageManager::writeSilently(Tr::tr("Running \"%1\" to install %2.")
                .arg(process.commandLine().toUserOutput(), data.packagesDisplayName()));

        QObject::connect(&process, &Process::readyReadStandardError, &process, [process = &process] {
            const QString &stdOut = QString::fromLocal8Bit(process->readAllRawStandardOutput().trimmed());
            if (!stdOut.isEmpty())
                MessageManager::writeSilently(stdOut);
        });
        QObject::connect(&process, &Process::readyReadStandardOutput, &process, [process = &process] {
            const QString &stdErr = QString::fromLocal8Bit(process->readAllRawStandardError().trimmed());
            if (!stdErr.isEmpty())
                MessageManager::writeSilently(stdErr);
        });
        return SetupResult::Continue;
    };

    const auto packagesDisplayName = data.packagesDisplayName();

    const auto onDone = [packagesDisplayName](const Process &process) {
        MessageManager::writeFlashing(Tr::tr("Installing \"%1\" failed: %2")
                                          .arg(packagesDisplayName, process.exitMessage()));
    };

    const auto onTimeout = [packagesDisplayName] {
        MessageManager::writeFlashing(
            Tr::tr("The installation of \"%1\" was canceled by timeout.").arg(packagesDisplayName));
    };

    using namespace std::literals::chrono_literals;
    return {
        ProcessTask(onSetup, onDone, CallDone::OnError)
            .withTimeout(5min, onTimeout)
    };
}

void PipPackageInfo::parseField(const QString &field, const QStringList &data)
{
    if (field.isEmpty())
        return;
    if (field == "Name") {
        name = data.value(0);
    } else if (field == "Version") {
        version = data.value(0);
    } else if (field == "Summary") {
        summary = data.value(0);
    } else if (field == "Home-page") {
        homePage = QUrl(data.value(0));
    } else if (field == "Author") {
        author = data.value(0);
    } else if (field == "Author-email") {
        authorEmail = data.value(0);
    } else if (field == "License") {
        license = data.value(0);
    } else if (field == "Location") {
        location = FilePath::fromUserInput(data.value(0)).normalizedPathName();
    } else if (field == "Requires") {
        requiresPackage = data.value(0).split(',', Qt::SkipEmptyParts);
    } else if (field == "Required-by") {
        requiredByPackage = data.value(0).split(',', Qt::SkipEmptyParts);
    } else if (field == "Files") {
        for (const QString &fileName : data) {
            if (!fileName.isEmpty())
                files.append(FilePath::fromUserInput(fileName.trimmed()));
        }
    }
}

} // Python::Internal