mirror of
https://github.com/python/cpython.git
synced 2025-09-26 18:29:57 +00:00
Reformat docstrings.
Standardize whitespace in function calls.
This commit is contained in:
parent
071ed76732
commit
ca4289f7b2
2 changed files with 63 additions and 64 deletions
|
@ -18,10 +18,10 @@ def make_tarball (base_name, base_dir, compress="gzip",
|
||||||
'base_dir'. 'compress' must be "gzip" (the default), "compress",
|
'base_dir'. 'compress' must be "gzip" (the default), "compress",
|
||||||
"bzip2", or None. Both "tar" and the compression utility named by
|
"bzip2", or None. Both "tar" and the compression utility named by
|
||||||
'compress' must be on the default program search path, so this is
|
'compress' must be on the default program search path, so this is
|
||||||
probably Unix-specific. The output tar file will be named 'base_dir'
|
probably Unix-specific. The output tar file will be named 'base_dir' +
|
||||||
+ ".tar", possibly plus the appropriate compression extension (".gz",
|
".tar", possibly plus the appropriate compression extension (".gz",
|
||||||
".bz2" or ".Z"). Return the output filename."""
|
".bz2" or ".Z"). Return the output filename.
|
||||||
|
"""
|
||||||
# XXX GNU tar 1.13 has a nifty option to add a prefix directory.
|
# XXX GNU tar 1.13 has a nifty option to add a prefix directory.
|
||||||
# It's pretty new, though, so we certainly can't require it --
|
# It's pretty new, though, so we certainly can't require it --
|
||||||
# but it would be nice to take advantage of it to skip the
|
# but it would be nice to take advantage of it to skip the
|
||||||
|
@ -57,13 +57,13 @@ def make_tarball (base_name, base_dir, compress="gzip",
|
||||||
|
|
||||||
|
|
||||||
def make_zipfile (base_name, base_dir, verbose=0, dry_run=0):
|
def make_zipfile (base_name, base_dir, verbose=0, dry_run=0):
|
||||||
"""Create a zip file from all the files under 'base_dir'. The
|
"""Create a zip file from all the files under 'base_dir'. The output
|
||||||
output zip file will be named 'base_dir' + ".zip". Uses either the
|
zip file will be named 'base_dir' + ".zip". Uses either the InfoZIP
|
||||||
InfoZIP "zip" utility (if installed and found on the default search
|
"zip" utility (if installed and found on the default search path) or
|
||||||
path) or the "zipfile" Python module (if available). If neither
|
the "zipfile" Python module (if available). If neither tool is
|
||||||
tool is available, raises DistutilsExecError. Returns the name
|
available, raises DistutilsExecError. Returns the name of the output
|
||||||
of the output zip file."""
|
zip file.
|
||||||
|
"""
|
||||||
# This initially assumed the Unix 'zip' utility -- but
|
# This initially assumed the Unix 'zip' utility -- but
|
||||||
# apparently InfoZIP's zip.exe works the same under Windows, so
|
# apparently InfoZIP's zip.exe works the same under Windows, so
|
||||||
# no changes needed!
|
# no changes needed!
|
||||||
|
|
|
@ -14,11 +14,10 @@ from distutils.errors import DistutilsFileError
|
||||||
|
|
||||||
def newer (source, target):
|
def newer (source, target):
|
||||||
"""Return true if 'source' exists and is more recently modified than
|
"""Return true if 'source' exists and is more recently modified than
|
||||||
'target', or if 'source' exists and 'target' doesn't. Return
|
'target', or if 'source' exists and 'target' doesn't. Return false if
|
||||||
false if both exist and 'target' is the same age or younger than
|
both exist and 'target' is the same age or younger than 'source'.
|
||||||
'source'. Raise DistutilsFileError if 'source' does not
|
Raise DistutilsFileError if 'source' does not exist.
|
||||||
exist."""
|
"""
|
||||||
|
|
||||||
if not os.path.exists(source):
|
if not os.path.exists(source):
|
||||||
raise DistutilsFileError, "file '%s' does not exist" % source
|
raise DistutilsFileError, "file '%s' does not exist" % source
|
||||||
if not os.path.exists(target):
|
if not os.path.exists(target):
|
||||||
|
@ -36,9 +35,9 @@ def newer (source, target):
|
||||||
def newer_pairwise (sources, targets):
|
def newer_pairwise (sources, targets):
|
||||||
"""Walk two filename lists in parallel, testing if each source is newer
|
"""Walk two filename lists in parallel, testing if each source is newer
|
||||||
than its corresponding target. Return a pair of lists (sources,
|
than its corresponding target. Return a pair of lists (sources,
|
||||||
targets) where source is newer than target, according to the
|
targets) where source is newer than target, according to the semantics
|
||||||
semantics of 'newer()'."""
|
of 'newer()'.
|
||||||
|
"""
|
||||||
if len(sources) != len(targets):
|
if len(sources) != len(targets):
|
||||||
raise ValueError, "'sources' and 'targets' must be same length"
|
raise ValueError, "'sources' and 'targets' must be same length"
|
||||||
|
|
||||||
|
@ -56,18 +55,18 @@ def newer_pairwise (sources, targets):
|
||||||
|
|
||||||
|
|
||||||
def newer_group (sources, target, missing='error'):
|
def newer_group (sources, target, missing='error'):
|
||||||
"""Return true if 'target' is out-of-date with respect to any
|
"""Return true if 'target' is out-of-date with respect to any file
|
||||||
file listed in 'sources'. In other words, if 'target' exists and
|
listed in 'sources'. In other words, if 'target' exists and is newer
|
||||||
is newer than every file in 'sources', return false; otherwise
|
than every file in 'sources', return false; otherwise return true.
|
||||||
return true. 'missing' controls what we do when a source file is
|
'missing' controls what we do when a source file is missing; the
|
||||||
missing; the default ("error") is to blow up with an OSError from
|
default ("error") is to blow up with an OSError from inside 'stat()';
|
||||||
inside 'stat()'; if it is "ignore", we silently drop any missing
|
if it is "ignore", we silently drop any missing source files; if it is
|
||||||
source files; if it is "newer", any missing source files make us
|
"newer", any missing source files make us assume that 'target' is
|
||||||
assume that 'target' is out-of-date (this is handy in "dry-run"
|
out-of-date (this is handy in "dry-run" mode: it'll make you pretend to
|
||||||
mode: it'll make you pretend to carry out commands that wouldn't
|
carry out commands that wouldn't work because inputs are missing, but
|
||||||
work because inputs are missing, but that doesn't matter because
|
that doesn't matter because you're not actually going to run the
|
||||||
you're not actually going to run the commands)."""
|
commands).
|
||||||
|
"""
|
||||||
# If the target doesn't even exist, then it's definitely out-of-date.
|
# If the target doesn't even exist, then it's definitely out-of-date.
|
||||||
if not os.path.exists(target):
|
if not os.path.exists(target):
|
||||||
return 1
|
return 1
|
||||||
|
@ -102,9 +101,9 @@ def newer_group (sources, target, missing='error'):
|
||||||
def make_file (src, dst, func, args,
|
def make_file (src, dst, func, args,
|
||||||
verbose=0, update_message=None, noupdate_message=None):
|
verbose=0, update_message=None, noupdate_message=None):
|
||||||
"""Makes 'dst' from 'src' (both filenames) by calling 'func' with
|
"""Makes 'dst' from 'src' (both filenames) by calling 'func' with
|
||||||
'args', but only if it needs to: i.e. if 'dst' does not exist or
|
'args', but only if it needs to: i.e. if 'dst' does not exist or 'src'
|
||||||
'src' is newer than 'dst'."""
|
is newer than 'dst'.
|
||||||
|
"""
|
||||||
if newer(src, dst):
|
if newer(src, dst):
|
||||||
if verbose and update_message:
|
if verbose and update_message:
|
||||||
print update_message
|
print update_message
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue