Merge branch 'main' into FURB

Author: jaraco

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 80.8.0
+current_version = 80.9.0
 commit = True
 tag = True
 

.github/workflows/main.yml

@@ -157,6 +157,7 @@ jobs:
     if: always()
 
     needs:
+    - check-changed-folders
     - integration-test
     - test
     - collateral
@@ -228,6 +229,38 @@ jobs:
             VM-${{ matrix.platform }},
             Py-${{ steps.python-install.outputs.python-version }}
           token: ${{ secrets.CODECOV_TOKEN }}
+            
+  check-changed-folders:
+    name: Fail the job if files changed under _disutils/_vendor folders
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Check if files changed in the _distutils folder
+        id: changed-files-specific-distutils
+        uses: tj-actions/changed-files@v34
+        with:
+          files: |
+            setuptools/_distutils/**
+      - name: Check if files changed in the _vendor folder
+        id: changed-files-specific-vendor
+        uses: tj-actions/changed-files@v34
+        with:
+          files: |
+            setuptools/_vendor/**
+      - name: Fail the job if any file(s) in the _distutils folder change
+        if: steps.changed-files-specific-distutils.outputs.any_changed == 'true'
+        run: |
+          echo "One or more files in the setuptools/_distutils folder has changed." | tee "${GITHUB_STEP_SUMMARY}"
+          exit 1      
+      - name: Fail the job if any file(s) in the _vendor folder change
+        if: steps.changed-files-specific-vendor.outputs.any_changed == 'true'
+        run: |
+          echo "One or more files in the setuptools/_vendor folder has changed." | tee "${GITHUB_STEP_SUMMARY}"
+          exit 1 
 
   integration-test:
     needs: test

NEWS.rst

@@ -1,3 +1,13 @@
+v80.9.0
+=======
+
+Features
+--------
+
+- Set a deadline for the removal of pkg_resources later this year (December). (#3085)
+- Removed reliance on pkg_resources in test_wheel. (#3085)
+
+
 v80.8.0
 =======
 

newsfragments/3085.feature.rst

@@ -97,8 +97,11 @@
 
 warnings.warn(
     "pkg_resources is deprecated as an API. "
-    "See https://setuptools.pypa.io/en/latest/pkg_resources.html",
-    DeprecationWarning,
+    "See https://setuptools.pypa.io/en/latest/pkg_resources.html. "
+    "The pkg_resources package is slated for removal as early as "
+    "2025-11-30. Refrain from using this package or pin to "
+    "Setuptools<81.",
+    UserWarning,
     stacklevel=2,
 )
 

pkg_resources/__init__.py

@@ -10,7 +10,7 @@ backend-path = ["."]
 
 [project]
 name = "setuptools"
-version = "80.8.0"
+version = "80.9.0"
 authors = [
 	{ name = "Python Packaging Authority", email = "[email protected]" },
 ]

pyproject.toml

@@ -84,8 +84,8 @@ filterwarnings=
 	# Avoid errors when testing pkg_resources.declare_namespace
 	ignore:.*pkg_resources\.declare_namespace.*:DeprecationWarning
 
-	# suppress known deprecation
-	ignore:pkg_resources is deprecated:DeprecationWarning
+	# suppress known deprecation pypa/setuptools#3085
+	ignore:pkg_resources is deprecated:UserWarning
 
 	# Dependencies might not have been updated yet
 	default:onerror argument is deprecated, use onexc instead

pytest.ini

@@ -26,6 +26,7 @@ extend-select = [
 
 	# local
 	"ANN2", # missing-return-type-*
+	"ISC", # flake8-implicit-str-concat
 	"FURB", # refurb
 	"PERF", # Perflint
 	"PGH", # pygrep-hooks (blanket-* rules)
@@ -66,13 +67,12 @@ ignore = [
 	"UP038", # Using `X | Y` in `isinstance` call is slower and more verbose https://github.com/astral-sh/ruff/issues/7871
 	# Only enforcing return type annotations for public functions
 	"ANN202", # missing-return-type-private-function
-	"ANN204", # missing-return-type-special-method
 ]
 
 [lint.per-file-ignores]
 # Suppress nuisance warnings about module-import-not-at-top-of-file (E402) due to workaround for #4476
 "setuptools/__init__.py" = ["E402"]
-"pkg_resources/__init__.py" = ["E402"]
+"pkg_resources/__init__.py" = ["E402", "ANN204"]
 
 [lint.isort]
 combine-as-imports = true

ruff.toml

@@ -108,11 +108,13 @@ def _fetch_build_eggs(dist: Distribution):
         raise
 
 
-def setup(**attrs):
+def setup(**attrs) -> Distribution:
     logging.configure()
     # Make sure we have any requirements needed to interpret 'attrs'.
     _install_setup_requires(attrs)
-    return distutils.core.setup(**attrs)
+    # Override return type of distutils.core.Distribution with setuptools.dist.Distribution
+    # (implicitly implemented via `setuptools.monkey.patch_all`).
+    return distutils.core.setup(**attrs)  # type: ignore[return-value]
 
 
 setup.__doc__ = distutils.core.setup.__doc__
@@ -176,14 +178,14 @@ def __init__(self, dist: Distribution, **kw) -> None:
     @overload
     def reinitialize_command(
         self, command: str, reinit_subcommands: bool = False, **kw
-    ) -> _Command: ...
+    ) -> Command: ...  # override distutils.cmd.Command with setuptools.Command
     @overload
     def reinitialize_command(
         self, command: _CommandT, reinit_subcommands: bool = False, **kw
     ) -> _CommandT: ...
     def reinitialize_command(
         self, command: str | _Command, reinit_subcommands: bool = False, **kw
-    ) -> _Command:
+    ) -> Command | _Command:
         cmd = _Command.reinitialize_command(self, command, reinit_subcommands)
         vars(cmd).update(kw)
         return cmd  # pyright: ignore[reportReturnType] # pypa/distutils#307

setuptools/__init__.py

@@ -39,7 +39,7 @@
 import warnings
 from collections.abc import Iterable, Iterator, Mapping
 from pathlib import Path
-from typing import TYPE_CHECKING, Union
+from typing import TYPE_CHECKING, NoReturn, Union
 
 import setuptools
 
@@ -74,14 +74,14 @@ def __init__(self, specifiers) -> None:
 
 
 class Distribution(setuptools.dist.Distribution):
-    def fetch_build_eggs(self, specifiers):
+    def fetch_build_eggs(self, specifiers) -> NoReturn:
         specifier_list = list(parse_strings(specifiers))
 
         raise SetupRequirementsError(specifier_list)
 
     @classmethod
     @contextlib.contextmanager
-    def patch(cls):
+    def patch(cls) -> Iterator[None]:
         """
         Replace
         distutils.dist.Distribution with this class
@@ -304,7 +304,7 @@ def _get_build_requires(
 
         return requirements
 
-    def run_setup(self, setup_script: str = 'setup.py'):
+    def run_setup(self, setup_script: str = 'setup.py') -> None:
         # Note that we can reuse our build directory between calls
         # Correctness comes first, then optimization later
         __file__ = os.path.abspath(setup_script)
@@ -327,10 +327,14 @@ def run_setup(self, setup_script: str = 'setup.py'):
                 "setup-py-deprecated.html",
             )
 
-    def get_requires_for_build_wheel(self, config_settings: _ConfigSettings = None):
+    def get_requires_for_build_wheel(
+        self, config_settings: _ConfigSettings = None
+    ) -> list[str]:
         return self._get_build_requires(config_settings, requirements=[])
 
-    def get_requires_for_build_sdist(self, config_settings: _ConfigSettings = None):
+    def get_requires_for_build_sdist(
+        self, config_settings: _ConfigSettings = None
+    ) -> list[str]:
         return self._get_build_requires(config_settings, requirements=[])
 
     def _bubble_up_info_directory(
@@ -361,7 +365,7 @@ def _find_info_directory(self, metadata_directory: StrPath, suffix: str) -> Path
 
     def prepare_metadata_for_build_wheel(
         self, metadata_directory: StrPath, config_settings: _ConfigSettings = None
-    ):
+    ) -> str:
         sys.argv = [
             *sys.argv[:1],
             *self._global_args(config_settings),
@@ -417,7 +421,7 @@ def build_wheel(
         wheel_directory: StrPath,
         config_settings: _ConfigSettings = None,
         metadata_directory: StrPath | None = None,
-    ):
+    ) -> str:
         def _build(cmd: list[str]):
             with suppress_known_deprecation():
                 return self._build_with_temp_dir(
@@ -442,7 +446,7 @@ def _build(cmd: list[str]):
 
     def build_sdist(
         self, sdist_directory: StrPath, config_settings: _ConfigSettings = None
-    ):
+    ) -> str:
         return self._build_with_temp_dir(
             ['sdist', '--formats', 'gztar'], '.tar.gz', sdist_directory, config_settings
         )
@@ -459,7 +463,7 @@ def build_editable(
         wheel_directory: StrPath,
         config_settings: _ConfigSettings = None,
         metadata_directory: StrPath | None = None,
-    ):
+    ) -> str:
         # XXX can or should we hide our editable_wheel command normally?
         info_dir = self._get_dist_info_dir(metadata_directory)
         opts = ["--dist-info-dir", info_dir] if info_dir else []
@@ -469,12 +473,14 @@ def build_editable(
                 cmd, ".whl", wheel_directory, config_settings
             )
 
-    def get_requires_for_build_editable(self, config_settings: _ConfigSettings = None):
+    def get_requires_for_build_editable(
+        self, config_settings: _ConfigSettings = None
+    ) -> list[str]:
         return self.get_requires_for_build_wheel(config_settings)
 
     def prepare_metadata_for_build_editable(
         self, metadata_directory: StrPath, config_settings: _ConfigSettings = None
-    ):
+    ) -> str:
         return self.prepare_metadata_for_build_wheel(
             metadata_directory, config_settings
         )
@@ -492,7 +498,7 @@ class _BuildMetaLegacyBackend(_BuildMetaBackend):
     and will eventually be removed.
     """
 
-    def run_setup(self, setup_script: str = 'setup.py'):
+    def run_setup(self, setup_script: str = 'setup.py') -> None:
         # In order to maintain compatibility with scripts assuming that
         # the setup.py script is in a directory on the PYTHONPATH, inject
         # '' into sys.path. (pypa/setuptools#1642)