@@ -361,7 +361,7 @@ This module provides the following functions.
361361 are not given.
362362
363363
364- .. function :: new_compiler(plat=None, compiler=None, verbose=False, dry_run=False, force=False)
364+ .. function :: new_compiler(plat=None, compiler=None, verbose=False, force=False)
365365
366366 Factory function to generate an instance of some CCompiler subclass for the
367367 supplied platform/compiler combination. *plat * defaults to ``os.name `` (eg.
@@ -383,7 +383,7 @@ This module provides the following functions.
383383 to :command: `build `, :command: `build_ext `, :command: `build_clib `).
384384
385385
386- .. class :: CCompiler([verbose=False, dry_run=False, force=False])
386+ .. class :: CCompiler([verbose=False, force=False])
387387
388388 The abstract base class :class: `CCompiler ` defines the interface that must be
389389 implemented by real compiler classes. The class also has some utility methods
@@ -398,8 +398,7 @@ This module provides the following functions.
398398 or per-link basis.
399399
400400 The constructor for each subclass creates an instance of the Compiler object.
401- Flags are *verbose * (show verbose output), *dry_run * (don't actually execute the
402- steps) and *force * (rebuild everything, regardless of dependencies). All of
401+ Flags are *verbose * (show verbose output) and *force * (rebuild everything, regardless of dependencies). All of
403402 these flags default to ``0 `` (off). Note that you probably don't want to
404403 instantiate :class: `CCompiler ` or one of its subclasses directly - use the
405404 :func: `distutils.CCompiler.new_compiler ` factory function instead.
@@ -755,8 +754,7 @@ This module provides the following functions.
755754 .. method :: CCompiler.execute(func, args[, msg=None, level=1])
756755
757756 Invokes :func: `distutils.util.execute `. This method invokes a Python function
758- *func * with the given arguments *args *, after logging and taking into account
759- the *dry_run * flag.
757+ *func * with the given arguments *args *, after logging.
760758
761759
762760 .. method :: CCompiler.spawn(cmd)
@@ -884,7 +882,7 @@ This module provides a few functions for creating archive files, such as
884882tarballs or zipfiles.
885883
886884
887- .. function :: make_archive(base_name, format[, root_dir=None, base_dir=None, verbose=False, dry_run=False ])
885+ .. function :: make_archive(base_name, format[, root_dir=None, base_dir=None, verbose=False])
888886
889887 Create an archive file (eg. ``zip `` or ``tar ``). *base_name * is the name of
890888 the file to create, minus any format-specific extension; *format * is the
@@ -900,7 +898,7 @@ tarballs or zipfiles.
900898 Added support for the ``xztar `` format.
901899
902900
903- .. function :: make_tarball(base_name, base_dir[, compress='gzip', verbose=False, dry_run=False ])
901+ .. function :: make_tarball(base_name, base_dir[, compress='gzip', verbose=False])
904902
905903 'Create an (optional compressed) archive as a tar file from all files in and
906904 under *base_dir *. *compress * must be ``'gzip' `` (the default),
@@ -915,7 +913,7 @@ tarballs or zipfiles.
915913 Added support for the ``xz `` compression.
916914
917915
918- .. function :: make_zipfile(base_name, base_dir[, verbose=False, dry_run=False ])
916+ .. function :: make_zipfile(base_name, base_dir[, verbose=False])
919917
920918 Create a zip file from all files in and under *base_dir *. The output zip file
921919 will be named *base_name * + :file: `.zip `. Uses either the :mod: `zipfile ` Python
@@ -978,7 +976,7 @@ This module provides functions for operating on directories and trees of
978976directories.
979977
980978
981- .. function :: mkpath(name[, mode=0o777, verbose=False, dry_run=False ])
979+ .. function :: mkpath(name[, mode=0o777, verbose=False])
982980
983981 Create a directory and any missing ancestor directories. If the directory
984982 already exists (or if *name * is the empty string, which means the current
@@ -989,25 +987,25 @@ directories.
989987 directories actually created.
990988
991989
992- .. function :: create_tree(base_dir, files[, mode=0o777, verbose=False, dry_run=False ])
990+ .. function :: create_tree(base_dir, files[, mode=0o777, verbose=False])
993991
994992 Create all the empty directories under *base_dir * needed to put *files * there.
995993 *base_dir * is just the name of a directory which doesn't necessarily exist
996994 yet; *files * is a list of filenames to be interpreted relative to *base_dir *.
997995 *base_dir * + the directory portion of every file in *files * will be created if
998- it doesn't already exist. *mode *, * verbose * and *dry_run * flags are as for
996+ it doesn't already exist. *mode * and *verbose * flags are as for
999997 :func: `mkpath `.
1000998
1001999
1002- .. function :: copy_tree(src, dst[, preserve_mode=True, preserve_times=True, preserve_symlinks=False, update=False, verbose=False, dry_run=False ])
1000+ .. function :: copy_tree(src, dst[, preserve_mode=True, preserve_times=True, preserve_symlinks=False, update=False, verbose=False])
10031001
10041002 Copy an entire directory tree *src * to a new location *dst *. Both *src * and
10051003 *dst * must be directory names. If *src * is not a directory, raise
10061004 :exc: `DistutilsFileError `. If *dst * does not exist, it is created with
10071005 :func: `mkpath `. The end result of the copy is that every file in *src * is
10081006 copied to *dst *, and directories under *src * are recursively copied to *dst *.
10091007 Return the list of files that were copied or might have been copied, using their
1010- output name. The return value is unaffected by *update * or * dry_run * : it is
1008+ output name. The return value is unaffected by *update *: it is
10111009 simply the list of all files under *src *, with the names changed to be under
10121010 *dst *.
10131011
@@ -1026,7 +1024,7 @@ directories.
10261024 .. versionchanged :: 3.3.1
10271025 NFS files are ignored.
10281026
1029- .. function :: remove_tree(directory[, verbose=False, dry_run=False ])
1027+ .. function :: remove_tree(directory[, verbose=False])
10301028
10311029 Recursively remove *directory * and all files and directories underneath it. Any
10321030 errors are ignored (apart from being reported to ``sys.stdout `` if *verbose * is
@@ -1043,7 +1041,7 @@ directories.
10431041This module contains some utility functions for operating on individual files.
10441042
10451043
1046- .. function :: copy_file(src, dst[, preserve_mode=True, preserve_times=True, update=False, link=None, verbose=False, dry_run=False ])
1044+ .. function :: copy_file(src, dst[, preserve_mode=True, preserve_times=True, update=False, link=None, verbose=False])
10471045
10481046 Copy file *src * to *dst *. If *dst * is a directory, then *src * is copied there
10491047 with the same name; otherwise, it must be a filename. (If the file exists, it
@@ -1062,8 +1060,7 @@ This module contains some utility functions for operating on individual files.
10621060 contents.
10631061
10641062 Return a tuple ``(dest_name, copied) ``: *dest_name * is the actual name of the
1065- output file, and *copied * is true if the file was copied (or would have been
1066- copied, if *dry_run * true).
1063+ output file, and *copied * is true if the file was copied.
10671064
10681065 .. % XXX if the destination file already exists, we clobber it if
10691066 .. % copying, but blow up if linking. Hmmm. And I don't know what
@@ -1073,7 +1070,7 @@ This module contains some utility functions for operating on individual files.
10731070 .. % (not update) and (src newer than dst)).
10741071
10751072
1076- .. function :: move_file(src, dst[, verbose, dry_run ])
1073+ .. function :: move_file(src, dst[, verbose])
10771074
10781075 Move file *src * to *dst *. If *dst * is a directory, the file will be moved into
10791076 it with the same name; otherwise, *src * is just renamed to *dst *. Returns the
@@ -1216,12 +1213,12 @@ other utility module.
12161213 .. % Should probably be moved into the standard library.
12171214
12181215
1219- .. function :: execute(func, args[, msg=None, verbose=False, dry_run=False ])
1216+ .. function :: execute(func, args[, msg=None, verbose=False])
12201217
12211218 Perform some action that affects the outside world (for instance, writing to the
1222- filesystem). Such actions are special because they are disabled by the
1223- *dry_run * flag. This method takes care of all that bureaucracy for you; all
1224- you have to do is supply the function to call and an argument tuple for it (to
1219+ filesystem). Historically, such actions were special because they could be disabled
1220+ by a *dry_run * flag. This method takes care of all that bureaucracy;
1221+ simply supply the function to call and an argument tuple for it (to
12251222 embody the "external action" being performed), and an optional message to print.
12261223
12271224
@@ -1234,7 +1231,7 @@ other utility module.
12341231 :exc: `ValueError ` if *val * is anything else.
12351232
12361233
1237- .. function :: byte_compile(py_files[, optimize=0, force=False, prefix=None, base_dir=None, verbose=True, dry_run=False, direct=None])
1234+ .. function :: byte_compile(py_files[, optimize=0, force=False, prefix=None, base_dir=None, verbose=True, direct=None])
12381235
12391236 Byte-compile a collection of Python source files to :file: `.pyc ` files in a
12401237 :file: `__pycache__ ` subdirectory (see :pep: `3147 ` and :pep: `488 `).
@@ -1254,9 +1251,6 @@ other utility module.
12541251 stripped). You can supply either or both (or neither) of *prefix * and
12551252 *base_dir *, as you wish.
12561253
1257- If *dry_run * is true, doesn't actually do anything that would affect the
1258- filesystem.
1259-
12601254 Byte-compilation is either done directly in this interpreter process with the
12611255 standard :mod: `py_compile ` module, or indirectly by writing a temporary script
12621256 and executing it. Normally, you should let :func: `byte_compile ` figure out to
0 commit comments