distutils.file_util
index
/usr/lib/python2.1/distutils/file_util.py

distutils.file_util
 
Utility functions for operating on single files.

 
Modules
            
os

 
Functions
            
_copy_file_contents(src, dst, buffer_size=16384)
Copy the file 'src' to 'dst'; both must be filenames.  Any error
opening either file, reading from 'src', or writing to 'dst', raises
DistutilsFileError.  Data is read/written in chunks of 'buffer_size'
bytes (default 16k).  No attempt is made to handle anything apart from
regular files.
copy_file(src, dst, preserve_mode=1, preserve_times=1, update=0, link=None, verbose=0, dry_run=0)
Copy a file 'src' to 'dst'.  If 'dst' is a directory, then 'src' is
copied there with the same name; otherwise, it must be a filename.  (If
the file exists, it will be ruthlessly clobbered.)  If 'preserve_mode'
is true (the default), the file's mode (type and permission bits, or
whatever is analogous on the current platform) is copied.  If
'preserve_times' is true (the default), the last-modified and
last-access times are copied as well.  If 'update' is true, 'src' will
only be copied if 'dst' does not exist, or if 'dst' does exist but is
older than 'src'.  If 'verbose' is true, then a one-line summary of the
copy will be printed to stdout.
 
'link' allows you to make hard links (os.link) or symbolic links
(os.symlink) instead of copying: set it to "hard" or "sym"; if it is
None (the default), files are copied.  Don't set 'link' on systems that
don't support it: 'copy_file()' doesn't check if hard or symbolic
linking is available.
 
Under Mac OS, uses the native file copy function in macostools; on
other systems, uses '_copy_file_contents()' to copy file contents.
 
Return a tuple (dest_name, copied): 'dest_name' is the actual name of
the output file, and 'copied' is true if the file was copied (or would
have been copied, if 'dry_run' true).
move_file(src, dst, verbose=0, dry_run=0)
Move a file 'src' to 'dst'.  If 'dst' is a directory, the file will
be moved into it with the same name; otherwise, 'src' is just renamed
to 'dst'.  Return the new full name of the file.
 
Handles cross-device moves on Unix using 'copy_file()'.  What about
other systems???
write_file(filename, contents)
Create a file with the specified name and write 'contents' (a
sequence of strings without line terminators) to it.

 
Data
             ST_ATIME = 7
ST_CTIME = 9
ST_DEV = 2
ST_GID = 5
ST_INO = 1
ST_MODE = 0
ST_MTIME = 8
ST_NLINK = 3
ST_SIZE = 6
ST_UID = 4
S_ENFMT = 1024
S_IEXEC = 64
S_IFBLK = 24576
S_IFCHR = 8192
S_IFDIR = 16384
S_IFIFO = 4096
S_IFLNK = 40960
S_IFREG = 32768
S_IFSOCK = 49152
S_IREAD = 256
S_IRGRP = 32
S_IROTH = 4
S_IRUSR = 256
S_IRWXG = 56
S_IRWXO = 7
S_IRWXU = 448
S_ISGID = 1024
S_ISUID = 2048
S_ISVTX = 512
S_IWGRP = 16
S_IWOTH = 2
S_IWRITE = 128
S_IWUSR = 128
S_IXGRP = 8
S_IXOTH = 1
S_IXUSR = 64
__file__ = '/usr/lib/python2.1/distutils/file_util.pyc'
__name__ = 'distutils.file_util'
__revision__ = '$Id: file_util.py,v 1.8 2001/01/31 20:07:17 jhylton Exp $'
_copy_action = {None: 'copying', 'hard': 'hard linking', 'sym': 'symbolically linking'}