Rename classes and add compatibility shims.

Author: jaraco

distutils/_msvccompiler.py

@@ -0,0 +1,3 @@
+from .compilers.C import msvc
+
+MSVCCompiler = msvc.Compiler

distutils/ccompiler.py

@@ -0,0 +1,21 @@
+from .compilers.C import base
+from .compilers.C.base import (
+    CompileError,
+    gen_lib_options,
+    gen_preprocess_options,
+    get_default_compiler,
+    new_compiler,
+    show_compilers,
+)
+
+__all__ = [
+    'CompileError',
+    'gen_lib_options',
+    'gen_preprocess_options',
+    'get_default_compiler',
+    'new_compiler',
+    'show_compilers',
+]
+
+
+CCompiler = base.Compiler

distutils/compilers/C/base.py

@@ -1,6 +1,6 @@
 """distutils.ccompiler
 
-Contains CCompiler, an abstract base class that defines the interface
+Contains Compiler, an abstract base class that defines the interface
 for the Distutils compiler abstraction model."""
 
 import os
@@ -12,22 +12,22 @@
 
 from more_itertools import always_iterable
 
-from ._log import log
-from ._modified import newer_group
-from .dir_util import mkpath
-from .errors import (
+from ..._log import log
+from ..._modified import newer_group
+from ...dir_util import mkpath
+from ...errors import (
     CompileError,
     DistutilsModuleError,
     DistutilsPlatformError,
     LinkError,
     UnknownFileError,
 )
-from .file_util import move_file
-from .spawn import spawn
-from .util import execute, is_mingw, split_quoted
+from ...file_util import move_file
+from ...spawn import spawn
+from ...util import execute, is_mingw, split_quoted
 
 
-class CCompiler:
+class Compiler:
     """Abstract base class to define the interface that must be implemented
     by real compiler classes.  Also has some utility methods used by
     several compiler classes.
@@ -726,7 +726,7 @@ def link_shared_lib(
         target_lang=None,
     ):
         self.link(
-            CCompiler.SHARED_LIBRARY,
+            Compiler.SHARED_LIBRARY,
             objects,
             self.library_filename(output_libname, lib_type='shared'),
             output_dir,
@@ -757,7 +757,7 @@ def link_shared_object(
         target_lang=None,
     ):
         self.link(
-            CCompiler.SHARED_OBJECT,
+            Compiler.SHARED_OBJECT,
             objects,
             output_filename,
             output_dir,
@@ -786,7 +786,7 @@ def link_executable(
         target_lang=None,
     ):
         self.link(
-            CCompiler.EXECUTABLE,
+            Compiler.EXECUTABLE,
             objects,
             self.executable_filename(output_progname),
             output_dir,
@@ -978,9 +978,9 @@ def _make_out_path(self, output_dir, strip_dir, src_name):
     def _make_out_path_exts(cls, output_dir, strip_dir, src_name, extensions):
         r"""
         >>> exts = {'.c': '.o'}
-        >>> CCompiler._make_out_path_exts('.', False, '/foo/bar.c', exts).replace('\\', '/')
+        >>> Compiler._make_out_path_exts('.', False, '/foo/bar.c', exts).replace('\\', '/')
         './foo/bar.o'
-        >>> CCompiler._make_out_path_exts('.', True, '/foo/bar.c', exts).replace('\\', '/')
+        >>> Compiler._make_out_path_exts('.', True, '/foo/bar.c', exts).replace('\\', '/')
         './bar.o'
         """
         src = pathlib.PurePath(src_name)

distutils/compilers/C/cygwin.py

@@ -14,16 +14,16 @@
 import warnings
 from subprocess import check_output
 
-from .errors import (
+from ...errors import (
     CCompilerError,
     CompileError,
     DistutilsExecError,
     DistutilsPlatformError,
 )
-from .file_util import write_file
-from .sysconfig import get_config_vars
-from .unixccompiler import UnixCCompiler
-from .version import LooseVersion, suppress_known_deprecation
+from ...file_util import write_file
+from ...sysconfig import get_config_vars
+from ...version import LooseVersion, suppress_known_deprecation
+from . import unix
 
 
 def get_msvcr():
@@ -37,7 +37,7 @@ def get_msvcr():
 )
 
 
-class CygwinCCompiler(UnixCCompiler):
+class Compiler(unix.Compiler):
     """Handles the Cygwin port of the GNU C compiler to Windows."""
 
     compiler_type = 'cygwin'
@@ -197,8 +197,7 @@ def link(
         if not debug:
             extra_preargs.append("-s")
 
-        UnixCCompiler.link(
-            self,
+        super().link(
             target_desc,
             objects,
             output_filename,
@@ -240,7 +239,7 @@ def out_extensions(self):
 
 
 # the same as cygwin plus some additional parameters
-class Mingw32CCompiler(CygwinCCompiler):
+class MinGW32Compiler(Compiler):
     """Handles the Mingw32 port of the GNU C compiler to Windows."""
 
     compiler_type = 'mingw32'

distutils/compilers/C/msvc.py

@@ -23,16 +23,17 @@
 
 from itertools import count
 
-from ._log import log
-from .ccompiler import CCompiler, gen_lib_options
-from .errors import (
+from ..._log import log
+from ...errors import (
     CompileError,
     DistutilsExecError,
     DistutilsPlatformError,
     LibError,
     LinkError,
 )
-from .util import get_host_platform, get_platform
+from ...util import get_host_platform, get_platform
+from . import base
+from .base import gen_lib_options
 
 
 def _find_vc2015():
@@ -226,7 +227,7 @@ def _get_vcvars_spec(host_platform, platform):
     return vc_hp if vc_hp == vc_plat else f'{vc_hp}_{vc_plat}'
 
 
-class MSVCCompiler(CCompiler):
+class Compiler(base.Compiler):
     """Concrete class that implements an interface to Microsoft Visual C++,
     as defined by the CCompiler abstract class."""
 
@@ -339,15 +340,15 @@ def initialize(self, plat_name=None):
         self.ldflags_static_debug = [*ldflags_debug]
 
         self._ldflags = {
-            (CCompiler.EXECUTABLE, None): self.ldflags_exe,
-            (CCompiler.EXECUTABLE, False): self.ldflags_exe,
-            (CCompiler.EXECUTABLE, True): self.ldflags_exe_debug,
-            (CCompiler.SHARED_OBJECT, None): self.ldflags_shared,
-            (CCompiler.SHARED_OBJECT, False): self.ldflags_shared,
-            (CCompiler.SHARED_OBJECT, True): self.ldflags_shared_debug,
-            (CCompiler.SHARED_LIBRARY, None): self.ldflags_static,
-            (CCompiler.SHARED_LIBRARY, False): self.ldflags_static,
-            (CCompiler.SHARED_LIBRARY, True): self.ldflags_static_debug,
+            (base.Compiler.EXECUTABLE, None): self.ldflags_exe,
+            (base.Compiler.EXECUTABLE, False): self.ldflags_exe,
+            (base.Compiler.EXECUTABLE, True): self.ldflags_exe_debug,
+            (base.Compiler.SHARED_OBJECT, None): self.ldflags_shared,
+            (base.Compiler.SHARED_OBJECT, False): self.ldflags_shared,
+            (base.Compiler.SHARED_OBJECT, True): self.ldflags_shared_debug,
+            (base.Compiler.SHARED_LIBRARY, None): self.ldflags_static,
+            (base.Compiler.SHARED_LIBRARY, False): self.ldflags_static,
+            (base.Compiler.SHARED_LIBRARY, True): self.ldflags_static_debug,
         }
 
         self.initialized = True

distutils/compilers/C/unix.py

@@ -21,13 +21,14 @@
 import shlex
 import sys
 
-from . import sysconfig
-from ._log import log
-from ._macos_compat import compiler_fixup
-from ._modified import newer
-from .ccompiler import CCompiler, gen_lib_options, gen_preprocess_options
-from .compat import consolidate_linker_args
-from .errors import CompileError, DistutilsExecError, LibError, LinkError
+from ... import sysconfig
+from ..._log import log
+from ..._macos_compat import compiler_fixup
+from ..._modified import newer
+from ...compat import consolidate_linker_args
+from ...errors import CompileError, DistutilsExecError, LibError, LinkError
+from . import base
+from .base import gen_lib_options, gen_preprocess_options
 
 # XXX Things not currently handled:
 #   * optimization/debug/warning flags; we just use whatever's in Python's
@@ -105,7 +106,7 @@ def _linker_params(linker_cmd, compiler_cmd):
     return linker_cmd[pivot:]
 
 
-class UnixCCompiler(CCompiler):
+class Compiler(base.Compiler):
     compiler_type = 'unix'
 
     # These are used by CCompiler in two places: the constructor sets
@@ -264,7 +265,7 @@ def link(
                 # Select a linker based on context: linker_exe when
                 # building an executable or linker_so (with shared options)
                 # when building a shared library.
-                building_exe = target_desc == CCompiler.EXECUTABLE
+                building_exe = target_desc == base.Compiler.EXECUTABLE
                 linker = (
                     self.linker_exe
                     if building_exe

distutils/compilers/C/zos.py

@@ -13,9 +13,9 @@
 
 import os
 
-from . import sysconfig
-from .errors import CompileError, DistutilsExecError
-from .unixccompiler import UnixCCompiler
+from ... import sysconfig
+from ...errors import CompileError, DistutilsExecError
+from . import unix
 
 _cc_args = {
     'ibm-openxl': [
@@ -101,7 +101,7 @@
 # Python on z/OS is built with no compiler specific options in it's CFLAGS.
 # But each compiler requires it's own specific options to build successfully,
 # though some of the options are common between them
-class zOSCCompiler(UnixCCompiler):
+class Compiler(unix.Compiler):
     src_extensions = ['.c', '.C', '.cc', '.cxx', '.cpp', '.m', '.s']
     _cpp_extensions = ['.cc', '.cpp', '.cxx', '.C']
     _asm_extensions = ['.s']

distutils/cygwinccompiler.py

@@ -0,0 +1,31 @@
+from .compilers.C import cygwin
+from .compilers.C.cygwin import (
+    CONFIG_H_NOTOK,
+    CONFIG_H_OK,
+    CONFIG_H_UNCERTAIN,
+    check_config_h,
+    get_msvcr,
+    is_cygwincc,
+)
+
+__all__ = [
+    'CONFIG_H_NOTOK',
+    'CONFIG_H_OK',
+    'CONFIG_H_UNCERTAIN',
+    'CygwinCCompiler',
+    'Mingw32CCompiler',
+    'check_config_h',
+    'get_msvcr',
+    'is_cygwincc',
+]
+
+
+CygwinCCompiler = cygwin.Compiler
+Mingw32CCompiler = cygwin.MinGW32Compiler
+
+
+get_versions = None
+"""
+A stand-in for the previous get_versions() function to prevent failures
+when monkeypatched. See pypa/setuptools#2969.
+"""

distutils/tests/test_msvccompiler.py

@@ -6,6 +6,7 @@
 import threading
 import unittest.mock as mock
 from distutils import _msvccompiler
+from distutils.compilers.C import msvc
 from distutils.errors import DistutilsPlatformError
 from distutils.tests import support
 from distutils.util import get_platform
@@ -23,10 +24,10 @@ def test_no_compiler(self, monkeypatch):
         def _find_vcvarsall(plat_spec):
             return None, None
 
-        monkeypatch.setattr(_msvccompiler, '_find_vcvarsall', _find_vcvarsall)
+        monkeypatch.setattr(msvc, '_find_vcvarsall', _find_vcvarsall)
 
         with pytest.raises(DistutilsPlatformError):
-            _msvccompiler._get_vc_env(
+            msvc._get_vc_env(
                 'wont find this version',
             )
 

distutils/unixccompiler.py

@@ -0,0 +1,3 @@
+from .compilers.C import unix
+
+UnixCCompiler = unix.Compiler