py2docfx 0.1.16.dev2064350__py3-none-any.whl → 0.1.17__py3-none-any.whl

py2docfx/venv/basevenv/Lib/site-packages/setuptools/command/editable_wheel.py

@@ -29,10 +29,10 @@ from typing import TYPE_CHECKING, Protocol, TypeVar, cast
 
 from .. import Command, _normalization, _path, _shutil, errors, namespaces
 from .._path import StrPath
-from ..compat import py312
+from ..compat import py310, py312
 from ..discovery import find_package_path
 from ..dist import Distribution
-from ..warnings import InformationOnly, SetuptoolsDeprecationWarning, SetuptoolsWarning
+from ..warnings import InformationOnly, SetuptoolsDeprecationWarning
 from .build import build as build_cls
 from .build_py import build_py as build_py_cls
 from .dist_info import dist_info as dist_info_cls
@@ -137,10 +137,14 @@ class editable_wheel(Command):
             bdist_wheel.write_wheelfile(self.dist_info_dir)
 
             self._create_wheel_file(bdist_wheel)
-        except Exception:
-            traceback.print_exc()
+        except Exception as ex:
             project = self.distribution.name or self.distribution.get_name()
-            _DebuggingTips.emit(project=project)
+            py310.add_note(
+                ex,
+                f"An error occurred when building editable wheel for {project}.\n"
+                "See debugging tips in: "
+                "https://setuptools.pypa.io/en/latest/userguide/development_mode.html#debugging-tips",
+            )
             raise
 
     def _ensure_dist_info(self):
@@ -211,6 +215,11 @@ class editable_wheel(Command):
         install.install_headers = headers
         install.install_data = data
 
+        # For portability, ensure scripts are built with #!python shebang
+        # pypa/setuptools#4863
+        build_scripts = dist.get_command_obj("build_scripts")
+        build_scripts.executable = 'python'
+
         install_scripts = cast(
             install_scripts_cls, dist.get_command_obj("install_scripts")
         )
@@ -897,29 +906,3 @@ def _finder_template(
 
 class LinksNotSupported(errors.FileError):
     """File system does not seem to support either symlinks or hard links."""
-
-
-class _DebuggingTips(SetuptoolsWarning):
-    _SUMMARY = "Problem in editable installation."
-    _DETAILS = """
-    An error happened while installing `{project}` in editable mode.
-
-    The following steps are recommended to help debug this problem:
-
-    - Try to install the project normally, without using the editable mode.
-      Does the error still persist?
-      (If it does, try fixing the problem before attempting the editable mode).
-    - If you are using binary extensions, make sure you have all OS-level
-      dependencies installed (e.g. compilers, toolchains, binary libraries, ...).
-    - Try the latest version of setuptools (maybe the error was already fixed).
-    - If you (or your project dependencies) are using any setuptools extension
-      or customization, make sure they support the editable mode.
-
-    After following the steps above, if the problem still persists and
-    you think this is related to how setuptools handles editable installations,
-    please submit a reproducible example
-    (see https://stackoverflow.com/help/minimal-reproducible-example) to:
-
-        https://github.com/pypa/setuptools/issues
-    """
-    _SEE_DOCS = "userguide/development_mode.html"

py2docfx/venv/basevenv/Lib/site-packages/setuptools/command/egg_info.py

@@ -655,8 +655,6 @@ def write_pkg_info(cmd, basename, filename) -> None:
         metadata.name, oldname = cmd.egg_name, metadata.name
 
         try:
-            # write unescaped data to PKG-INFO, so older pkg_resources
-            # can still parse it
             metadata.write_pkg_info(cmd.egg_info)
         finally:
             metadata.name, metadata.version = oldname, oldver

py2docfx/venv/basevenv/Lib/site-packages/setuptools/command/install.py

@@ -1,16 +1,12 @@
 from __future__ import annotations
 
-import glob
 import inspect
 import platform
 from collections.abc import Callable
-from typing import TYPE_CHECKING, Any, ClassVar, cast
-
-import setuptools
+from typing import TYPE_CHECKING, Any, ClassVar
 
 from ..dist import Distribution
 from ..warnings import SetuptoolsDeprecationWarning, SetuptoolsWarning
-from .bdist_egg import bdist_egg as bdist_egg_cls
 
 import distutils.command.install as orig
 from distutils.errors import DistutilsArgError
@@ -26,7 +22,7 @@ def __getattr__(name: str):  # pragma: no cover
     if name == "_install":
         SetuptoolsDeprecationWarning.emit(
             "`setuptools.command._install` was an internal implementation detail "
-            + "that was left in for numpy<1.9 support.",
+            "that was left in for numpy<1.9 support.",
             due_date=(2025, 5, 2),  # Originally added on 2024-11-01
         )
         return orig.install
@@ -67,9 +63,7 @@ class install(orig.install):
             standards-based tools.
             """,
             see_url="https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html",
-            # TODO: Document how to bootstrap setuptools without install
-            #       (e.g. by unzipping the wheel file)
-            #       and then add a due_date to this warning.
+            due_date=(2025, 10, 31),
         )
 
         super().initialize_options()
@@ -97,19 +91,6 @@ class install(orig.install):
         self.extra_dirs = ''
         return None
 
-    def run(self):
-        # Explicit request for old-style install?  Just do it
-        if self.old_and_unmanageable or self.single_version_externally_managed:
-            return super().run()
-
-        if not self._called_from_setup(inspect.currentframe()):
-            # Run in backward-compatibility mode to support bdist_* commands.
-            super().run()
-        else:
-            self.do_egg_install()
-
-        return None
-
     @staticmethod
     def _called_from_setup(run_frame):
         """
@@ -143,39 +124,6 @@ class install(orig.install):
 
         return False
 
-    def do_egg_install(self) -> None:
-        easy_install = self.distribution.get_command_class('easy_install')
-
-        cmd = cast(
-            # We'd want to cast easy_install as type[easy_install_cls] but a bug in
-            # mypy makes it think easy_install() returns a Command on Python 3.12+
-            # https://github.com/python/mypy/issues/18088
-            easy_install_cls,
-            easy_install(  # type: ignore[call-arg]
-                self.distribution,
-                args="x",
-                root=self.root,
-                record=self.record,
-            ),
-        )
-        cmd.ensure_finalized()  # finalize before bdist_egg munges install cmd
-        cmd.always_copy_from = '.'  # make sure local-dir eggs get installed
-
-        # pick up setup-dir .egg files only: no .egg-info
-        cmd.package_index.scan(glob.glob('*.egg'))
-
-        self.run_command('bdist_egg')
-        bdist_egg = cast(bdist_egg_cls, self.distribution.get_command_obj('bdist_egg'))
-        args = [bdist_egg.egg_output]
-
-        if setuptools.bootstrap_install_from:
-            # Bootstrap self-installation of setuptools
-            args.insert(0, setuptools.bootstrap_install_from)
-
-        cmd.args = args
-        cmd.run(show_deprecation=False)
-        setuptools.bootstrap_install_from = None
-
 
 # XXX Python 3.1 doesn't see _nc if this is inside the class
 install.sub_commands = [

py2docfx/venv/basevenv/Lib/site-packages/setuptools/command/install_scripts.py

@@ -32,20 +32,14 @@ class install_scripts(orig.install_scripts):
 
     def _install_ep_scripts(self):
         # Delay import side-effects
-        from pkg_resources import Distribution, PathMetadata
-
-        from . import easy_install as ei
+        from .. import _scripts
+        from .._importlib import metadata
 
         ei_cmd = self.get_finalized_command("egg_info")
-        dist = Distribution(
-            ei_cmd.egg_base,
-            PathMetadata(ei_cmd.egg_base, ei_cmd.egg_info),
-            ei_cmd.egg_name,
-            ei_cmd.egg_version,
-        )
+        dist = metadata.Distribution.at(path=ei_cmd.egg_info)
         bs_cmd = self.get_finalized_command('build_scripts')
         exec_param = getattr(bs_cmd, 'executable', None)
-        writer = ei.ScriptWriter
+        writer = _scripts.ScriptWriter
         if exec_param == sys.executable:
             # In case the path to the Python executable contains a space, wrap
             # it so it's not split up.
@@ -58,7 +52,7 @@ class install_scripts(orig.install_scripts):
 
     def write_script(self, script_name, contents, mode: str = "t", *ignored) -> None:
         """Write an executable file to the scripts directory"""
-        from setuptools.command.easy_install import chmod, current_umask
+        from .._shutil import attempt_chmod_verbose as chmod, current_umask
 
         log.info("Installing %s script to %s", script_name, self.install_dir)
         target = os.path.join(self.install_dir, script_name)

py2docfx/venv/basevenv/Lib/site-packages/setuptools/command/sdist.py

@@ -30,7 +30,7 @@ class sdist(orig.sdist):
         (
             'keep-temp',
             'k',
-            "keep the distribution tree around after creating " + "archive file(s)",
+            "keep the distribution tree around after creating archive file(s)",
         ),
         (
             'dist-dir=',

py2docfx/venv/basevenv/Lib/site-packages/setuptools/compat/py310.py

@@ -7,3 +7,14 @@ if sys.version_info >= (3, 11):
     import tomllib
 else:  # pragma: no cover
     import tomli as tomllib
+
+
+if sys.version_info >= (3, 11):
+
+    def add_note(ex, note):
+        ex.add_note(note)
+
+else:  # pragma: no cover
+
+    def add_note(ex, note):
+        vars(ex).setdefault('__notes__', []).append(note)

py2docfx/venv/basevenv/Lib/site-packages/setuptools/dist.py

@@ -46,8 +46,6 @@ from distutils.util import strtobool
 if TYPE_CHECKING:
     from typing_extensions import TypeAlias
 
-    from pkg_resources import Distribution as _pkg_resources_Distribution
-
 
 __all__ = ['Distribution']
 
@@ -471,12 +469,13 @@ class Distribution(_Distribution):
         cls, patterns: list[str], enforce_match: bool = True
     ) -> Iterator[str]:
         """
-        >>> list(Distribution._expand_patterns(['LICENSE']))
-        ['LICENSE']
+        >>> getfixture('sample_project_cwd')
+        >>> list(Distribution._expand_patterns(['LICENSE.txt']))
+        ['LICENSE.txt']
         >>> list(Distribution._expand_patterns(['pyproject.toml', 'LIC*']))
-        ['pyproject.toml', 'LICENSE']
-        >>> list(Distribution._expand_patterns(['setuptools/**/pyprojecttoml.py']))
-        ['setuptools/config/pyprojecttoml.py']
+        ['pyproject.toml', 'LICENSE.txt']
+        >>> list(Distribution._expand_patterns(['src/**/*.dat']))
+        ['src/sample/package_data.dat']
         """
         return (
             path.replace(os.sep, "/")
@@ -488,8 +487,9 @@ class Distribution(_Distribution):
     @staticmethod
     def _find_pattern(pattern: str, enforce_match: bool = True) -> list[str]:
         r"""
-        >>> Distribution._find_pattern("LICENSE")
-        ['LICENSE']
+        >>> getfixture('sample_project_cwd')
+        >>> Distribution._find_pattern("LICENSE.txt")
+        ['LICENSE.txt']
         >>> Distribution._find_pattern("/LICENSE.MIT")
         Traceback (most recent call last):
         ...
@@ -759,9 +759,7 @@ class Distribution(_Distribution):
         self._finalize_license_expression()
         self._finalize_license_files()
 
-    def fetch_build_eggs(
-        self, requires: _StrOrIter
-    ) -> list[_pkg_resources_Distribution]:
+    def fetch_build_eggs(self, requires: _StrOrIter) -> list[metadata.Distribution]:
         """Resolve pre-setup requirements"""
         from .installer import _fetch_build_eggs
 

py2docfx/venv/basevenv/Lib/site-packages/setuptools/installer.py

@@ -1,16 +1,17 @@
 from __future__ import annotations
 
 import glob
+import itertools
 import os
 import subprocess
 import sys
 import tempfile
-from functools import partial
 
-from pkg_resources import Distribution
+import packaging.requirements
+import packaging.utils
 
 from . import _reqs
-from ._reqs import _StrOrIter
+from ._importlib import metadata
 from .warnings import SetuptoolsDeprecationWarning
 from .wheel import Wheel
 
@@ -35,25 +36,38 @@ def fetch_build_egg(dist, req):
     return _fetch_build_egg_no_warn(dist, req)
 
 
-def _fetch_build_eggs(dist, requires: _StrOrIter) -> list[Distribution]:
-    import pkg_resources  # Delay import to avoid unnecessary side-effects
+def _present(req):
+    return any(_dist_matches_req(dist, req) for dist in metadata.distributions())
 
+
+def _fetch_build_eggs(dist, requires: _reqs._StrOrIter) -> list[metadata.Distribution]:
     _DeprecatedInstaller.emit(stacklevel=3)
     _warn_wheel_not_available(dist)
 
-    resolved_dists = pkg_resources.working_set.resolve(
-        _reqs.parse(requires, pkg_resources.Requirement),  # required for compatibility
-        installer=partial(_fetch_build_egg_no_warn, dist),  # avoid warning twice
-        replace_conflicting=True,
+    parsed_reqs = _reqs.parse(requires)
+
+    missing_reqs = itertools.filterfalse(_present, parsed_reqs)
+
+    needed_reqs = (
+        req for req in missing_reqs if not req.marker or req.marker.evaluate()
     )
+    resolved_dists = [_fetch_build_egg_no_warn(dist, req) for req in needed_reqs]
     for dist in resolved_dists:
-        pkg_resources.working_set.add(dist, replace=True)
+        # dist.locate_file('') is the directory containing EGG-INFO, where the importabl
+        # contents can be found.
+        sys.path.insert(0, str(dist.locate_file('')))
     return resolved_dists
 
 
-def _fetch_build_egg_no_warn(dist, req):  # noqa: C901  # is too complex (16)  # FIXME
-    import pkg_resources  # Delay import to avoid unnecessary side-effects
+def _dist_matches_req(egg_dist, req):
+    return (
+        packaging.utils.canonicalize_name(egg_dist.name)
+        == packaging.utils.canonicalize_name(req.name)
+        and egg_dist.version in req.specifier
+    )
+
 
+def _fetch_build_egg_no_warn(dist, req):  # noqa: C901  # is too complex (16)  # FIXME
     # Ignore environment markers; if supplied, it is required.
     req = strip_marker(req)
     # Take easy_install options into account, but do not override relevant
@@ -78,9 +92,9 @@ def _fetch_build_egg_no_warn(dist, req):  # noqa: C901  # is too complex (16)  #
     if dist.dependency_links:
         find_links.extend(dist.dependency_links)
     eggs_dir = os.path.realpath(dist.get_egg_cache_dir())
-    environment = pkg_resources.Environment()
-    for egg_dist in pkg_resources.find_distributions(eggs_dir):
-        if egg_dist in req and environment.can_add(egg_dist):
+    cached_dists = metadata.Distribution.discover(path=glob.glob(f'{eggs_dir}/*.egg'))
+    for egg_dist in cached_dists:
+        if _dist_matches_req(egg_dist, req):
             return egg_dist
     with tempfile.TemporaryDirectory() as tmpdir:
         cmd = [
@@ -110,12 +124,7 @@ def _fetch_build_egg_no_warn(dist, req):  # noqa: C901  # is too complex (16)  #
         wheel = Wheel(glob.glob(os.path.join(tmpdir, '*.whl'))[0])
         dist_location = os.path.join(eggs_dir, wheel.egg_name())
         wheel.install_as_egg(dist_location)
-        dist_metadata = pkg_resources.PathMetadata(
-            dist_location, os.path.join(dist_location, 'EGG-INFO')
-        )
-        return pkg_resources.Distribution.from_filename(
-            dist_location, metadata=dist_metadata
-        )
+        return metadata.Distribution.at(dist_location + '/EGG-INFO')
 
 
 def strip_marker(req):
@@ -124,20 +133,16 @@ def strip_marker(req):
     calling pip with something like `babel; extra == "i18n"`, which
     would always be ignored.
     """
-    import pkg_resources  # Delay import to avoid unnecessary side-effects
-
     # create a copy to avoid mutating the input
-    req = pkg_resources.Requirement.parse(str(req))
+    req = packaging.requirements.Requirement(str(req))
     req.marker = None
     return req
 
 
 def _warn_wheel_not_available(dist):
-    import pkg_resources  # Delay import to avoid unnecessary side-effects
-
     try:
-        pkg_resources.get_distribution('wheel')
-    except pkg_resources.DistributionNotFound:
+        metadata.distribution('wheel')
+    except metadata.PackageNotFoundError:
         dist.announce('WARNING: The wheel package is not available.', log.WARN)
 
 
@@ -147,4 +152,4 @@ class _DeprecatedInstaller(SetuptoolsDeprecationWarning):
     Requirements should be satisfied by a PEP 517 installer.
     If you are using pip, you can try `pip install --use-pep517`.
     """
-    # _DUE_DATE not decided yet
+    _DUE_DATE = 2025, 10, 31

py2docfx/venv/basevenv/Lib/site-packages/setuptools/tests/contexts.py

@@ -74,20 +74,6 @@ def save_user_site_setting():
         site.ENABLE_USER_SITE = saved
 
 
-@contextlib.contextmanager
-def save_pkg_resources_state():
-    import pkg_resources
-
-    pr_state = pkg_resources.__getstate__()
-    # also save sys.path
-    sys_path = sys.path[:]
-    try:
-        yield pr_state, sys_path
-    finally:
-        sys.path[:] = sys_path
-        pkg_resources.__setstate__(pr_state)
-
-
 @contextlib.contextmanager
 def suppress_exceptions(*excs):
     try: