chore(distutils): remove distutils usages

Author: stegayet

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 ### Packaging
 - Include `py.typed` when packaging to denote that setuptools-rust includes type hints. [#338](https://github.com/PyO3/setuptools-rust/pull/338)
+- Remove direct imports from `distutils`. [#336](https://github.com/PyO3/setuptools-rust/pull/336)
 
 ## 1.6.0 (2023-04-27)
 ### Changed

noxfile.py

@@ -1,5 +1,4 @@
 import os
-import sys
 import tarfile
 from glob import glob
 from pathlib import Path

setuptools_rust/build.py

@@ -8,14 +8,14 @@
 import subprocess
 import sys
 import sysconfig
-from distutils import log
-from distutils.errors import (
+import logging
+from setuptools.errors import (
     CompileError,
-    DistutilsExecError,
-    DistutilsFileError,
-    DistutilsPlatformError,
+    ExecError,
+    FileError,
+    PlatformError,
 )
-from distutils.sysconfig import get_config_var
+from sysconfig import get_config_var
 from pathlib import Path
 from typing import Dict, Iterable, List, NamedTuple, Optional, Set, Tuple, cast
 
@@ -36,6 +36,8 @@
     get_rustc_cfgs,
 )
 
+logger = logging.getLogger(__name__)
+
 
 def _check_cargo_supports_crate_type_option() -> bool:
     version = get_rust_version()
@@ -153,9 +155,7 @@ def build_extension(
         env = _prepare_build_environment()
 
         if not os.path.exists(ext.path):
-            raise DistutilsFileError(
-                f"can't find Rust extension project file: {ext.path}"
-            )
+            raise FileError(f"can't find Rust extension project file: {ext.path}")
 
         quiet = self.qbuild or ext.quiet
         debug = self._is_debug_build(ext)
@@ -260,7 +260,7 @@ def build_extension(
             raise CompileError(format_called_process_error(e, include_stdout=False))
 
         except OSError:
-            raise DistutilsExecError(
+            raise ExecError(
                 "Unable to execute 'cargo' - this package "
                 "requires Rust to be installed and cargo to be on the PATH"
             )
@@ -289,7 +289,7 @@ def build_extension(
                         if Path(artifact).with_suffix("").name == name
                     )
                 except StopIteration:
-                    raise DistutilsExecError(
+                    raise ExecError(
                         f"Rust build failed; unable to locate executable '{name}'"
                     )
 
@@ -307,11 +307,11 @@ def build_extension(
                 kinds={"cdylib", "dylib"},
             )
             if len(artifacts) == 0:
-                raise DistutilsExecError(
+                raise ExecError(
                     "Rust build failed; unable to find any cdylib or dylib build artifacts"
                 )
             elif len(artifacts) > 1:
-                raise DistutilsExecError(
+                raise ExecError(
                     f"Rust build failed; expected only one cdylib or dylib build artifact but found {artifacts}"
                 )
 
@@ -371,7 +371,7 @@ def install_extension(
                 ext_path = self.get_dylib_ext_path(ext, module_name)
                 os.makedirs(os.path.dirname(ext_path), exist_ok=True)
 
-            log.info("Copying rust artifact from %s to %s", dylib_path, ext_path)
+            logger.info("Copying rust artifact from %s to %s", dylib_path, ext_path)
 
             # We want to atomically replace any existing library file. We can't
             # just copy the new library directly on top of the old one as that
@@ -546,7 +546,7 @@ def create_universal2_binary(output_path: str, input_paths: List[str]) -> None:
         try:
             from fat_macho import FatWriter
         except ImportError:
-            raise DistutilsExecError(
+            raise ExecError(
                 "failed to locate `lipo` or import `fat_macho.FatWriter`. "
                 "Try installing with `pip install fat-macho` "
             )
@@ -648,7 +648,7 @@ def _binding_features(
     elif ext.binding is Binding.RustCPython:
         return {"cpython/python3-sys", "cpython/extension-module"}
     else:
-        raise DistutilsPlatformError(f"unknown Rust binding: '{ext.binding}'")
+        raise PlatformError(f"unknown Rust binding: '{ext.binding}'")
 
 
 _PyLimitedApi = Literal["cp37", "cp38", "cp39", "cp310", "cp311", "cp312", True, False]

setuptools_rust/command.py

@@ -1,13 +1,14 @@
 from abc import ABC, abstractmethod
-from distutils import log
-from distutils.errors import DistutilsPlatformError
-from typing import List, Optional
-
+import logging
 from setuptools import Command, Distribution
+from setuptools.errors import PlatformError
+from typing import List, Optional
 
 from .extension import RustExtension
 from .rustc_info import get_rust_version
 
+logger = logging.getLogger(__name__)
+
 
 class RustCommand(Command, ABC):
     """Abstract base class for commands which interact with Rust Extensions."""
@@ -47,7 +48,7 @@ def finalize_options(self) -> None:
 
     def run(self) -> None:
         if not self.extensions:
-            log.info("%s: no rust_extensions defined", self.get_command_name())
+            logger.info("%s: no rust_extensions defined", self.get_command_name())
             return
 
         all_optional = all(ext.optional for ext in self.extensions)
@@ -61,7 +62,7 @@ def run(self) -> None:
                     ),
                     default=None,
                 )
-                raise DistutilsPlatformError(
+                raise PlatformError(
                     "can't find Rust compiler\n\n"
                     "If you are using an outdated pip version, it is possible a "
                     "prebuilt wheel is available for this package but pip is not able "
@@ -81,7 +82,7 @@ def run(self) -> None:
                         else ""
                     )
                 )
-        except DistutilsPlatformError as e:
+        except PlatformError as e:
             if not all_optional:
                 raise
             else:
@@ -92,7 +93,7 @@ def run(self) -> None:
             try:
                 rust_version = ext.get_rust_version()
                 if rust_version is not None and version not in rust_version:
-                    raise DistutilsPlatformError(
+                    raise PlatformError(
                         f"Rust {version} does not match extension requirement {rust_version}"
                     )
 

setuptools_rust/extension.py

@@ -3,7 +3,7 @@
 import re
 import subprocess
 import warnings
-from distutils.errors import DistutilsSetupError
+from setuptools.errors import SetupError
 from enum import IntEnum, auto
 from functools import lru_cache
 from typing import Any, Dict, List, NewType, Optional, Sequence, Union, cast
@@ -187,7 +187,7 @@ def get_rust_version(self) -> Optional[SimpleSpec]:  # type: ignore[no-any-unimp
         try:
             return SimpleSpec(self.rust_version)
         except ValueError:
-            raise DistutilsSetupError(
+            raise SetupError(
                 "Can not parse rust compiler version: %s", self.rust_version
             )
 
@@ -198,16 +198,14 @@ def get_cargo_profile(self) -> Optional[str]:
         except ValueError:
             pass
         except IndexError:
-            raise DistutilsSetupError("Can not parse cargo profile from %s", self.args)
+            raise SetupError("Can not parse cargo profile from %s", self.args)
 
         # Handle `--profile=<profile>`
         profile_args = [p for p in self.args if p.startswith("--profile=")]
         if profile_args:
             profile = profile_args[0].split("=", 1)[1]
             if not profile:
-                raise DistutilsSetupError(
-                    "Can not parse cargo profile from %s", self.args
-                )
+                raise SetupError("Can not parse cargo profile from %s", self.args)
             return profile
         else:
             return None
@@ -259,11 +257,11 @@ def _metadata(self, cargo: str, quiet: bool) -> "CargoMetadata":
                 metadata_command, stderr=stderr, encoding="latin-1"
             )
         except subprocess.CalledProcessError as e:
-            raise DistutilsSetupError(format_called_process_error(e))
+            raise SetupError(format_called_process_error(e))
         try:
             return cast(CargoMetadata, json.loads(payload))
         except json.decoder.JSONDecodeError as e:
-            raise DistutilsSetupError(
+            raise SetupError(
                 f"""
                 Error parsing output of cargo metadata as json; received:
                 {payload}

setuptools_rust/rustc_info.py

@@ -1,5 +1,5 @@
 import subprocess
-from distutils.errors import DistutilsPlatformError
+from setuptools.errors import PlatformError
 from functools import lru_cache
 from typing import Dict, List, NewType, Optional
 
@@ -25,7 +25,7 @@ def get_rust_host() -> str:
     for line in _rust_version_verbose().splitlines():
         if line.startswith(_HOST_LINE_START):
             return line[len(_HOST_LINE_START) :].strip()
-    raise DistutilsPlatformError("Could not determine rust host")
+    raise PlatformError("Could not determine rust host")
 
 
 RustCfgs = NewType("RustCfgs", Dict[str, Optional[str]])

setuptools_rust/setuptools_ext.py

@@ -1,11 +1,12 @@
 import os
 import subprocess
 import sysconfig
-from distutils import log
-from distutils.command.clean import clean
+import logging
+
 from typing import List, Set, Tuple, Type, cast
 
 from setuptools.command.build_ext import build_ext
+
 from setuptools.command.install import install
 from setuptools.command.install_lib import install_lib
 from setuptools.command.install_scripts import install_scripts
@@ -20,6 +21,8 @@
 except ImportError:
     bdist_wheel = None
 
+logger = logging.getLogger(__name__)
+
 
 def add_rust_extension(dist: Distribution) -> None:
     sdist_base_class = cast(Type[sdist], dist.cmdclass.get("sdist", sdist))
@@ -145,7 +148,7 @@ def initialize_options(self) -> None:
 
         def run(self) -> None:
             if self.distribution.rust_extensions:
-                log.info("running build_rust")
+                logger.info("running build_rust")
                 build_rust = self.get_finalized_command("build_rust")
                 build_rust.inplace = self.inplace
                 build_rust.target = self.target
@@ -159,15 +162,17 @@ def run(self) -> None:
 
     dist.cmdclass["build_ext"] = build_ext_rust_extension
 
-    clean_base_class = cast(Type[clean], dist.cmdclass.get("clean", clean))
+    clean_base_class = dist.cmdclass.get("clean")
 
-    class clean_rust_extension(clean_base_class):  # type: ignore[misc,valid-type]
-        def run(self) -> None:
-            clean_base_class.run(self)
-            if not self.dry_run:
-                self.run_command("clean_rust")
+    if clean_base_class is not None:
+
+        class clean_rust_extension(clean_base_class):  # type: ignore[misc,valid-type]
+            def run(self) -> None:
+                super().run()
+                if not self.dry_run:
+                    self.run_command("clean_rust")
 
-    dist.cmdclass["clean"] = clean_rust_extension
+        dist.cmdclass["clean"] = clean_rust_extension
 
     install_base_class = cast(Type[install], dist.cmdclass.get("install", install))