Aluode/PerceptionLabPortable

1"""2Handling of Core Metadata for Python packages (including reading and writing).3 4See: https://packaging.python.org/en/latest/specifications/core-metadata/5"""6 7from __future__ import annotations8 9import os10import stat11import textwrap12from email import message_from_file13from email.message import Message14from tempfile import NamedTemporaryFile15 16from packaging.markers import Marker17from packaging.requirements import Requirement18from packaging.utils import canonicalize_name, canonicalize_version19from packaging.version import Version20 21from . import _normalization, _reqs22from ._static import is_static23from .warnings import SetuptoolsDeprecationWarning24 25from distutils.util import rfc822_escape26 27 28def get_metadata_version(self):29    mv = getattr(self, 'metadata_version', None)30    if mv is None:31        mv = Version('2.4')32        self.metadata_version = mv33    return mv34 35 36def rfc822_unescape(content: str) -> str:37    """Reverse RFC-822 escaping by removing leading whitespaces from content."""38    lines = content.splitlines()39    if len(lines) == 1:40        return lines[0].lstrip()41    return '\n'.join((lines[0].lstrip(), textwrap.dedent('\n'.join(lines[1:]))))42 43 44def _read_field_from_msg(msg: Message, field: str) -> str | None:45    """Read Message header field."""46    value = msg[field]47    if value == 'UNKNOWN':48        return None49    return value50 51 52def _read_field_unescaped_from_msg(msg: Message, field: str) -> str | None:53    """Read Message header field and apply rfc822_unescape."""54    value = _read_field_from_msg(msg, field)55    if value is None:56        return value57    return rfc822_unescape(value)58 59 60def _read_list_from_msg(msg: Message, field: str) -> list[str] | None:61    """Read Message header field and return all results as list."""62    values = msg.get_all(field, None)63    if values == []:64        return None65    return values66 67 68def _read_payload_from_msg(msg: Message) -> str | None:69    value = str(msg.get_payload()).strip()70    if value == 'UNKNOWN' or not value:71        return None72    return value73 74 75def read_pkg_file(self, file):76    """Reads the metadata values from a file object."""77    msg = message_from_file(file)78 79    self.metadata_version = Version(msg['metadata-version'])80    self.name = _read_field_from_msg(msg, 'name')81    self.version = _read_field_from_msg(msg, 'version')82    self.description = _read_field_from_msg(msg, 'summary')83    # we are filling author only.84    self.author = _read_field_from_msg(msg, 'author')85    self.maintainer = None86    self.author_email = _read_field_from_msg(msg, 'author-email')87    self.maintainer_email = None88    self.url = _read_field_from_msg(msg, 'home-page')89    self.download_url = _read_field_from_msg(msg, 'download-url')90    self.license = _read_field_unescaped_from_msg(msg, 'license')91    self.license_expression = _read_field_unescaped_from_msg(msg, 'license-expression')92 93    self.long_description = _read_field_unescaped_from_msg(msg, 'description')94    if self.long_description is None and self.metadata_version >= Version('2.1'):95        self.long_description = _read_payload_from_msg(msg)96    self.description = _read_field_from_msg(msg, 'summary')97 98    if 'keywords' in msg:99        self.keywords = _read_field_from_msg(msg, 'keywords').split(',')100 101    self.platforms = _read_list_from_msg(msg, 'platform')102    self.classifiers = _read_list_from_msg(msg, 'classifier')103 104    # PEP 314 - these fields only exist in 1.1105    if self.metadata_version == Version('1.1'):106        self.requires = _read_list_from_msg(msg, 'requires')107        self.provides = _read_list_from_msg(msg, 'provides')108        self.obsoletes = _read_list_from_msg(msg, 'obsoletes')109    else:110        self.requires = None111        self.provides = None112        self.obsoletes = None113 114    self.license_files = _read_list_from_msg(msg, 'license-file')115 116 117def single_line(val):118    """119    Quick and dirty validation for Summary pypa/setuptools#1390.120    """121    if '\n' in val:122        # TODO: Replace with `raise ValueError("newlines not allowed")`123        # after reviewing #2893.124        msg = "newlines are not allowed in `summary` and will break in the future"125        SetuptoolsDeprecationWarning.emit("Invalid config.", msg)126        # due_date is undefined. Controversial change, there was a lot of push back.127        val = val.strip().split('\n')[0]128    return val129 130 131def write_pkg_info(self, base_dir):132    """Write the PKG-INFO file into the release tree."""133    temp = ""134    final = os.path.join(base_dir, 'PKG-INFO')135    try:136        # Use a temporary file while writing to avoid race conditions137        # (e.g. `importlib.metadata` reading `.egg-info/PKG-INFO`):138        with NamedTemporaryFile("w", encoding="utf-8", dir=base_dir, delete=False) as f:139            temp = f.name140            self.write_pkg_file(f)141        permissions = stat.S_IMODE(os.lstat(temp).st_mode)142        os.chmod(temp, permissions | stat.S_IRGRP | stat.S_IROTH)143        os.replace(temp, final)  # atomic operation.144    finally:145        if temp and os.path.exists(temp):146            os.remove(temp)147 148 149# Based on Python 3.5 version150def write_pkg_file(self, file):  # noqa: C901  # is too complex (14)  # FIXME151    """Write the PKG-INFO format data to a file object."""152    version = self.get_metadata_version()153 154    def write_field(key, value):155        file.write(f"{key}: {value}\n")156 157    write_field('Metadata-Version', str(version))158    write_field('Name', self.get_name())159    write_field('Version', self.get_version())160 161    summary = self.get_description()162    if summary:163        write_field('Summary', single_line(summary))164 165    optional_fields = (166        ('Home-page', 'url'),167        ('Download-URL', 'download_url'),168        ('Author', 'author'),169        ('Author-email', 'author_email'),170        ('Maintainer', 'maintainer'),171        ('Maintainer-email', 'maintainer_email'),172    )173 174    for field, attr in optional_fields:175        attr_val = getattr(self, attr, None)176        if attr_val is not None:177            write_field(field, attr_val)178 179    if license_expression := self.license_expression:180        write_field('License-Expression', license_expression)181    elif license := self.get_license():182        write_field('License', rfc822_escape(license))183 184    for label, url in self.project_urls.items():185        write_field('Project-URL', f'{label}, {url}')186 187    keywords = ','.join(self.get_keywords())188    if keywords:189        write_field('Keywords', keywords)190 191    platforms = self.get_platforms() or []192    for platform in platforms:193        write_field('Platform', platform)194 195    self._write_list(file, 'Classifier', self.get_classifiers())196 197    # PEP 314198    self._write_list(file, 'Requires', self.get_requires())199    self._write_list(file, 'Provides', self.get_provides())200    self._write_list(file, 'Obsoletes', self.get_obsoletes())201 202    # Setuptools specific for PEP 345203    if hasattr(self, 'python_requires'):204        write_field('Requires-Python', self.python_requires)205 206    # PEP 566207    if self.long_description_content_type:208        write_field('Description-Content-Type', self.long_description_content_type)209 210    safe_license_files = map(_safe_license_file, self.license_files or [])211    self._write_list(file, 'License-File', safe_license_files)212    _write_requirements(self, file)213 214    for field, attr in _POSSIBLE_DYNAMIC_FIELDS.items():215        if (val := getattr(self, attr, None)) and not is_static(val):216            write_field('Dynamic', field)217 218    long_description = self.get_long_description()219    if long_description:220        file.write(f"\n{long_description}")221        if not long_description.endswith("\n"):222            file.write("\n")223 224 225def _write_requirements(self, file):226    for req in _reqs.parse(self.install_requires):227        file.write(f"Requires-Dist: {req}\n")228 229    processed_extras = {}230    for augmented_extra, reqs in self.extras_require.items():231        # Historically, setuptools allows "augmented extras": `<extra>:<condition>`232        unsafe_extra, _, condition = augmented_extra.partition(":")233        unsafe_extra = unsafe_extra.strip()234        extra = _normalization.safe_extra(unsafe_extra)235 236        if extra:237            _write_provides_extra(file, processed_extras, extra, unsafe_extra)238        for req in _reqs.parse_strings(reqs):239            r = _include_extra(req, extra, condition.strip())240            file.write(f"Requires-Dist: {r}\n")241 242    return processed_extras243 244 245def _include_extra(req: str, extra: str, condition: str) -> Requirement:246    r = Requirement(req)  # create a fresh object that can be modified247    parts = (248        f"({r.marker})" if r.marker else None,249        f"({condition})" if condition else None,250        f"extra == {extra!r}" if extra else None,251    )252    r.marker = Marker(" and ".join(x for x in parts if x))253    return r254 255 256def _write_provides_extra(file, processed_extras, safe, unsafe):257    previous = processed_extras.get(safe)258    if previous == unsafe:259        SetuptoolsDeprecationWarning.emit(260            'Ambiguity during "extra" normalization for dependencies.',261            f"""262            {previous!r} and {unsafe!r} normalize to the same value:\n263                {safe!r}\n264            In future versions, setuptools might halt the build process.265            """,266            see_url="https://peps.python.org/pep-0685/",267        )268    else:269        processed_extras[safe] = unsafe270        file.write(f"Provides-Extra: {safe}\n")271 272 273# from pypa/distutils#244; needed only until that logic is always available274def get_fullname(self):275    return _distribution_fullname(self.get_name(), self.get_version())276 277 278def _distribution_fullname(name: str, version: str) -> str:279    """280    >>> _distribution_fullname('setup.tools', '1.0-2')281    'setup_tools-1.0.post2'282    >>> _distribution_fullname('setup-tools', '1.2post2')283    'setup_tools-1.2.post2'284    >>> _distribution_fullname('setup-tools', '1.0-r2')285    'setup_tools-1.0.post2'286    >>> _distribution_fullname('setup.tools', '1.0.post')287    'setup_tools-1.0.post0'288    >>> _distribution_fullname('setup.tools', '1.0+ubuntu-1')289    'setup_tools-1.0+ubuntu.1'290    """291    return "{}-{}".format(292        canonicalize_name(name).replace('-', '_'),293        canonicalize_version(version, strip_trailing_zero=False),294    )295 296 297def _safe_license_file(file):298    # XXX: Do we need this after the deprecation discussed in #4892, #4896??299    normalized = os.path.normpath(file).replace(os.sep, "/")300    if "../" in normalized:301        return os.path.basename(normalized)  # Temporarily restore pre PEP639 behaviour302    return normalized303 304 305_POSSIBLE_DYNAMIC_FIELDS = {306    # Core Metadata Field x related Distribution attribute307    "author": "author",308    "author-email": "author_email",309    "classifier": "classifiers",310    "description": "long_description",311    "description-content-type": "long_description_content_type",312    "download-url": "download_url",313    "home-page": "url",314    "keywords": "keywords",315    "license": "license",316    # XXX: License-File is complicated because the user gives globs that are expanded317    #      during the build. Without special handling it is likely always318    #      marked as Dynamic, which is an acceptable outcome according to:319    #      https://github.com/pypa/setuptools/issues/4629#issuecomment-2331233677320    "license-file": "license_files",321    "license-expression": "license_expression",  # PEP 639322    "maintainer": "maintainer",323    "maintainer-email": "maintainer_email",324    "obsoletes": "obsoletes",325    # "obsoletes-dist": "obsoletes_dist",  # NOT USED326    "platform": "platforms",327    "project-url": "project_urls",328    "provides": "provides",329    # "provides-dist": "provides_dist",  # NOT USED330    "provides-extra": "extras_require",331    "requires": "requires",332    "requires-dist": "install_requires",333    # "requires-external": "requires_external",  # NOT USED334    "requires-python": "python_requires",335    "summary": "description",336    # "supported-platform": "supported_platforms",  # NOT USED337}338