setuptools._distutils.archive_util

module documentation
(source)

distutils.archive_util Utility functions for creating archive files (tarballs, zip files, that sort of thing).

Function check_archive_formats Returns the first format from the 'format' list that is unknown.
Function make_archive Create an archive file (eg. zip or tar).
Function make_tarball Create a (possibly compressed) tar file from all the files under 'base_dir'.
Function make_zipfile Create a zip file from all the files under 'base_dir'.
Constant ARCHIVE_FORMATS Undocumented
Function _get_gid Returns a gid, given a group name.
Function _get_uid Returns an uid, given a user name.
def check_archive_formats(formats): (source)

Returns the first format from the 'format' list that is unknown. If all formats are known, returns None

def make_archive(base_name, format, root_dir=None, base_dir=None, verbose=0, dry_run=0, owner=None, group=None): (source)

Create an archive file (eg. zip or tar). 'base_name' is the name of the file to create, minus any format-specific extension; 'format' is the archive format: one of "zip", "tar", "gztar", "bztar", "xztar", or "ztar". 'root_dir' is a directory that will be the root directory of the archive; ie. we typically chdir into 'root_dir' before creating the archive. 'base_dir' is the directory where we start archiving from; ie. 'base_dir' will be the common prefix of all files and directories in the archive. 'root_dir' and 'base_dir' both default to the current directory. Returns the name of the archive file. 'owner' and 'group' are used when creating a tar archive. By default, uses the current owner and group.

def make_tarball(base_name, base_dir, compress='gzip', verbose=0, dry_run=0, owner=None, group=None): (source)

Create a (possibly compressed) tar file from all the files under 'base_dir'. 'compress' must be "gzip" (the default), "bzip2", "xz", "compress", or None. ("compress" will be deprecated in Python 3.2) 'owner' and 'group' can be used to define an owner and a group for the archive that is being built. If not provided, the current owner and group will be used. The output tar file will be named 'base_dir' + ".tar", possibly plus the appropriate compression extension (".gz", ".bz2", ".xz" or ".Z"). Returns the output filename.

def make_zipfile(base_name, base_dir, verbose=0, dry_run=0): (source)

Create a zip file from all the files under 'base_dir'. The output zip file will be named 'base_name' + ".zip". Uses either the "zipfile" Python module (if available) or the InfoZIP "zip" utility (if installed and found on the default search path). If neither tool is available, raises DistutilsExecError. Returns the name of the output zip file.

ARCHIVE_FORMATS = (source)

Undocumented

Value
{'gztar': (make_tarball, [('compress', 'gzip')], 'gzip\'ed tar-file'),
 'bztar': (make_tarball, [('compress', 'bzip2')], 'bzip2\'ed tar-file'),
 'xztar': (make_tarball, [('compress', 'xz')], 'xz\'ed tar-file'),
 'ztar': (make_tarball, [('compress', 'compress')], 'compressed tar file'),
 'tar': (make_tarball, [('compress', None)], 'uncompressed tar file'),
 'zip': (make_zipfile, [], 'ZIP file')}
def _get_gid(name): (source)

Returns a gid, given a group name.

def _get_uid(name): (source)

Returns an uid, given a user name.