Merge branch 'main' into add-mingw-support

Author: jaraco

.coveragerc

@@ -2,8 +2,16 @@
 omit =
 	# leading `*/` for pytest-dev/pytest-cov#456
 	*/.tox/*
+
+	# local
+	*/compat/*
+	*/distutils/_vendor/*
 disable_warnings =
 	couldnt-parse
 
 [report]
 show_missing = True
+exclude_also =
+	# jaraco/skeleton#97
+	@overload
+	if TYPE_CHECKING:

.github/workflows/main.yml

@@ -4,8 +4,11 @@ on:
   merge_group:
   push:
     branches-ignore:
-    # disabled for jaraco/skeleton#103
-    # - gh-readonly-queue/**  # Temporary merge queue-related GH-made branches
+    # temporary GH branches relating to merge queues (jaraco/skeleton#93)
+    - gh-readonly-queue/**
+    tags:
+    # required if branches-ignore is supplied (jaraco/skeleton#103)
+    - '**'
   pull_request:
 
 concurrency:
@@ -34,10 +37,10 @@ env:
 jobs:
   test:
     strategy:
+      # https://blog.jaraco.com/efficient-use-of-ci-resources/
       matrix:
         python:
         - "3.8"
-        - "3.11"
         - "3.12"
         platform:
         - ubuntu-latest
@@ -48,6 +51,8 @@ jobs:
           platform: ubuntu-latest
         - python: "3.10"
           platform: ubuntu-latest
+        - python: "3.11"
+          platform: ubuntu-latest
         - python: pypy3.10
           platform: ubuntu-latest
     runs-on: ${{ matrix.platform }}
@@ -145,9 +150,9 @@ jobs:
           source venv/bin/activate
 
           # python-ruff doesn't work without rust
-          sed -i '/pytest-ruff/d' setup.cfg
+          sed -i '/pytest-ruff/d' pyproject.toml
 
-          pip install -e .[testing]
+          pip install -e .[test]
       - name: Run tests
         shell: msys2 {0}
         run: |
@@ -156,7 +161,6 @@ jobs:
 
   ci_setuptools:
     # Integration testing with setuptools
-    if: ${{ false }}  # disabled for deprecation warnings
     strategy:
       matrix:
         python:

.readthedocs.yaml

@@ -3,10 +3,14 @@ python:
   install:
   - path: .
     extra_requirements:
-      - docs
+      - doc
 
 # required boilerplate readthedocs/readthedocs.org#10401
 build:
-  os: ubuntu-22.04
+  os: ubuntu-lts-latest
   tools:
-    python: "3"
+    python: latest
+  # post-checkout job to ensure the clone isn't shallow jaraco/skeleton#114
+  jobs:
+    post_checkout:
+    - git fetch --unshallow || true

README.rst

@@ -19,12 +19,9 @@
 
 Python Module Distribution Utilities extracted from the Python Standard Library
 
-Synchronizing
-=============
+This package is unsupported except as integrated into and exposed by Setuptools.
 
-This project is no longer kept in sync with the code still in stdlib, which is deprecated and scheduled for removal.
-
-To Setuptools
--------------
+Integration
+-----------
 
 Simply merge the changes directly into setuptools' repo.

conftest.py

@@ -1,22 +1,24 @@
+import logging
 import os
-import sys
-import platform
 import pathlib
-import logging
+import platform
+import sys
 
-import pytest
 import path
-
+import pytest
 
 collect_ignore = []
 
 
 if platform.system() != 'Windows':
-    collect_ignore.extend(
-        [
-            'distutils/msvc9compiler.py',
-        ]
-    )
+    collect_ignore.extend([
+        'distutils/msvc9compiler.py',
+    ])
+
+
+collect_ignore_glob = [
+    'distutils/_vendor/**/*',
+]
 
 
 @pytest.fixture
@@ -59,7 +61,7 @@ def _save_cwd():
 
 @pytest.fixture
 def distutils_managed_tempdir(request):
-    from distutils.tests import py38compat as os_helper
+    from distutils.tests.compat import py38 as os_helper
 
     self = request.instance
     self.tempdirs = []
@@ -95,8 +97,7 @@ def temp_cwd(tmp_path):
 
 @pytest.fixture
 def pypirc(request, save_env, distutils_managed_tempdir):
-    from distutils.core import PyPIRCCommand
-    from distutils.core import Distribution
+    from distutils.core import Distribution, PyPIRCCommand
 
     self = request.instance
     self.tmp_dir = self.mkdtemp()
@@ -154,3 +155,10 @@ def temp_home(tmp_path, monkeypatch):
 def fake_home(fs, monkeypatch):
     home = fs.create_dir('/fakehome')
     return _set_home(monkeypatch, pathlib.Path(home.path))
+
+
+@pytest.fixture
+def disable_macos_customization(monkeypatch):
+    from distutils import sysconfig
+
+    monkeypatch.setattr(sysconfig, '_customize_macos', lambda: None)

distutils/__init__.py

@@ -1,5 +1,5 @@
-import sys
 import importlib
+import sys
 
 __version__, _, _ = sys.version.partition(' ')
 

distutils/_collections.py

@@ -1,7 +1,11 @@
+from __future__ import annotations
+
 import collections
 import functools
 import itertools
 import operator
+from collections.abc import Mapping
+from typing import Any
 
 
 # from jaraco.collections 3.5.1
@@ -58,7 +62,7 @@ def __len__(self):
         return len(list(iter(self)))
 
 
-# from jaraco.collections 3.7
+# from jaraco.collections 5.0.1
 class RangeMap(dict):
     """
     A dictionary-like object that uses the keys as bounds for a range.
@@ -70,7 +74,7 @@ class RangeMap(dict):
     One may supply keyword parameters to be passed to the sort function used
     to sort keys (i.e. key, reverse) as sort_params.
 
-    Let's create a map that maps 1-3 -> 'a', 4-6 -> 'b'
+    Create a map that maps 1-3 -> 'a', 4-6 -> 'b'
 
     >>> r = RangeMap({3: 'a', 6: 'b'})  # boy, that was easy
     >>> r[1], r[2], r[3], r[4], r[5], r[6]
@@ -82,7 +86,7 @@ class RangeMap(dict):
     >>> r[4.5]
     'b'
 
-    But you'll notice that the way rangemap is defined, it must be open-ended
+    Notice that the way rangemap is defined, it must be open-ended
     on one side.
 
     >>> r[0]
@@ -140,7 +144,12 @@ class RangeMap(dict):
 
     """
 
-    def __init__(self, source, sort_params={}, key_match_comparator=operator.le):
+    def __init__(
+        self,
+        source,
+        sort_params: Mapping[str, Any] = {},
+        key_match_comparator=operator.le,
+    ):
         dict.__init__(self, source)
         self.sort_params = sort_params
         self.match = key_match_comparator

distutils/_itertools.py

@@ -0,0 +1,52 @@
+# from more_itertools 10.2
+def always_iterable(obj, base_type=(str, bytes)):
+    """If *obj* is iterable, return an iterator over its items::
+
+        >>> obj = (1, 2, 3)
+        >>> list(always_iterable(obj))
+        [1, 2, 3]
+
+    If *obj* is not iterable, return a one-item iterable containing *obj*::
+
+        >>> obj = 1
+        >>> list(always_iterable(obj))
+        [1]
+
+    If *obj* is ``None``, return an empty iterable:
+
+        >>> obj = None
+        >>> list(always_iterable(None))
+        []
+
+    By default, binary and text strings are not considered iterable::
+
+        >>> obj = 'foo'
+        >>> list(always_iterable(obj))
+        ['foo']
+
+    If *base_type* is set, objects for which ``isinstance(obj, base_type)``
+    returns ``True`` won't be considered iterable.
+
+        >>> obj = {'a': 1}
+        >>> list(always_iterable(obj))  # Iterate over the dict's keys
+        ['a']
+        >>> list(always_iterable(obj, base_type=dict))  # Treat dicts as a unit
+        [{'a': 1}]
+
+    Set *base_type* to ``None`` to avoid any special handling and treat objects
+    Python considers iterable as iterable:
+
+        >>> obj = 'foo'
+        >>> list(always_iterable(obj, base_type=None))
+        ['f', 'o', 'o']
+    """
+    if obj is None:
+        return iter(())
+
+    if (base_type is not None) and isinstance(obj, base_type):
+        return iter((obj,))
+
+    try:
+        return iter(obj)
+    except TypeError:
+        return iter((obj,))

distutils/_log.py

@@ -1,4 +1,3 @@
 import logging
 
-
 log = logging.getLogger()

distutils/_macos_compat.py

@@ -1,5 +1,5 @@
-import sys
 import importlib
+import sys
 
 
 def bypass_compiler_fixup(cmd, args):

distutils/_modified.py

@@ -3,9 +3,9 @@
 import functools
 import os.path
 
-from .errors import DistutilsFileError
-from .py39compat import zip_strict
 from ._functools import splat
+from .compat.py39 import zip_strict
+from .errors import DistutilsFileError
 
 
 def _newer(source, target):
@@ -24,7 +24,7 @@ def newer(source, target):
     Raises DistutilsFileError if 'source' does not exist.
     """
     if not os.path.exists(source):
-        raise DistutilsFileError("file '%s' does not exist" % os.path.abspath(source))
+        raise DistutilsFileError(f"file '{os.path.abspath(source)}' does not exist")
 
     return _newer(source, target)