File: pytest_helpers.py

package info (click to toggle)
scikit-build 0.18.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,792 kB
  • sloc: python: 5,258; cpp: 284; makefile: 171; f90: 12; sh: 7
file content (113 lines) | stat: -rw-r--r-- 4,183 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
from __future__ import annotations

import sys
import tarfile
from zipfile import ZipFile

from packaging.version import Version

from skbuild import __version__ as skbuild_version

from . import list_ancestors

if sys.version_info < (3, 8):
    import importlib_metadata as metadata
else:
    from importlib import metadata


def check_sdist_content(sdist_archive, expected_distribution_name, expected_content, package_dir=""):
    """This function raises an AssertionError if the given sdist_archive
    does not have the expected content.
    """
    sdist_zip = sdist_archive.endswith(".zip")
    sdist_tar = sdist_archive.endswith(".tar.gz")
    assert sdist_zip or sdist_tar

    expected_content = set(expected_content)

    expected_name = "_".join(expected_distribution_name.split("-")[:-1])

    if not package_dir:
        egg_info_dir = f"{expected_distribution_name}/{expected_name}.egg-info"
    else:
        egg_info_dir = f"{expected_distribution_name}/{package_dir}/{expected_name}.egg-info"

    expected_content |= {
        f"{expected_distribution_name}/PKG-INFO",
        f"{expected_distribution_name}/setup.cfg",
        f"{egg_info_dir}/dependency_links.txt",
        f"{egg_info_dir}/top_level.txt",
        f"{egg_info_dir}/PKG-INFO",
        f"{egg_info_dir}/SOURCES.txt",
    }

    if sdist_zip and sys.version_info > (3, 7, 1):
        # Add directory entries in ZIP files created by distutils.
        # See https://github.com/python/cpython/pull/9419
        for entry in expected_content:
            expected_content |= {ent + "/" for ent in list_ancestors(entry)}

    if sdist_zip:
        with ZipFile(sdist_archive) as zp:
            member_list = set(zp.namelist())
    else:
        with tarfile.open(sdist_archive) as tf:
            member_list = {member.name for member in tf.getmembers() if not member.isdir()}

    assert member_list == expected_content


def check_wheel_content(wheel_archive, expected_distribution_name, expected_content, pure=False):
    """This function raises an AssertionError if the given wheel_archive
    does not have the expected content.

    Note that this function already takes care of appending the
    ``<expected_distribution_name>.dist-info`` files to the ``expected_content``
    list.
    """

    expected_content = set(expected_content)
    expected_content |= {
        f"{expected_distribution_name}.dist-info/top_level.txt",
        f"{expected_distribution_name}.dist-info/WHEEL",
        f"{expected_distribution_name}.dist-info/RECORD",
        f"{expected_distribution_name}.dist-info/METADATA",
    }

    wheel_version = Version(metadata.version("wheel"))

    if wheel_version < Version("0.31.0"):
        # These files were specified in the now-withdrawn PEP 426
        # See https://github.com/pypa/wheel/issues/195
        expected_content |= {
            f"{expected_distribution_name}.dist-info/DESCRIPTION.rst",
            f"{expected_distribution_name}.dist-info/metadata.json",
        }

    if Version("0.33.1") < wheel_version < Version("0.33.4"):
        # Include directory entries when building wheel
        # See https://github.com/pypa/wheel/issues/287 and https://github.com/pypa/wheel/issues/294
        for entry in expected_content:
            expected_content |= {entry + "/" for entry in list_ancestors(entry)}

    if pure:
        assert wheel_archive.endswith("-none-any.whl")
    else:
        assert not wheel_archive.endswith("-none-any.whl")

    with ZipFile(wheel_archive) as archive:
        member_list = set(archive.namelist())

        assert member_list == expected_content

        # PEP-0427: Generator is the name and optionally the version of the
        # software that produced the archive.
        # See https://www.python.org/dev/peps/pep-0427/#file-contents
        current_generator = None
        with archive.open(f"{expected_distribution_name}.dist-info/WHEEL") as wheel_file:
            for line in wheel_file:
                if line.startswith(b"Generator"):
                    current_generator = line.split(b":")[1].strip()
                    break
        assert current_generator == f"skbuild {skbuild_version}".encode()