File: pyreqcheck.py

package info (click to toggle)
laniakea 0.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 15,460 kB
  • sloc: javascript: 38,493; python: 21,153; sh: 196; makefile: 129; ansic: 3
file content (222 lines) | stat: -rwxr-xr-x 7,777 bytes parent folder | download | duplicates (2)
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
#!/usr/bin/env python3
#
# Check whether all required Python modules are found on the system.
#

import os
import re
import sys
import argparse
import subprocess

if sys.version_info[0] < 3 or sys.version_info[1] < 9:
    print('Laniakea requires at least Python 3.9 to run!', file=sys.stderr)
    sys.exit(2)

try:
    from packaging import version
    from packaging.requirements import Requirement
except ModuleNotFoundError:
    print(
        (
            'Unable to find "packaging" Python module. Please install it via '
            '`apt install python3-packaging` or `pip install packaging`'
        ),
        file=sys.stderr,
    )
    sys.exit(2)

try:
    import tomllib as toml
except ModuleNotFoundError:
    try:
        import tomlkit as toml
    except ModuleNotFoundError:
        print(
            (
                'Unable to find "tomlkit" Python module. Please install it via '
                '`apt install python3-tomlkit` or `pip install tomlkit`'
            ),
            file=sys.stderr,
        )
        sys.exit(2)
    if version.parse(toml.__version__) < version.parse('0.8'):
        print(
            'Your version of tomlkit is too old. We require at least tomlkit>=0.8',
            file=sys.stderr,
        )
        sys.exit(2)

thisfile = __file__
if not os.path.isabs(thisfile):
    thisfile = os.path.normpath(os.path.join(os.getcwd(), thisfile))
os.chdir(os.path.normpath(os.path.join(os.path.dirname(thisfile))))


def get_installed_modules():
    pip_freeze = subprocess.check_output([sys.executable, '-m', 'pip', 'freeze'])
    installed_modules = {}
    for e in pip_freeze.split():
        parts = e.decode().split('==')
        installed_modules[parts[0]] = [parts[1]] if len(parts) > 1 else [None]
    return installed_modules


def ensure_gir(req_str):
    try:
        import gi
    except ModuleNotFoundError:
        print(
            ('Unable to GObject Introspection for Python. Please install it via ' '`apt install python3-gi`'),
            file=sys.stderr,
        )
        sys.exit(2)

    if not req_str.startswith('gir:'):
        raise Exception('GIR dependency definition "{}" is invalid.'.format(req_str))
    req_str = req_str[4:]

    req = Requirement(req_str)
    try:
        gi.require_version(req.name, list(req.specifier)[0].version)
        exec('from gi.repository import {}'.format(req.name))
    except ValueError:
        print(
            'Laniakea requires "{}" GObject introspection data. Please install it to continue.'.format(req.name),
            file=sys.stderr,
        )
        sys.exit(2)


def ensure_dependencies(dependencies, installed_mods=None):
    '''Ensure all dependencies in the list are available in the current environment'''

    if dependencies is None:
        print('No module to check for was defined in this set!', file=sys.stderr)
        sys.exit(2)

    if not installed_mods:
        installed_mods = get_installed_modules()
    for req_str in dependencies:
        # handle GIR dependencies
        if req_str.startswith('gir:'):
            ensure_gir(req_str)
            continue

        req = Requirement(req_str)
        versions = installed_mods.get(req.name)
        if not versions:
            print('Python module "{}" was not found (need: {})'.format(req.name, req_str), file=sys.stderr)
            sys.exit(2)
        if len(versions) == 1 and versions[0] is None:
            continue

        # HACK: workaround for a malformed version string that appeared in python-apt once
        if versions[0].startswith('='):
            versions[0] = re.sub(r'[a-zA-Z]', '', versions[0][1:].replace('-', ''))

        candidates = list(req.specifier.filter(versions))
        if not candidates:
            print(
                'Python module "{}" found, but version "{}" is not sufficient (need: {}).'.format(
                    req.name, versions[0], req_str
                ),
                file=sys.stderr,
            )
            sys.exit(2)


def write_requirements(all_dependencies):
    '''Write requirements.txt file(s) for all groups, based on the current environment'''

    installed_mods = get_installed_modules()
    for group, req_list in all_dependencies.items():
        is_tests = group == 'tests'
        is_docs = group == 'docs'
        ensure_dependencies(req_list, installed_mods)
        req_fname = 'requirements.{}.txt'.format(group)
        if is_docs:
            req_fname = os.path.join('docs', 'requirements.txt')
        with open(req_fname, 'w') as f:
            if is_docs:
                f.write('-r ../requirements.txt\n')
            for req_str in sorted(req_list):
                if req_str.startswith('gir:'):
                    continue  # GIR dependencies don't go into requirements files
                req = Requirement(req_str)
                versions = installed_mods.get(req.name)
                version = versions[0]
                if version:
                    # sanitize versions to work with pip
                    # and the compatible release operator
                    if '.' not in version:
                        version += '.0'
                    if version == '0.0.0':
                        version = None
                if version and not is_tests:
                    if req.name in ('PyGObject', 'systemd-python', 'python-apt', 'pyzmq'):
                        f.write('{}\n'.format(req.name))
                    elif req.specifier:
                        f.write('{}{}\n'.format(req.name, str(req.specifier)))
                    else:
                        f.write('{}~={}\n'.format(req.name, version))
                else:
                    f.write('{}\n'.format(req.name))

    with open('requirements.txt', 'w') as f:
        for group in all_dependencies.keys():
            if group == 'tests' or group == 'docs':
                continue  # we don't want test and doc dependencies installed by default
            f.write('-r requirements.{}.txt\n'.format(group))


def write_requirements_readthedocs(all_dependencies):
    '''Write requirements.txt file, just for Readthedocs'''

    ignore_reqs = set(['systemd-python', 'python-apt', 'PyGObject'])
    with open(os.path.join('docs', 'readthedocs-reqs.txt'), 'w') as f:
        for group, req_list in all_dependencies.items():
            if group == 'tests':
                continue
            for req_str in sorted(req_list):
                if req_str.startswith('gir:'):
                    continue  # GIR dependencies don't go into requirements files
                req = Requirement(req_str)
                if req.name in ignore_reqs:
                    continue
                f.write('{}\n'.format(req.name))


def run(args):
    parser = argparse.ArgumentParser()
    parser.add_argument('--check-group', type=str, help='Test if dependencies in the given group are satisfied.')
    parser.add_argument(
        '--write-requirements', action='store_true', help='Write requirements file based on the current environment.'
    )
    args = parser.parse_args()

    if not args.check_group and not args.write_requirements:
        print('No group name set to check modules for!', file=sys.stderr)
        sys.exit(1)

    with open('pyproject.toml', 'rb') as f:
        pyproject = toml.load(f)

    lkdeps = pyproject['dependency-groups']
    for k, v in pyproject['tool']['laniakea']['dependencies'].items():
        if k not in lkdeps:
            lkdeps[k] = v
        else:
            lkdeps[k].extend(v)

    if args.check_group:
        ensure_dependencies(lkdeps.get(args.check_group))
    if args.write_requirements:
        write_requirements(lkdeps)
        write_requirements_readthedocs(lkdeps)

    return 0


if __name__ == '__main__':
    sys.exit(run(sys.argv[1:]))