setuptools._distutils.dir_util

module documentation
(source)

distutils.dir_util Utility functions for manipulating directories and directory trees.

Function copy_tree Copy an entire directory tree 'src' to a new location 'dst'.
Function create_tree Create all the empty directories under 'base_dir' needed to put 'files' there.
Function ensure_relative Take the full path 'path', and make it a relative path.
Function mkpath Create a directory and any missing ancestor directories.
Function remove_tree Recursively remove an entire directory tree.
Function _build_cmdtuple Helper for remove_tree().
Variable _path_created Undocumented
def copy_tree(src, dst, preserve_mode=1, preserve_times=1, preserve_symlinks=0, update=0, verbose=1, dry_run=0): (source)

Copy an entire directory tree 'src' to a new location 'dst'. Both 'src' and 'dst' must be directory names. If 'src' is not a directory, raise DistutilsFileError. If 'dst' does not exist, it is created with 'mkpath()'. The end result of the copy is that every file in 'src' is copied to 'dst', and directories under 'src' are recursively copied to 'dst'. Return the list of files that were copied or might have been copied, using their output name. The return value is unaffected by 'update' or 'dry_run': it is simply the list of all files under 'src', with the names changed to be under 'dst'. 'preserve_mode' and 'preserve_times' are the same as for 'copy_file'; note that they only apply to regular files, not to directories. If 'preserve_symlinks' is true, symlinks will be copied as symlinks (on platforms that support them!); otherwise (the default), the destination of the symlink will be copied. 'update' and 'verbose' are the same as for 'copy_file'.

def create_tree(base_dir, files, mode=511, verbose=1, dry_run=0): (source)

Create all the empty directories under 'base_dir' needed to put 'files' there. 'base_dir' is just the name of a directory which doesn't necessarily exist yet; 'files' is a list of filenames to be interpreted relative to 'base_dir'. 'base_dir' + the directory portion of every file in 'files' will be created if it doesn't already exist. 'mode', 'verbose' and 'dry_run' flags are as for 'mkpath()'.

def ensure_relative(path): (source)

Take the full path 'path', and make it a relative path. This is useful to make 'path' the second argument to os.path.join().

def mkpath(name, mode=511, verbose=1, dry_run=0): (source)

Create a directory and any missing ancestor directories. If the directory already exists (or if 'name' is the empty string, which means the current directory, which of course exists), then do nothing. Raise DistutilsFileError if unable to create some directory along the way (eg. some sub-path exists, but is a file rather than a directory). If 'verbose' is true, print a one-line summary of each mkdir to stdout. Return the list of directories actually created. os.makedirs is not used because: a) It's new to Python 1.5.2, and b) it blows up if the directory already exists (in which case it should silently succeed).

def remove_tree(directory, verbose=1, dry_run=0): (source)

Recursively remove an entire directory tree. Any errors are ignored (apart from being reported to stdout if 'verbose' is true).

def _build_cmdtuple(path, cmdtuples): (source)

Helper for remove_tree().

_path_created: dict = (source)

Undocumented