Merge pull request #3475 from pypa/distutils-129480b

Merge with distutils@129480b

Author: jaraco

changelog.d/3475.change.rst

@@ -0,0 +1 @@
+Merge with pypa/distutils@129480b, including substantial delinting and cleanup, some refactoring around compiler logic, better messaging in cygwincompiler (pypa/distutils#161).

setuptools/_distutils/_msvccompiler.py

@@ -345,7 +345,7 @@ def make_out_path(p):
 
         return list(map(make_out_path, source_filenames))
 
-    def compile(
+    def compile(  # noqa: C901
         self,
         sources,
         output_dir=None,

setuptools/_distutils/archive_util.py

@@ -134,7 +134,7 @@ def _set_uid_gid(tarinfo):
     return archive_name
 
 
-def make_zipfile(base_name, base_dir, verbose=0, dry_run=0):
+def make_zipfile(base_name, base_dir, verbose=0, dry_run=0):  # noqa: C901
     """Create a zip file from all the files under 'base_dir'.
 
     The output zip file will be named 'base_name' + ".zip".  Uses either the

setuptools/_distutils/bcppcompiler.py

@@ -77,7 +77,7 @@ def __init__(self, verbose=0, dry_run=0, force=0):
 
     # -- Worker methods ------------------------------------------------
 
-    def compile(
+    def compile(  # noqa: C901
         self,
         sources,
         output_dir=None,
@@ -174,7 +174,7 @@ def create_static_lib(
 
     # create_static_lib ()
 
-    def link(
+    def link(  # noqa: C901
         self,
         target_desc,
         objects,
@@ -250,8 +250,8 @@ def link(
                 else:
                     objects.append(file)
 
-            for l in library_dirs:
-                ld_args.append("/L%s" % os.path.normpath(l))
+            for ell in library_dirs:
+                ld_args.append("/L%s" % os.path.normpath(ell))
             ld_args.append("/L.")  # we sometimes use relative paths
 
             # list of object files

setuptools/_distutils/ccompiler.py

@@ -3,8 +3,16 @@
 Contains CCompiler, an abstract base class that defines the interface
 for the Distutils compiler abstraction model."""
 
-import sys, os, re
-from distutils.errors import *
+import sys
+import os
+import re
+from distutils.errors import (
+    CompileError,
+    LinkError,
+    UnknownFileError,
+    DistutilsPlatformError,
+    DistutilsModuleError,
+)
 from distutils.spawn import spawn
 from distutils.file_util import move_file
 from distutils.dir_util import mkpath
@@ -808,7 +816,7 @@ def library_option(self, lib):
         """
         raise NotImplementedError
 
-    def has_function(
+    def has_function(  # noqa: C901
         self,
         funcname,
         includes=None,
@@ -945,10 +953,9 @@ def library_filename(
         self, libname, lib_type='static', strip_dir=0, output_dir=''  # or 'shared'
     ):
         assert output_dir is not None
-        if lib_type not in ("static", "shared", "dylib", "xcode_stub"):
-            raise ValueError(
-                "'lib_type' must be \"static\", \"shared\", \"dylib\", or \"xcode_stub\""
-            )
+        expected = '"static", "shared", "dylib", "xcode_stub"'
+        if lib_type not in eval(expected):
+            raise ValueError(f"'lib_type' must be {expected}")
         fmt = getattr(self, lib_type + "_lib_format")
         ext = getattr(self, lib_type + "_lib_extension")
 

setuptools/_distutils/cmd.py

@@ -4,7 +4,9 @@
 in the distutils.command package.
 """
 
-import sys, os, re
+import sys
+import os
+import re
 from distutils.errors import DistutilsOptionError
 from distutils import util, dir_util, file_util, archive_util, dep_util
 from distutils import log

setuptools/_distutils/command/__init__.py

@@ -3,7 +3,7 @@
 Package containing implementation of all the standard Distutils
 commands."""
 
-__all__ = [
+__all__ = [  # noqa: F822
     'build',
     'build_py',
     'build_ext',
@@ -23,10 +23,4 @@
     'bdist_wininst',
     'check',
     'upload',
-    # These two are reserved for future use:
-    #'bdist_sdux',
-    #'bdist_pkgtool',
-    # Note:
-    # bdist_packager is not included because it only provides
-    # an abstract base class
 ]

setuptools/_distutils/command/bdist.py

@@ -5,7 +5,7 @@
 
 import os
 from distutils.core import Command
-from distutils.errors import *
+from distutils.errors import DistutilsPlatformError, DistutilsOptionError
 from distutils.util import get_platform
 
 
@@ -15,11 +15,17 @@ def show_formats():
 
     formats = []
     for format in bdist.format_commands:
-        formats.append(("formats=" + format, None, bdist.format_command[format][1]))
+        formats.append(("formats=" + format, None, bdist.format_commands[format][1]))
     pretty_printer = FancyGetopt(formats)
     pretty_printer.print_help("List of available distribution formats:")
 
 
+class ListCompat(dict):
+    # adapter to allow for Setuptools compatibility in format_commands
+    def append(self, item):
+        return
+
+
 class bdist(Command):
 
     description = "create a built (binary) distribution"
@@ -64,31 +70,23 @@ class bdist(Command):
     # Debian-ish Linux, Solaris, FreeBSD, ..., Windows, Mac OS.
     default_format = {'posix': 'gztar', 'nt': 'zip'}
 
-    # Establish the preferred order (for the --help-formats option).
-    format_commands = [
-        'rpm',
-        'gztar',
-        'bztar',
-        'xztar',
-        'ztar',
-        'tar',
-        'wininst',
-        'zip',
-        'msi',
-    ]
-
-    # And the real information.
-    format_command = {
-        'rpm': ('bdist_rpm', "RPM distribution"),
-        'gztar': ('bdist_dumb', "gzip'ed tar file"),
-        'bztar': ('bdist_dumb', "bzip2'ed tar file"),
-        'xztar': ('bdist_dumb', "xz'ed tar file"),
-        'ztar': ('bdist_dumb', "compressed tar file"),
-        'tar': ('bdist_dumb', "tar file"),
-        'wininst': ('bdist_wininst', "Windows executable installer"),
-        'zip': ('bdist_dumb', "ZIP file"),
-        'msi': ('bdist_msi', "Microsoft Installer"),
-    }
+    # Define commands in preferred order for the --help-formats option
+    format_commands = ListCompat(
+        {
+            'rpm': ('bdist_rpm', "RPM distribution"),
+            'gztar': ('bdist_dumb', "gzip'ed tar file"),
+            'bztar': ('bdist_dumb', "bzip2'ed tar file"),
+            'xztar': ('bdist_dumb', "xz'ed tar file"),
+            'ztar': ('bdist_dumb', "compressed tar file"),
+            'tar': ('bdist_dumb', "tar file"),
+            'wininst': ('bdist_wininst', "Windows executable installer"),
+            'zip': ('bdist_dumb', "ZIP file"),
+            'msi': ('bdist_msi', "Microsoft Installer"),
+        }
+    )
+
+    # for compatibility until Setuptools references only format_commands
+    format_command = format_commands
 
     def initialize_options(self):
         self.bdist_base = None
@@ -132,7 +130,7 @@ def run(self):
         commands = []
         for format in self.formats:
             try:
-                commands.append(self.format_command[format][0])
+                commands.append(self.format_commands[format][0])
             except KeyError:
                 raise DistutilsOptionError("invalid format '%s'" % format)
 

setuptools/_distutils/command/bdist_dumb.py

@@ -8,7 +8,7 @@
 from distutils.core import Command
 from distutils.util import get_platform
 from distutils.dir_util import remove_tree, ensure_relative
-from distutils.errors import *
+from distutils.errors import DistutilsPlatformError
 from distutils.sysconfig import get_python_version
 from distutils import log
 

setuptools/_distutils/command/bdist_msi.py

@@ -31,9 +31,6 @@ def __init__(self, *args, **kw):
         default, cancel, bitmap=true)"""
         super().__init__(*args)
         ruler = self.h - 36
-        bmwidth = 152 * ruler / 328
-        # if kw.get("bitmap", True):
-        #    self.bitmap("Bitmap", 0, 0, bmwidth, ruler, "PythonWin")
         self.line("BottomLine", 0, ruler, self.w, 0)
 
     def title(self, title):
@@ -231,7 +228,7 @@ def finalize_options(self):
                 )
         self.install_script_key = None
 
-    def run(self):
+    def run(self):  # noqa: C901
         if not self.skip_build:
             self.run_command('build')
 
@@ -318,7 +315,7 @@ def run(self):
         if not self.keep_temp:
             remove_tree(self.bdist_dir, dry_run=self.dry_run)
 
-    def add_files(self):
+    def add_files(self):  # noqa: C901
         db = self.db
         cab = msilib.CAB("distfiles")
         rootdir = os.path.abspath(self.bdist_dir)
@@ -406,11 +403,9 @@ def add_find_python(self):
             exe_action = "PythonExe" + ver
             target_dir_prop = "TARGETDIR" + ver
             exe_prop = "PYTHON" + ver
-            if msilib.Win64:
-                # type: msidbLocatorTypeRawValue + msidbLocatorType64bit
-                Type = 2 + 16
-            else:
-                Type = 2
+
+            # Type: msidbLocatorTypeRawValue + msidbLocatorType64bit
+            Type = 2 + 16 * bool(msilib.Win64)
             add_data(
                 self.db,
                 "RegLocator",
@@ -517,7 +512,6 @@ def add_ui(self):
         # see "Dialog Style Bits"
         modal = 3  # visible | modal
         modeless = 1  # visible
-        track_disk_space = 32
 
         # UI customization properties
         add_data(
@@ -590,7 +584,9 @@ def add_ui(self):
             320,
             80,
             0x30003,
-            "[ProductName] setup ended prematurely because of an error.  Your system has not been modified.  To install this program at a later time, please run the installation again.",
+            "[ProductName] setup ended prematurely because of an error. "
+            "Your system has not been modified.  To install this program "
+            "at a later time, please run the installation again.",
         )
         fatal.text(
             "Description2",
@@ -618,7 +614,8 @@ def add_ui(self):
             80,
             0x30003,
             "[ProductName] setup was interrupted.  Your system has not been modified.  "
-            "To install this program at a later time, please run the installation again.",
+            "To install this program at a later time, please run the installation "
+            "again.",
         )
         user_exit.text(
             "Description2",
@@ -683,7 +680,10 @@ def add_ui(self):
             330,
             50,
             3,
-            "The following applications are using files that need to be updated by this setup. Close these applications and then click Retry to continue the installation or Cancel to exit it.",
+            "The following applications are using files that need to be updated by "
+            "this "
+            "setup. Close these applications and then click Retry to continue the "
+            "installation or Cancel to exit it.",
         )
         inuse.control(
             "List",
@@ -720,7 +720,6 @@ def add_ui(self):
             None,
         )
         error.text("ErrorText", 50, 9, 280, 48, 3, "")
-        # error.control("ErrorIcon", "Icon", 15, 9, 24, 24, 5242881, None, "py.ico", None, None)
         error.pushbutton("N", 120, 72, 81, 21, 3, "No", None).event(
             "EndDialog", "ErrorNo"
         )
@@ -785,7 +784,8 @@ def add_ui(self):
             194,
             30,
             3,
-            "Please wait while the installer finishes determining your disk space requirements.",
+            "Please wait while the installer finishes determining your disk space "
+            "requirements.",
         )
         c = costing.pushbutton("Return", 102, 57, 56, 17, 3, "Return", None)
         c.event("EndDialog", "Exit")
@@ -802,7 +802,8 @@ def add_ui(self):
             320,
             40,
             0x30003,
-            "Please wait while the Installer prepares to guide you through the installation.",
+            "Please wait while the Installer prepares to guide you through the "
+            "installation.",
         )
         prep.title("Welcome to the [ProductName] Installer")
         c = prep.text("ActionText", 15, 110, 320, 20, 0x30003, "Pondering...")
@@ -1096,7 +1097,6 @@ def add_ui(self):
 
         # Close dialog when maintenance action scheduled
         c.event("EndDialog", "Return", 'MaintenanceForm_Action<>"Change"', 20)
-        # c.event("NewDialog", "SelectFeaturesDlg", 'MaintenanceForm_Action="Change"', 21)
 
         maint.cancel("Cancel", "RepairRadioGroup").event("SpawnDialog", "CancelDlg")