Package distutils :: Module dir_util
[hide private]
[frames] | no frames]

Module dir_util

distutils.dir_util

Utility functions for manipulating directories and directory trees.

Functions [hide private]
 
mkpath(name, mode=511, verbose=0, dry_run=0)
Create a directory and any missing ancestor directories.
 
create_tree(base_dir, files, mode=511, verbose=0, dry_run=0)
Create all the empty directories under 'base_dir' needed to put 'files' there.
 
copy_tree(src, dst, preserve_mode=1, preserve_times=1, preserve_symlinks=0, update=0, verbose=0, dry_run=0)
Copy an entire directory tree 'src' to a new location 'dst'.
 
_build_cmdtuple(path, cmdtuples)
 
remove_tree(directory, verbose=0, dry_run=0)
Recursively remove an entire directory tree.
 
ensure_relative(path)
Take the full path 'path', and make it a relative path so it can be the second argument to os.path.join().
Variables [hide private]
  __revision__ = '$Id: dir_util.py 39416 2005-08-26 15:20:46Z ti...
  _path_created = {}

Imports: os, sys, IntType, TypeType, BooleanType, CodeType, UnboundMethodType, StringType, BuiltinMethodType, FloatType, DictionaryType, NotImplementedType, BuiltinFunctionType, DictProxyType, GeneratorType, InstanceType, ObjectType, DictType, GetSetDescriptorType, FileType, EllipsisType, StringTypes, ListType, MethodType, TupleType, ModuleType, FrameType, LongType, BufferType, TracebackType, ClassType, MemberDescriptorType, UnicodeType, SliceType, ComplexType, LambdaType, FunctionType, XRangeType, NoneType, DistutilsFileError, DistutilsInternalError, log


Function Details [hide private]

mkpath(name, mode=511, verbose=0, dry_run=0)

 

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.

create_tree(base_dir, files, mode=511, verbose=0, dry_run=0)

 

Create all the empty directories under 'base_dir' needed to put 'files' there. 'base_dir' is just the a 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()'.

copy_tree(src, dst, preserve_mode=1, preserve_times=1, preserve_symlinks=0, update=0, verbose=0, dry_run=0)

 

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'.

remove_tree(directory, verbose=0, dry_run=0)

 

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


Variables Details [hide private]

__revision__

Value:
'$Id: dir_util.py 39416 2005-08-26 15:20:46Z tim_one $'