Remove 'dry run' functionality throughout.

Author: jaraco

setuptools/_vendor/wheel/bdist_wheel.py

@@ -440,11 +440,10 @@ def run(self):
 
         if not self.keep_temp:
             log.info(f"removing {self.bdist_dir}")
-            if not self.dry_run:
-                if sys.version_info < (3, 12):
-                    rmtree(self.bdist_dir, onerror=remove_readonly)
-                else:
-                    rmtree(self.bdist_dir, onexc=remove_readonly_exc)
+            if sys.version_info < (3, 12):
+                rmtree(self.bdist_dir, onerror=remove_readonly)
+            else:
+                rmtree(self.bdist_dir, onexc=remove_readonly_exc)
 
     def write_wheelfile(
         self, wheelfile_base, generator="bdist_wheel (" + wheel_version + ")"

setuptools/command/alias.py

@@ -61,7 +61,7 @@ def run(self) -> None:
             alias = self.args[0]
             command = ' '.join(map(shquote, self.args[1:]))
 
-        edit_config(self.filename, {'aliases': {alias: command}}, self.dry_run)
+        edit_config(self.filename, {'aliases': {alias: command}})
 
 
 def format_alias(name, aliases):

setuptools/command/bdist_egg.py

@@ -158,7 +158,6 @@ def call_command(self, cmdname, **kw):
         for dirname in INSTALL_DIRECTORY_ATTRS:
             kw.setdefault(dirname, self.bdist_dir)
         kw.setdefault('skip_build', self.skip_build)
-        kw.setdefault('dry_run', self.dry_run)
         cmd = self.reinitialize_command(cmdname, **kw)
         self.run_command(cmdname)
         return cmd
@@ -185,8 +184,7 @@ def run(self):  # noqa: C901  # is too complex (14)  # FIXME
             pyfile = os.path.join(self.bdist_dir, strip_module(filename) + '.py')
             self.stubs.append(pyfile)
             log.info("creating stub loader for %s", ext_name)
-            if not self.dry_run:
-                write_stub(os.path.basename(ext_name), pyfile)
+            write_stub(os.path.basename(ext_name), pyfile)
             to_compile.append(pyfile)
             ext_outputs[p] = ext_name.replace(os.sep, '/')
 
@@ -208,15 +206,13 @@ def run(self):  # noqa: C901  # is too complex (14)  # FIXME
         native_libs = os.path.join(egg_info, "native_libs.txt")
         if all_outputs:
             log.info("writing %s", native_libs)
-            if not self.dry_run:
-                ensure_directory(native_libs)
-                with open(native_libs, 'wt', encoding="utf-8") as libs_file:
-                    libs_file.write('\n'.join(all_outputs))
-                    libs_file.write('\n')
+            ensure_directory(native_libs)
+            with open(native_libs, 'wt', encoding="utf-8") as libs_file:
+                libs_file.write('\n'.join(all_outputs))
+                libs_file.write('\n')
         elif os.path.isfile(native_libs):
             log.info("removing %s", native_libs)
-            if not self.dry_run:
-                os.unlink(native_libs)
+            os.unlink(native_libs)
 
         write_safety_flag(os.path.join(archive_root, 'EGG-INFO'), self.zip_safe())
 
@@ -234,11 +230,10 @@ def run(self):  # noqa: C901  # is too complex (14)  # FIXME
             self.egg_output,
             archive_root,
             verbose=self.verbose,
-            dry_run=self.dry_run,
             mode=self.gen_header(),
         )
         if not self.keep_temp:
-            remove_tree(self.bdist_dir, dry_run=self.dry_run)
+            remove_tree(self.bdist_dir)
 
         # Add to 'Distribution.dist_files' so that the "upload" command works
         getattr(self.distribution, 'dist_files', []).append((
@@ -443,7 +438,6 @@ def make_zipfile(
     zip_filename: StrPathT,
     base_dir,
     verbose: bool = False,
-    dry_run: bool = False,
     compress=True,
     mode: _ZipFileMode = 'w',
 ) -> StrPathT:
@@ -455,25 +449,20 @@ def make_zipfile(
     """
     import zipfile
 
-    mkpath(os.path.dirname(zip_filename), dry_run=dry_run)  # type: ignore[arg-type] # python/mypy#18075
+    mkpath(os.path.dirname(zip_filename))  # type: ignore[arg-type] # python/mypy#18075
     log.info("creating '%s' and adding '%s' to it", zip_filename, base_dir)
 
     def visit(z, dirname, names):
         for name in names:
             path = os.path.normpath(os.path.join(dirname, name))
             if os.path.isfile(path):
                 p = path[len(base_dir) + 1 :]
-                if not dry_run:
-                    z.write(path, p)
+                z.write(path, p)
                 log.debug("adding '%s'", p)
 
     compression = zipfile.ZIP_DEFLATED if compress else zipfile.ZIP_STORED
-    if not dry_run:
-        z = zipfile.ZipFile(zip_filename, mode, compression=compression)
-        for dirname, dirs, files in sorted_walk(base_dir):
-            visit(z, dirname, files)
-        z.close()
-    else:
-        for dirname, dirs, files in sorted_walk(base_dir):
-            visit(None, dirname, files)
+    z = zipfile.ZipFile(zip_filename, mode, compression=compression)
+    for dirname, dirs, files in sorted_walk(base_dir):
+        visit(z, dirname, files)
+    z.close()
     return zip_filename

setuptools/command/bdist_wheel.py

@@ -448,8 +448,7 @@ def run(self):
 
         if not self.keep_temp:
             log.info(f"removing {self.bdist_dir}")
-            if not self.dry_run:
-                _shutil.rmtree(self.bdist_dir)
+            _shutil.rmtree(self.bdist_dir)
 
     def write_wheelfile(
         self, wheelfile_base: str, generator: str = f"setuptools ({__version__})"

setuptools/command/build_ext.py

@@ -225,7 +225,7 @@ def finalize_options(self) -> None:
 
     def setup_shlib_compiler(self):
         compiler = self.shlib_compiler = new_compiler(
-            compiler=self.compiler, dry_run=self.dry_run, force=self.force
+            compiler=self.compiler, force=self.force
         )
         _customize_compiler_for_shlib(compiler)
 
@@ -353,49 +353,47 @@ def _write_stub_file(self, stub_file: str, ext: Extension, compile=False):
         log.info("writing stub loader for %s to %s", ext._full_name, stub_file)
         if compile and os.path.exists(stub_file):
             raise BaseError(stub_file + " already exists! Please delete.")
-        if not self.dry_run:
-            with open(stub_file, 'w', encoding="utf-8") as f:
-                content = '\n'.join([
-                    "def __bootstrap__():",
-                    "   global __bootstrap__, __file__, __loader__",
-                    "   import sys, os, pkg_resources, importlib.util" + if_dl(", dl"),
-                    "   __file__ = pkg_resources.resource_filename"
-                    f"(__name__,{os.path.basename(ext._file_name)!r})",
-                    "   del __bootstrap__",
-                    "   if '__loader__' in globals():",
-                    "       del __loader__",
-                    if_dl("   old_flags = sys.getdlopenflags()"),
-                    "   old_dir = os.getcwd()",
-                    "   try:",
-                    "     os.chdir(os.path.dirname(__file__))",
-                    if_dl("     sys.setdlopenflags(dl.RTLD_NOW)"),
-                    "     spec = importlib.util.spec_from_file_location(",
-                    "                __name__, __file__)",
-                    "     mod = importlib.util.module_from_spec(spec)",
-                    "     spec.loader.exec_module(mod)",
-                    "   finally:",
-                    if_dl("     sys.setdlopenflags(old_flags)"),
-                    "     os.chdir(old_dir)",
-                    "__bootstrap__()",
-                    "",  # terminal \n
-                ])
-                f.write(content)
+        with open(stub_file, 'w', encoding="utf-8") as f:
+            content = '\n'.join([
+                "def __bootstrap__():",
+                "   global __bootstrap__, __file__, __loader__",
+                "   import sys, os, pkg_resources, importlib.util" + if_dl(", dl"),
+                "   __file__ = pkg_resources.resource_filename"
+                f"(__name__,{os.path.basename(ext._file_name)!r})",
+                "   del __bootstrap__",
+                "   if '__loader__' in globals():",
+                "       del __loader__",
+                if_dl("   old_flags = sys.getdlopenflags()"),
+                "   old_dir = os.getcwd()",
+                "   try:",
+                "     os.chdir(os.path.dirname(__file__))",
+                if_dl("     sys.setdlopenflags(dl.RTLD_NOW)"),
+                "     spec = importlib.util.spec_from_file_location(",
+                "                __name__, __file__)",
+                "     mod = importlib.util.module_from_spec(spec)",
+                "     spec.loader.exec_module(mod)",
+                "   finally:",
+                if_dl("     sys.setdlopenflags(old_flags)"),
+                "     os.chdir(old_dir)",
+                "__bootstrap__()",
+                "",  # terminal \n
+            ])
+            f.write(content)
         if compile:
             self._compile_and_remove_stub(stub_file)
 
     def _compile_and_remove_stub(self, stub_file: str):
         from distutils.util import byte_compile
 
-        byte_compile([stub_file], optimize=0, force=True, dry_run=self.dry_run)
+        byte_compile([stub_file], optimize=0, force=True)
         optimize = self.get_finalized_command('install_lib').optimize
         if optimize > 0:
             byte_compile(
                 [stub_file],
                 optimize=optimize,
                 force=True,
-                dry_run=self.dry_run,
             )
-        if os.path.exists(stub_file) and not self.dry_run:
+        if os.path.exists(stub_file):
             os.unlink(stub_file)
 
 

setuptools/command/develop.py

@@ -119,9 +119,8 @@ def install_for_development(self) -> None:
 
         # create an .egg-link in the installation dir, pointing to our egg
         log.info("Creating %s (link to %s)", self.egg_link, self.egg_base)
-        if not self.dry_run:
-            with open(self.egg_link, "w", encoding="utf-8") as f:
-                f.write(self.egg_path + "\n" + self.setup_path)
+        with open(self.egg_link, "w", encoding="utf-8") as f:
+            f.write(self.egg_path + "\n" + self.setup_path)
         # postprocess the installed distro, fixing up .pth, installing scripts,
         # and handling requirements
         self.process_distribution(None, self.dist, not self.no_deps)
@@ -138,10 +137,8 @@ def uninstall_link(self) -> None:
             if contents not in ([self.egg_path], [self.egg_path, self.setup_path]):
                 log.warn("Link points to %s: uninstall aborted", contents)
                 return
-            if not self.dry_run:
-                os.unlink(self.egg_link)
-        if not self.dry_run:
-            self.update_pth(self.dist)  # remove any .pth link to us
+            os.unlink(self.egg_link)
+        self.update_pth(self.dist)  # remove any .pth link to us
         if self.distribution.scripts:
             # XXX should also check for entry point scripts!
             log.warn("Note: you must uninstall or replace scripts manually!")

setuptools/command/easy_install.py

@@ -205,7 +205,6 @@ def initialize_options(self):
         # always come from the standard configuration file(s)' "easy_install"
         # section, even if this is a "develop" or "install" command, or some
         # other embedding.
-        self._dry_run = None
         self.verbose = self.distribution.verbose
         self.distribution._set_command_options(
             self, self.distribution.get_option_dict('easy_install')
@@ -221,8 +220,6 @@ def delete_blockers(self, blockers) -> None:
 
     def _delete_path(self, path):
         log.info("Deleting %s", path)
-        if self.dry_run:
-            return
 
         is_tree = os.path.isdir(path) and not os.path.islink(path)
         remover = _rmtree if is_tree else os.unlink
@@ -868,9 +865,6 @@ def write_script(self, script_name, contents, mode: str = "t", blockers=()) -> N
         target = os.path.join(self.script_dir, script_name)
         self.add_output(target)
 
-        if self.dry_run:
-            return
-
         mask = current_umask()
         ensure_directory(target)
         if os.path.exists(target):
@@ -945,15 +939,14 @@ def install_egg(self, egg_path, tmpdir):
             os.path.basename(egg_path),
         )
         destination = os.path.abspath(destination)
-        if not self.dry_run:
-            ensure_directory(destination)
+        ensure_directory(destination)
 
         dist = self.egg_distribution(egg_path)
         if not (
             os.path.exists(destination) and os.path.samefile(egg_path, destination)
         ):
             if os.path.isdir(destination) and not os.path.islink(destination):
-                dir_util.remove_tree(destination, dry_run=self.dry_run)
+                dir_util.remove_tree(destination)
             elif os.path.exists(destination):
                 self.execute(
                     os.unlink,
@@ -1036,7 +1029,6 @@ def install_exe(self, dist_filename, tmpdir):
             egg_path,
             egg_tmp,
             verbose=self.verbose,
-            dry_run=self.dry_run,
         )
         # install the .egg
         return self.install_egg(egg_path, tmpdir)
@@ -1099,10 +1091,9 @@ def install_wheel(self, wheel_path, tmpdir):
         assert wheel.is_compatible()
         destination = os.path.join(self.install_dir, wheel.egg_name())
         destination = os.path.abspath(destination)
-        if not self.dry_run:
-            ensure_directory(destination)
+        ensure_directory(destination)
         if os.path.isdir(destination) and not os.path.islink(destination):
-            dir_util.remove_tree(destination, dry_run=self.dry_run)
+            dir_util.remove_tree(destination)
         elif os.path.exists(destination):
             self.execute(
                 os.unlink,
@@ -1185,8 +1176,6 @@ def run_setup(self, setup_script, setup_base, args) -> None:
             args.insert(0, '-' + v)
         elif self.verbose < 2:
             args.insert(0, '-q')
-        if self.dry_run:
-            args.insert(0, '-n')
         log.info("Running %s %s", setup_script[len(setup_base) + 1 :], ' '.join(args))
         try:
             run_setup(setup_script, args)
@@ -1210,7 +1199,7 @@ def build_and_install(self, setup_script, setup_base):
                 for key in all_eggs
                 for dist in all_eggs[key]
             ]
-            if not eggs and not self.dry_run:
+            if not eggs:
                 log.warn("No eggs found in %s (setup script problem?)", dist_dir)
             return eggs
         finally:
@@ -1244,7 +1233,7 @@ def _set_fetcher_options(self, base):
         cfg_filename = os.path.join(base, 'setup.cfg')
         setopt.edit_config(cfg_filename, settings)
 
-    def update_pth(self, dist) -> None:  # noqa: C901  # is too complex (11)  # FIXME
+    def update_pth(self, dist) -> None:
         if self.pth_file is None:
             return
 
@@ -1269,9 +1258,6 @@ def update_pth(self, dist) -> None:  # noqa: C901  # is too complex (11)  # FIXM
                 if dist.location not in self.shadow_path:
                     self.shadow_path.append(dist.location)
 
-        if self.dry_run:
-            return
-
         self.pth_file.save()
 
         if dist.key != 'setuptools':
@@ -1303,14 +1289,13 @@ def pf(src, dst):
             elif dst.endswith('.dll') or dst.endswith('.so'):
                 to_chmod.append(dst)
             self.unpack_progress(src, dst)
-            return not self.dry_run and dst or None
+            return dst or None
 
         unpack_archive(egg_path, destination, pf)
         self.byte_compile(to_compile)
-        if not self.dry_run:
-            for f in to_chmod:
-                mode = ((os.stat(f)[stat.ST_MODE]) | 0o555) & 0o7755
-                chmod(f, mode)
+        for f in to_chmod:
+            mode = ((os.stat(f)[stat.ST_MODE]) | 0o555) & 0o7755
+            chmod(f, mode)
 
     def byte_compile(self, to_compile) -> None:
         if sys.dont_write_bytecode:
@@ -1322,13 +1307,12 @@ def byte_compile(self, to_compile) -> None:
             # try to make the byte compile messages quieter
             log.set_verbosity(self.verbose - 1)
 
-            byte_compile(to_compile, optimize=0, force=True, dry_run=self.dry_run)
+            byte_compile(to_compile, optimize=0, force=True)
             if self.optimize:
                 byte_compile(
                     to_compile,
                     optimize=self.optimize,
                     force=True,
-                    dry_run=self.dry_run,
                 )
         finally:
             log.set_verbosity(self.verbose)  # restore original verbosity

setuptools/command/editable_wheel.py

@@ -785,7 +785,6 @@ def __init__(self, distribution, installation_dir, editable_name, src_root) -> N
         self.installation_dir = installation_dir
         self.editable_name = editable_name
         self.outputs: list[str] = []
-        self.dry_run = False
 
     def _get_nspkg_file(self):
         """Installation target."""