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

Module file_util

distutils.file_util

Utility functions for operating on single files.

Functions [hide private]
 
_copy_file_contents(src, dst, buffer_size=16384)
Copy the file 'src' to 'dst'; both must be filenames.
 
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'.
 
move_file(src, dst, verbose=0, dry_run=0)
Move a file 'src' to 'dst'.
 
write_file(filename, contents)
Create a file with the specified name and write 'contents' (a sequence of strings without line terminators) to it.
Variables [hide private]
  __revision__ = '$Id: file_util.py 37828 2004-11-10 22:23:15Z l...
  _copy_action = {None: 'copying', 'hard': 'hard linking', 'sym'...

Imports: os, DistutilsFileError, log


Function Details [hide private]

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

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


Variables Details [hide private]

__revision__

Value:
'$Id: file_util.py 37828 2004-11-10 22:23:15Z loewis $'

_copy_action

Value:
{None: 'copying',
 'hard': 'hard linking',
 'sym': 'symbolically linking'}