Replaced all uses of distutils with setuptools (#428)

Distutils has been deprecated and will be removed in Python 3.12.

This changeset replaces distutils logging with similar logging functionality from setuptools (when ready), and if not available, provides a replacement of its own.

Co-authored-by: Jason R. Coombs <[email protected]>

Author: agronholm

docs/news.rst

@@ -5,6 +5,7 @@ Release Notes
 
 - Dropped support for Python < 3.7
 - Updated vendored ``packaging`` to 21.3
+- Replaced all uses of ``distutils`` with ``setuptools``
 
 **0.37.1 (2021-12-22)**
 

setup.cfg

@@ -31,7 +31,7 @@ package_dir=
     = src
 packages = find:
 python_requires = >=3.7
-setup_requires = setuptools >= 45.2.0
+install_requires = setuptools >= 45.2.0
 zip_safe = False
 
 [options.packages.find]

src/wheel/_setuptools_logging.py

@@ -0,0 +1,26 @@
+# copied from setuptools.logging, omitting monkeypatching
+from __future__ import annotations
+
+import logging
+import sys
+
+
+def _not_warning(record):
+    return record.levelno < logging.WARNING
+
+
+def configure():
+    """
+    Configure logging to emit warning and above to stderr
+    and everything else to stdout. This behavior is provided
+    for compatibility with distutils.log but may change in
+    the future.
+    """
+    err_handler = logging.StreamHandler()
+    err_handler.setLevel(logging.WARNING)
+    out_handler = logging.StreamHandler(sys.stdout)
+    out_handler.addFilter(_not_warning)
+    handlers = err_handler, out_handler
+    logging.basicConfig(
+        format="{message}", style="{", handlers=handlers, level=logging.DEBUG
+    )

src/wheel/bdist_wheel.py

@@ -6,16 +6,14 @@
 
 from __future__ import annotations
 
-import distutils
 import os
 import re
 import shutil
 import stat
 import sys
+import sysconfig
 import warnings
 from collections import OrderedDict
-from distutils import log as logger
-from distutils.core import Command
 from email.generator import BytesGenerator, Generator
 from glob import iglob
 from io import BytesIO
@@ -24,10 +22,12 @@
 from zipfile import ZIP_DEFLATED, ZIP_STORED
 
 import pkg_resources
+from setuptools import Command
 
 from . import __version__ as wheel_version
 from .macosx_libfile import calculate_macosx_platform_tag
 from .metadata import pkginfo_to_metadata
+from .util import log
 from .vendored.packaging import tags
 from .wheelfile import WheelFile
 
@@ -43,14 +43,14 @@ def python_tag():
 
 def get_platform(archive_root):
     """Return our platform name 'win32', 'linux_x86_64'"""
-    # XXX remove distutils dependency
-    result = distutils.util.get_platform()
+    result = sysconfig.get_platform()
     if result.startswith("macosx") and archive_root is not None:
         result = calculate_macosx_platform_tag(archive_root, result)
-    if result == "linux_x86_64" and sys.maxsize == 2147483647:
+    elif result == "linux-x86_64" and sys.maxsize == 2147483647:
         # pip pull request #3497
-        result = "linux_i686"
-    return result
+        result = "linux-i686"
+
+    return result.replace("-", "_")
 
 
 def get_flag(var, fallback, expected=True, warn=True):
@@ -238,7 +238,9 @@ def finalize_options(self):
         wheel = self.distribution.get_option_dict("wheel")
         if "universal" in wheel:
             # please don't define this in your global configs
-            logger.warn("The [wheel] section is deprecated. Use [bdist_wheel] instead.")
+            log.warning(
+                "The [wheel] section is deprecated. Use [bdist_wheel] instead.",
+            )
             val = wheel["universal"][1].strip()
             if val.lower() in ("1", "true", "yes"):
                 self.universal = True
@@ -353,7 +355,7 @@ def run(self):
             basedir_observed,
         )
 
-        logger.info("installing to %s", self.bdist_dir)
+        log.info(f"installing to {self.bdist_dir}")
 
         self.run_command("install")
 
@@ -394,7 +396,7 @@ def run(self):
         )
 
         if not self.keep_temp:
-            logger.info("removing %s", self.bdist_dir)
+            log.info(f"removing {self.bdist_dir}")
             if not self.dry_run:
                 rmtree(self.bdist_dir, onerror=remove_readonly)
 
@@ -418,7 +420,7 @@ def write_wheelfile(
                     msg["Tag"] = "-".join((impl, abi, plat))
 
         wheelfile_path = os.path.join(wheelfile_base, "WHEEL")
-        logger.info("creating %s", wheelfile_path)
+        log.info(f"creating {wheelfile_path}")
         buffer = BytesIO()
         BytesGenerator(buffer, maxheaderlen=0).flatten(msg)
         with open(wheelfile_path, "wb") as f:
@@ -453,14 +455,14 @@ def license_paths(self):
         for pattern in patterns:
             for path in iglob(pattern):
                 if path.endswith("~"):
-                    logger.debug(
-                        'ignoring license file "%s" as it looks like a backup', path
+                    log.debug(
+                        f'ignoring license file "{path}" as it looks like a ' f"backup"
                     )
                     continue
 
                 if path not in files and os.path.isfile(path):
-                    logger.info(
-                        'adding license file "%s" (matched pattern "%s")', path, pattern
+                    log.info(
+                        f'adding license file "{path}" (matched pattern "{pattern}")'
                     )
                     files.add(path)
 

src/wheel/cli/__init__.py

@@ -9,13 +9,6 @@
 import sys
 
 
-def require_pkgresources(name):
-    try:
-        import pkg_resources  # noqa: F401
-    except ImportError:
-        raise RuntimeError(f"'{name}' needs pkg_resources (part of setuptools).")
-
-
 class WheelError(Exception):
     pass
 

src/wheel/cli/convert.py

@@ -5,12 +5,13 @@
 import shutil
 import tempfile
 import zipfile
-from distutils import dist
 from glob import iglob
 
+from setuptools.dist import Distribution
+
 from ..bdist_wheel import bdist_wheel
 from ..wheelfile import WheelFile
-from . import WheelError, require_pkgresources
+from . import WheelError
 
 egg_info_re = re.compile(
     r"""
@@ -70,9 +71,9 @@ def egg2wheel(egg_path: str, dest_dir: str):
 
     root_is_purelib = egg_info["arch"] is None
     if root_is_purelib:
-        bw = bdist_wheel(dist.Distribution())
+        bw = bdist_wheel(Distribution())
     else:
-        bw = _bdist_wheel_tag(dist.Distribution())
+        bw = _bdist_wheel_tag(Distribution())
 
     bw.root_is_pure = root_is_purelib
     bw.python_tag = pyver
@@ -229,9 +230,9 @@ def wininst2wheel(path, dest_dir):
         pyver = pyver.replace("py", "cp")
     wheel_name = "-".join((dist_info, pyver, abi, arch))
     if root_is_purelib:
-        bw = bdist_wheel(dist.Distribution())
+        bw = bdist_wheel(Distribution())
     else:
-        bw = _bdist_wheel_tag(dist.Distribution())
+        bw = _bdist_wheel_tag(Distribution())
 
     bw.root_is_pure = root_is_purelib
     bw.python_tag = pyver
@@ -254,9 +255,6 @@ def wininst2wheel(path, dest_dir):
 
 
 def convert(files, dest_dir, verbose):
-    # Only support wheel convert if pkg_resources is present
-    require_pkgresources("wheel convert")
-
     for pat in files:
         for installer in iglob(pat):
             if os.path.splitext(installer)[1] == ".egg":

src/wheel/util.py

@@ -1,6 +1,18 @@
 from __future__ import annotations
 
 import base64
+import logging
+
+log = logging.getLogger("wheel")
+
+# ensure Python logging is configured
+try:
+    __import__("setuptools.logging")
+except ImportError:
+    # setuptools < ??
+    from . import _setuptools_logging
+
+    _setuptools_logging.configure()
 
 
 def urlsafe_b64encode(data: bytes) -> bytes:

src/wheel/wheelfile.py

@@ -7,12 +7,11 @@
 import stat
 import time
 from collections import OrderedDict
-from distutils import log as logger
 from io import StringIO, TextIOWrapper
 from zipfile import ZIP_DEFLATED, ZipFile, ZipInfo
 
 from wheel.cli import WheelError
-from wheel.util import urlsafe_b64decode, urlsafe_b64encode
+from wheel.util import log, urlsafe_b64decode, urlsafe_b64encode
 
 # Non-greedy matching of an optional build number may be too clever (more
 # invalid wheel filenames will match). Separate regex for .dist-info?
@@ -118,7 +117,7 @@ def _update_crc(newdata):
         return ef
 
     def write_files(self, base_dir):
-        logger.info("creating '%s' and adding '%s' to it", self.filename, base_dir)
+        log.info(f"creating '{self.filename}' and adding '{base_dir}' to it")
         deferred = []
         for root, dirnames, filenames in os.walk(base_dir):
             # Sort the directory names so that `os.walk` will walk them in a
@@ -161,7 +160,7 @@ def writestr(self, zinfo_or_arcname, data, compress_type=None):
             if isinstance(zinfo_or_arcname, ZipInfo)
             else zinfo_or_arcname
         )
-        logger.info("adding '%s'", fname)
+        log.info(f"adding '{fname}'")
         if fname != self.record_path:
             hash_ = self._default_algorithm(data)
             self._file_hashes[fname] = (

tests/test_macosx_libfile.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-import distutils.util
 import os
 import sys
+import sysconfig
 
 from wheel.bdist_wheel import get_platform
 from wheel.macosx_libfile import extract_macosx_min_system_version
@@ -52,15 +52,15 @@ def test_simple(self, monkeypatch):
         dirname = os.path.dirname(__file__)
         dylib_dir = os.path.join(dirname, "testdata", "macosx_minimal_system_version")
         monkeypatch.setattr(
-            distutils.util, "get_platform", return_factory("macosx-11.0-x86_64")
+            sysconfig, "get_platform", return_factory("macosx-11.0-x86_64")
         )
         assert get_platform(dylib_dir) == "macosx_11_0_x86_64"
 
     def test_version_bump(self, monkeypatch, capsys):
         dirname = os.path.dirname(__file__)
         dylib_dir = os.path.join(dirname, "testdata", "macosx_minimal_system_version")
         monkeypatch.setattr(
-            distutils.util, "get_platform", return_factory("macosx-10.9-x86_64")
+            sysconfig, "get_platform", return_factory("macosx-10.9-x86_64")
         )
         assert get_platform(dylib_dir) == "macosx_11_0_x86_64"
         captured = capsys.readouterr()
@@ -72,7 +72,7 @@ def test_information_about_problematic_files_python_version(
         dirname = os.path.dirname(__file__)
         dylib_dir = os.path.join(dirname, "testdata", "macosx_minimal_system_version")
         monkeypatch.setattr(
-            distutils.util, "get_platform", return_factory("macosx-10.9-x86_64")
+            sysconfig, "get_platform", return_factory("macosx-10.9-x86_64")
         )
         monkeypatch.setattr(
             os,
@@ -95,7 +95,7 @@ def test_information_about_problematic_files_env_variable(
         dirname = os.path.dirname(__file__)
         dylib_dir = os.path.join(dirname, "testdata", "macosx_minimal_system_version")
         monkeypatch.setattr(
-            distutils.util, "get_platform", return_factory("macosx-10.9-x86_64")
+            sysconfig, "get_platform", return_factory("macosx-10.9-x86_64")
         )
         monkeypatch.setenv("MACOSX_DEPLOYMENT_TARGET", "10.8")
         monkeypatch.setattr(
@@ -115,7 +115,7 @@ def test_bump_platform_tag_by_env_variable(self, monkeypatch, capsys):
         dirname = os.path.dirname(__file__)
         dylib_dir = os.path.join(dirname, "testdata", "macosx_minimal_system_version")
         monkeypatch.setattr(
-            distutils.util, "get_platform", return_factory("macosx-10.9-x86_64")
+            sysconfig, "get_platform", return_factory("macosx-10.9-x86_64")
         )
         monkeypatch.setattr(
             os,
@@ -134,7 +134,7 @@ def test_bugfix_release_platform_tag(self, monkeypatch, capsys):
         dirname = os.path.dirname(__file__)
         dylib_dir = os.path.join(dirname, "testdata", "macosx_minimal_system_version")
         monkeypatch.setattr(
-            distutils.util, "get_platform", return_factory("macosx-10.9-x86_64")
+            sysconfig, "get_platform", return_factory("macosx-10.9-x86_64")
         )
         monkeypatch.setattr(
             os,
@@ -165,7 +165,7 @@ def test_warning_on_to_low_env_variable(self, monkeypatch, capsys):
         dirname = os.path.dirname(__file__)
         dylib_dir = os.path.join(dirname, "testdata", "macosx_minimal_system_version")
         monkeypatch.setattr(
-            distutils.util, "get_platform", return_factory("macosx-10.9-x86_64")
+            sysconfig, "get_platform", return_factory("macosx-10.9-x86_64")
         )
         monkeypatch.setenv("MACOSX_DEPLOYMENT_TARGET", "10.8")
         monkeypatch.setattr(
@@ -186,7 +186,7 @@ def test_get_platform_bigsur_env(self, monkeypatch):
         dirname = os.path.dirname(__file__)
         dylib_dir = os.path.join(dirname, "testdata", "macosx_minimal_system_version")
         monkeypatch.setattr(
-            distutils.util, "get_platform", return_factory("macosx-10.9-x86_64")
+            sysconfig, "get_platform", return_factory("macosx-10.9-x86_64")
         )
         monkeypatch.setenv("MACOSX_DEPLOYMENT_TARGET", "11")
         monkeypatch.setattr(
@@ -202,7 +202,7 @@ def test_get_platform_bigsur_platform(self, monkeypatch):
         dirname = os.path.dirname(__file__)
         dylib_dir = os.path.join(dirname, "testdata", "macosx_minimal_system_version")
         monkeypatch.setattr(
-            distutils.util, "get_platform", return_factory("macosx-11-x86_64")
+            sysconfig, "get_platform", return_factory("macosx-11-x86_64")
         )
         monkeypatch.setattr(
             os,
@@ -215,6 +215,6 @@ def test_get_platform_bigsur_platform(self, monkeypatch):
 
 
 def test_get_platform_linux(monkeypatch):
-    monkeypatch.setattr(distutils.util, "get_platform", return_factory("linux_x86_64"))
+    monkeypatch.setattr(sysconfig, "get_platform", return_factory("linux-x86_64"))
     monkeypatch.setattr(sys, "maxsize", 2147483647)
     assert get_platform(None) == "linux_i686"