modoboa-installer/modoboa_installer/python.py at eea74dc3d525a4aa0cc9ce9cdec7dcc5dc0ac902 · modoboa/modoboa-installer · GitHub

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
"""Python related tools."""

import os
import sys

from . import package
from . import utils


def get_path(cmd, venv=None):
    """Return path to cmd."""
    path = cmd
    if venv:
        path = os.path.join(venv, "bin", path)
    return path


def get_pip_path(venv):
    """Return the full path to pip command."""
    binpath = "pip"
    if venv:
        binpath = os.path.join(venv, "bin", binpath)
    return binpath


def install_package(name, venv=None, upgrade=False, binary=True, **kwargs):
    """Install a Python package using pip."""
    cmd = "{} install{}{}{} {}".format(
        get_pip_path(venv),
        " -U" if upgrade else "",
        " --no-binary :all:" if not binary else "",
        " --pre" if kwargs.pop("beta", False) else "",
        name
    )
    utils.exec_cmd(cmd, **kwargs)


def install_packages(names, venv=None, upgrade=False, **kwargs):
    """Install a Python package using pip."""
    cmd = "{} install{}{} {}".format(
        get_pip_path(venv),
        " -U " if upgrade else "",
        " --pre" if kwargs.pop("beta", False) else "",
        " ".join(names)
    )
    utils.exec_cmd(cmd, **kwargs)


def get_package_version(name, venv=None, **kwargs):
    """Returns the version of an installed package."""
    cmd = "{} show {}".format(
        get_pip_path(venv),
        name
    )
    exit_code, output = utils.exec_cmd(cmd, **kwargs)
    if exit_code != 0:
        utils.error(f"Failed to get version of {name}. "
                    f"Output is: {output}")
        sys.exit(1)

    version_list_clean = []
    for line in output.decode().split("\n"):
        if not line.startswith("Version:"):
            continue
        version_item_list = line.split(":")
        version_list = version_item_list[1].split(".")
        for element in version_list:
            try:
                version_list_clean.append(int(element))
            except ValueError:
                utils.printcolor(
                    f"Failed to decode some part of the version of {name}",
                    utils.YELLOW)
                version_list_clean.append(element)
    if len(version_list_clean) == 0:
        utils.printcolor(
            f"Failed to find the version of {name}",
            utils.RED)
        sys.exit(1)
    return version_list_clean


def install_package_from_repository(name, url, vcs="git", venv=None, **kwargs):
    """Install a Python package from its repository."""
    if vcs == "git":
        package.backend.install("git")
    cmd = "{} install -e {}+{}#egg={}".format(
        get_pip_path(venv), vcs, url, name)
    utils.exec_cmd(cmd, **kwargs)


def install_package_from_remote_requirements(url, venv=None, **kwargs):
    """Install a Python package from a file."""
    cmd = "{} install {} {}".format(
        get_pip_path(venv),
        "-r",
        url
    )
    utils.exec_cmd(cmd, **kwargs)


def setup_virtualenv(path, sudo_user=None):
    """Install a virtualenv if needed."""
    if os.path.exists(path):
        return
    if utils.dist_name().startswith("centos") or utils.dist_name().startswith("oracle linux server")::
        python_binary = "python3"
        packages = ["python3"]
    else:
        python_binary = "python3"
        packages = ["python3-venv"]

    package.backend.install_many(packages)
    with utils.settings(sudo_user=sudo_user):
        utils.exec_cmd("{} -m venv {}".format(python_binary, path))
        install_packages(["pip", "setuptools"], venv=path, upgrade=True)