about summary refs log tree commit diff
path: root/nixpkgs/pkgs/development/interpreters/python/hooks/python-runtime-deps-check-hook.py
blob: 5a3a9193917534d893b8b0233125367a8ee3a184 (plain) (blame)
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
#!/usr/bin/env python3
"""
The runtimeDependenciesHook validates, that all dependencies specified
in wheel metadata are available in the local environment.

In case that does not hold, it will print missing dependencies and
violated version constraints.
"""


import importlib.metadata
import re
import sys
import tempfile
from argparse import ArgumentParser
from zipfile import ZipFile

from packaging.metadata import Metadata, parse_email
from packaging.requirements import Requirement

argparser = ArgumentParser()
argparser.add_argument("wheel", help="Path to the .whl file to test")


def error(msg: str) -> None:
    print(f"  - {msg}", file=sys.stderr)


def normalize_name(name: str) -> str:
    """
    Normalize package names according to PEP503
    """
    return re.sub(r"[-_.]+", "-", name).lower()


def get_manifest_text_from_wheel(wheel: str) -> str:
    """
    Given a path to a wheel, this function will try to extract the
    METADATA file in the wheels .dist-info directory.
    """
    with ZipFile(wheel) as zipfile:
        for zipinfo in zipfile.infolist():
            if zipinfo.filename.endswith(".dist-info/METADATA"):
                with tempfile.TemporaryDirectory() as tmp:
                    path = zipfile.extract(zipinfo, path=tmp)
                    with open(path, encoding="utf-8") as fd:
                        return fd.read()

    raise RuntimeError("No METADATA file found in wheel")


def get_metadata(wheel: str) -> Metadata:
    """
    Given a path to a wheel, returns a parsed Metadata object.
    """
    text = get_manifest_text_from_wheel(wheel)
    raw, _ = parse_email(text)
    metadata = Metadata.from_raw(raw)

    return metadata


def test_requirement(requirement: Requirement) -> bool:
    """
    Given a requirement specification, tests whether the dependency can
    be resolved in the local environment, and whether it satisfies the
    specified version constraints.
    """
    if requirement.marker and not requirement.marker.evaluate():
        # ignore requirements with incompatible markers
        return True

    package_name = normalize_name(requirement.name)

    try:
        package = importlib.metadata.distribution(requirement.name)
    except importlib.metadata.PackageNotFoundError:
        error(f"{package_name} not installed")
        return False

    if package.version not in requirement.specifier:
        error(
            f"{package_name}{requirement.specifier} not satisfied by version {package.version}"
        )
        return False

    return True


if __name__ == "__main__":
    args = argparser.parse_args()

    metadata = get_metadata(args.wheel)
    tests = [test_requirement(requirement) for requirement in metadata.requires_dist]

    if not all(tests):
        sys.exit(1)