Merge https://github.com/pypa/distutils

Author: jaraco

newsfragments/4871.bugfix.rst

@@ -0,0 +1 @@
+Restored implicit distutils.ccompiler import for g-ir-scanner.

newsfragments/4876.bugfix.rst

@@ -0,0 +1 @@
+Restore `distutils.ccompiler.compiler_class` -- by :user:`Avasam`

setuptools/_distutils/_msvccompiler.py

@@ -1,3 +1,5 @@
 from .compilers.C import msvc
 
+__all__ = ["MSVCCompiler"]
+
 MSVCCompiler = msvc.Compiler

setuptools/_distutils/ccompiler.py

@@ -1,17 +1,18 @@
 from .compilers.C import base
 from .compilers.C.base import (
-    CompileError,
-    LinkError,
+    compiler_class,
     gen_lib_options,
     gen_preprocess_options,
     get_default_compiler,
     new_compiler,
     show_compilers,
 )
+from .compilers.C.errors import CompileError, LinkError
 
 __all__ = [
     'CompileError',
     'LinkError',
+    'compiler_class',
     'gen_lib_options',
     'gen_preprocess_options',
     'get_default_compiler',

setuptools/_distutils/command/build.py

@@ -10,17 +10,12 @@
 from collections.abc import Callable
 from typing import ClassVar
 
+from ..ccompiler import show_compilers
 from ..core import Command
 from ..errors import DistutilsOptionError
 from ..util import get_platform
 
 
-def show_compilers():
-    from ..ccompiler import show_compilers
-
-    show_compilers()
-
-
 class build(Command):
     description = "build everything needed to install"
 

setuptools/_distutils/command/build_clib.py

@@ -19,17 +19,12 @@
 from distutils._log import log
 from typing import ClassVar
 
+from ..ccompiler import new_compiler, show_compilers
 from ..core import Command
 from ..errors import DistutilsSetupError
 from ..sysconfig import customize_compiler
 
 
-def show_compilers():
-    from ..ccompiler import show_compilers
-
-    show_compilers()
-
-
 class build_clib(Command):
     description = "build C/C++ libraries used by Python extensions"
 
@@ -93,9 +88,6 @@ def run(self) -> None:
         if not self.libraries:
             return
 
-        # Yech -- this is cut 'n pasted from build_ext.py!
-        from ..ccompiler import new_compiler
-
         self.compiler = new_compiler(
             compiler=self.compiler, dry_run=self.dry_run, force=self.force
         )

setuptools/_distutils/command/build_ext.py

@@ -16,6 +16,7 @@
 from typing import ClassVar
 
 from .._modified import newer_group
+from ..ccompiler import new_compiler, show_compilers
 from ..core import Command
 from ..errors import (
     CCompilerError,
@@ -34,12 +35,6 @@
 extension_name_re = re.compile(r'^[a-zA-Z_][a-zA-Z_0-9]*(\.[a-zA-Z_][a-zA-Z_0-9]*)*$')
 
 
-def show_compilers():
-    from ..ccompiler import show_compilers
-
-    show_compilers()
-
-
 class build_ext(Command):
     description = "build C/C++ extensions (compile/link to build directory)"
 
@@ -303,8 +298,6 @@ def finalize_options(self) -> None:  # noqa: C901
                 raise DistutilsOptionError("parallel should be an integer")
 
     def run(self) -> None:  # noqa: C901
-        from ..ccompiler import new_compiler
-
         # 'self.extensions', as supplied by setup.py, is a list of
         # Extension instances.  See the documentation for Extension (in
         # distutils.extension) for details.

setuptools/_distutils/command/check.py

@@ -141,7 +141,7 @@ def _check_rst_data(self, data):
         document.note_source(source_path, -1)
         try:
             parser.parse(data, document)
-        except AttributeError as e:
+        except (AttributeError, TypeError) as e:
             reporter.messages.append((
                 -1,
                 f'Could not finish the parsing: {e}.',

setuptools/_distutils/command/config.py

@@ -258,8 +258,6 @@ def try_run(
         built from 'body' and 'headers'.  Return true on success, false
         otherwise.
         """
-        from ..ccompiler import CompileError, LinkError
-
         self._check_compiler()
         try:
             src, obj, exe = self._link(

setuptools/_distutils/compilers/C/unix.py

@@ -158,6 +158,20 @@ class Compiler(base.Compiler):
         dylib_lib_extension = ".dll"
         dylib_lib_format = "cyg%s%s"
 
+    def _fix_lib_args(self, libraries, library_dirs, runtime_library_dirs):
+        """Remove standard library path from rpath"""
+        libraries, library_dirs, runtime_library_dirs = super()._fix_lib_args(
+            libraries, library_dirs, runtime_library_dirs
+        )
+        libdir = sysconfig.get_config_var('LIBDIR')
+        if (
+            runtime_library_dirs
+            and libdir.startswith("/usr/lib")
+            and (libdir in runtime_library_dirs)
+        ):
+            runtime_library_dirs.remove(libdir)
+        return libraries, library_dirs, runtime_library_dirs
+
     def preprocess(
         self,
         source: str | os.PathLike[str],

setuptools/_distutils/tests/test_build_ext.py

@@ -1,13 +1,16 @@
 import contextlib
+import glob
 import importlib
-import os
+import os.path
 import platform
 import re
 import shutil
 import site
+import subprocess
 import sys
 import tempfile
 import textwrap
+import time
 from distutils import sysconfig
 from distutils.command.build_ext import build_ext
 from distutils.core import Distribution
@@ -51,6 +54,9 @@ def user_site_dir(request):
     site.USER_BASE = orig_user_base
     build_ext.USER_BASE = orig_user_base
 
+    if sys.platform == 'cygwin':
+        time.sleep(1)
+
 
 @contextlib.contextmanager
 def safe_extension_import(name, path):
@@ -86,11 +92,35 @@ class TestBuildExt(TempdirManager):
     def build_ext(self, *args, **kwargs):
         return build_ext(*args, **kwargs)
 
-    def test_build_ext(self):
+    @pytest.mark.parametrize("copy_so", [False])
+    def test_build_ext(self, copy_so):
         missing_compiler_executable()
         copy_xxmodule_c(self.tmp_dir)
         xx_c = os.path.join(self.tmp_dir, 'xxmodule.c')
         xx_ext = Extension('xx', [xx_c])
+        if sys.platform != "win32":
+            if not copy_so:
+                xx_ext = Extension(
+                    'xx',
+                    [xx_c],
+                    library_dirs=['/usr/lib'],
+                    libraries=['z'],
+                    runtime_library_dirs=['/usr/lib'],
+                )
+            elif sys.platform == 'linux':
+                libz_so = {
+                    os.path.realpath(name) for name in glob.iglob('/usr/lib*/libz.so*')
+                }
+                libz_so = sorted(libz_so, key=lambda lib_path: len(lib_path))
+                shutil.copyfile(libz_so[-1], '/tmp/libxx_z.so')
+
+                xx_ext = Extension(
+                    'xx',
+                    [xx_c],
+                    library_dirs=['/tmp'],
+                    libraries=['xx_z'],
+                    runtime_library_dirs=['/tmp'],
+                )
         dist = Distribution({'name': 'xx', 'ext_modules': [xx_ext]})
         dist.package_dir = self.tmp_dir
         cmd = self.build_ext(dist)
@@ -109,10 +139,13 @@ def test_build_ext(self):
             sys.stdout = old_stdout
 
         with safe_extension_import('xx', self.tmp_dir):
-            self._test_xx()
+            self._test_xx(copy_so)
+
+        if sys.platform == 'linux' and copy_so:
+            os.unlink('/tmp/libxx_z.so')
 
     @staticmethod
-    def _test_xx():
+    def _test_xx(copy_so):
         import xx
 
         for attr in ('error', 'foo', 'new', 'roj'):
@@ -127,6 +160,28 @@ def _test_xx():
         assert isinstance(xx.Null(), xx.Null)
         assert isinstance(xx.Str(), xx.Str)
 
+        if sys.platform == 'linux':
+            so_headers = subprocess.check_output(
+                ["readelf", "-d", xx.__file__], universal_newlines=True
+            )
+            import pprint
+
+            pprint.pprint(so_headers)
+            rpaths = [
+                rpath
+                for line in so_headers.split("\n")
+                if "RPATH" in line or "RUNPATH" in line
+                for rpath in line.split()[2][1:-1].split(":")
+            ]
+            if not copy_so:
+                pprint.pprint(rpaths)
+                # Linked against a library in /usr/lib{,64}
+                assert "/usr/lib" not in rpaths and "/usr/lib64" not in rpaths
+            else:
+                # Linked against a library in /tmp
+                assert "/tmp" in rpaths
+                # The import is the real test here
+
     def test_solaris_enable_shared(self):
         dist = Distribution({'name': 'xx'})
         cmd = self.build_ext(dist)

setuptools/_distutils/unixccompiler.py

@@ -1,3 +1,9 @@
+import importlib
+
 from .compilers.C import unix
 
 UnixCCompiler = unix.Compiler
+
+# ensure import of unixccompiler implies ccompiler imported
+# (pypa/setuptools#4871)
+importlib.import_module('distutils.ccompiler')

setuptools/_distutils/util.py

@@ -315,13 +315,14 @@ def execute(
     verbose: bool = False,
     dry_run: bool = False,
 ) -> None:
-    """Perform some action that affects the outside world (eg.  by
-    writing to the filesystem).  Such actions are special because they
-    are disabled by the 'dry_run' flag.  This method takes care of all
-    that bureaucracy for you; all you have to do is supply the
+    """
+    Perform some action that affects the outside world (e.g. by
+    writing to the filesystem). Such actions are special because they
+    are disabled by the 'dry_run' flag. This method handles that
+    complication; simply supply the
     function to call and an argument tuple for it (to embody the
-    "external action" being performed), and an optional message to
-    print.
+    "external action" being performed) and an optional message to
+    emit.
     """
     if msg is None:
         msg = f"{func.__name__}{args!r}"