Na}{

File Content: `archive_util.py`

"""distutils.archive_util

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

__revision__ = "$Id$"

import os
from warnings import warn
import sys

from distutils.errors import DistutilsExecError
from distutils.spawn import spawn
from distutils.dir_util import mkpath
from distutils import log

try:
    from pwd import getpwnam
except ImportError:
    getpwnam = None

try:
    from grp import getgrnam
except ImportError:
    getgrnam = None

def _get_gid(name):
    """Returns a gid, given a group name."""
    if getgrnam is None or name is None:
        return None
    try:
        result = getgrnam(name)
    except KeyError:
        result = None
    if result is not None:
        return result[2]
    return None

def _get_uid(name):
    """Returns an uid, given a user name."""
    if getpwnam is None or name is None:
        return None
    try:
        result = getpwnam(name)
    except KeyError:
        result = None
    if result is not None:
        return result[2]
    return None

def make_tarball(base_name, base_dir, compress="gzip", verbose=0, dry_run=0,
                 owner=None, group=None):
    """Create a (possibly compressed) tar file from all the files under
    'base_dir'.

    'compress' must be "gzip" (the default), "compress", "bzip2", 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" or ".Z").

    Returns the output filename.
    """
    tar_compression = {'gzip': 'gz', 'bzip2': 'bz2', None: '', 'compress': ''}
    compress_ext = {'gzip': '.gz', 'bzip2': '.bz2', 'compress': '.Z'}

    # flags for compression program, each element of list will be an argument
    if compress is not None and compress not in compress_ext.keys():
        raise ValueError, \
              ("bad value for 'compress': must be None, 'gzip', 'bzip2' "
               "or 'compress'")

    archive_name = base_name + '.tar'
    if compress != 'compress':
        archive_name += compress_ext.get(compress, '')

    mkpath(os.path.dirname(archive_name), dry_run=dry_run)

    # creating the tarball
    import tarfile  # late import so Python build itself doesn't break

    log.info('Creating tar archive')

    uid = _get_uid(owner)
    gid = _get_gid(group)

    def _set_uid_gid(tarinfo):
        if gid is not None:
            tarinfo.gid = gid
            tarinfo.gname = group
        if uid is not None:
            tarinfo.uid = uid
            tarinfo.uname = owner
        return tarinfo

    if not dry_run:
        tar = tarfile.open(archive_name, 'w|%s' % tar_compression[compress])
        try:
            tar.add(base_dir, filter=_set_uid_gid)
        finally:
            tar.close()

    # compression using `compress`
    if compress == 'compress':
        warn("'compress' will be deprecated.", PendingDeprecationWarning)
        # the option varies depending on the platform
        compressed_name = archive_name + compress_ext[compress]
        if sys.platform == 'win32':
            cmd = [compress, archive_name, compressed_name]
        else:
            cmd = [compress, '-f', archive_name]
        spawn(cmd, dry_run=dry_run)
        return compressed_name

    return archive_name

def make_zipfile(base_name, base_dir, verbose=0, dry_run=0):
    """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.
    """
    try:
        import zipfile
    except ImportError:
        zipfile = None

    zip_filename = base_name + ".zip"
    mkpath(os.path.dirname(zip_filename), dry_run=dry_run)

    # If zipfile module is not available, try spawning an external
    # 'zip' command.
    if zipfile is None:
        if verbose:
            zipoptions = "-r"
        else:
            zipoptions = "-rq"

        try:
            spawn(["zip", zipoptions, zip_filename, base_dir],
                  dry_run=dry_run)
        except DistutilsExecError:
            # XXX really should distinguish between "couldn't find
            # external 'zip' command" and "zip failed".
            raise DistutilsExecError, \
                  ("unable to create zip file '%s': "
                   "could neither import the 'zipfile' module nor "
                   "find a standalone zip utility") % zip_filename

    else:
        log.info("creating '%s' and adding '%s' to it",
                 zip_filename, base_dir)

        if not dry_run:
            zip = zipfile.ZipFile(zip_filename, "w",
                                  compression=zipfile.ZIP_DEFLATED)

            if base_dir != os.curdir:
                path = os.path.normpath(os.path.join(base_dir, ''))
                zip.write(path, path)
                log.info("adding '%s'", path)
            for dirpath, dirnames, filenames in os.walk(base_dir):
                for name in dirnames:
                    path = os.path.normpath(os.path.join(dirpath, name, ''))
                    zip.write(path, path)
                    log.info("adding '%s'", path)
                for name in filenames:
                    path = os.path.normpath(os.path.join(dirpath, name))
                    if os.path.isfile(path):
                        zip.write(path, path)
                        log.info("adding '%s'" % path)
            zip.close()

    return zip_filename

ARCHIVE_FORMATS = {
    'gztar': (make_tarball, [('compress', 'gzip')], "gzip'ed tar-file"),
    'bztar': (make_tarball, [('compress', 'bzip2')], "bzip2'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 check_archive_formats(formats):
    """Returns the first format from the 'format' list that is unknown.

    If all formats are known, returns None
    """
    for format in formats:
        if format not in ARCHIVE_FORMATS:
            return format
    return None

def make_archive(base_name, format, root_dir=None, base_dir=None, verbose=0,
                 dry_run=0, owner=None, group=None):
    """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", "ztar",
    or "gztar".

    '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.
    """
    save_cwd = os.getcwd()
    if root_dir is not None:
        log.debug("changing into '%s'", root_dir)
        base_name = os.path.abspath(base_name)
        if not dry_run:
            os.chdir(root_dir)

    if base_dir is None:
        base_dir = os.curdir

    kwargs = {'dry_run': dry_run}

    try:
        format_info = ARCHIVE_FORMATS[format]
    except KeyError:
        raise ValueError, "unknown archive format '%s'" % format

    func = format_info[0]
    for arg, val in format_info[1]:
        kwargs[arg] = val

    if format != 'zip':
        kwargs['owner'] = owner
        kwargs['group'] = group

    try:
        filename = func(base_name, base_dir, **kwargs)
    finally:
        if root_dir is not None:
            log.debug("changing back to '%s'", save_cwd)
            os.chdir(save_cwd)

    return filename

Name	Size	Permission
command	---	0755
README	295 bytes	0644
__init__.py	236 bytes	0644
__init__.pyc	415 bytes	0644
__init__.pyo	415 bytes	0644
archive_util.py	8219 bytes	0644
archive_util.pyc	7601 bytes	0644
archive_util.pyo	7601 bytes	0644
bcppcompiler.py	14941 bytes	0644
bcppcompiler.pyc	7882 bytes	0644
bcppcompiler.pyo	7882 bytes	0644
ccompiler.py	46726 bytes	0644
ccompiler.pyc	36882 bytes	0644
ccompiler.pyo	36741 bytes	0644
cmd.py	19270 bytes	0644
cmd.pyc	16804 bytes	0644
cmd.pyo	16804 bytes	0644
config.py	4134 bytes	0644
config.pyc	3565 bytes	0644
config.pyo	3565 bytes	0644
core.py	9019 bytes	0644
core.pyc	7536 bytes	0644
core.pyo	7536 bytes	0644
cygwinccompiler.py	17735 bytes	0644
cygwinccompiler.pyc	9825 bytes	0644
cygwinccompiler.pyo	9825 bytes	0644
debug.py	162 bytes	0644
debug.pyc	254 bytes	0644
debug.pyo	254 bytes	0644
dep_util.py	3509 bytes	0644
dep_util.pyc	3180 bytes	0644
dep_util.pyo	3180 bytes	0644
dir_util.py	7868 bytes	0644
dir_util.pyc	6786 bytes	0644
dir_util.pyo	6786 bytes	0644
dist.py	50049 bytes	0644
dist.pyc	39176 bytes	0644
dist.pyo	39176 bytes	0644
emxccompiler.py	11931 bytes	0644
emxccompiler.pyc	7467 bytes	0644
emxccompiler.pyo	7467 bytes	0644
errors.py	3494 bytes	0644
errors.pyc	6285 bytes	0644
errors.pyo	6285 bytes	0644
extension.py	10904 bytes	0644
extension.pyc	7412 bytes	0644
extension.pyo	7186 bytes	0644
fancy_getopt.py	17948 bytes	0644
fancy_getopt.pyc	11958 bytes	0644
fancy_getopt.pyo	11781 bytes	0644
file_util.py	8131 bytes	0644
file_util.pyc	6750 bytes	0644
file_util.pyo	6750 bytes	0644
filelist.py	12689 bytes	0644
filelist.pyc	10756 bytes	0644
filelist.pyo	10756 bytes	0644
log.py	1686 bytes	0644
log.pyc	2786 bytes	0644
log.pyo	2786 bytes	0644
msvc9compiler.py	31004 bytes	0644
msvc9compiler.pyc	21497 bytes	0644
msvc9compiler.pyo	21424 bytes	0644
msvccompiler.py	23637 bytes	0644
msvccompiler.pyc	17525 bytes	0644
msvccompiler.pyo	17525 bytes	0644
spawn.py	8648 bytes	0644
spawn.pyc	6427 bytes	0644
spawn.pyo	6427 bytes	0644
sysconfig.py	17707 bytes	0644
sysconfig.py.debug-build	17622 bytes	0644
sysconfig.pyc	13404 bytes	0644
sysconfig.pyo	13404 bytes	0644
text_file.py	12428 bytes	0644
text_file.pyc	9259 bytes	0644
text_file.pyo	9259 bytes	0644
unixccompiler.py	14222 bytes	0644
unixccompiler.py.distutils-rpath	13677 bytes	0644
unixccompiler.pyc	8229 bytes	0644
unixccompiler.pyo	8229 bytes	0644
util.py	18236 bytes	0644
util.pyc	14386 bytes	0644
util.pyo	14386 bytes	0644
version.py	11433 bytes	0644
version.pyc	7208 bytes	0644
version.pyo	7208 bytes	0644
versionpredicate.py	5095 bytes	0644
versionpredicate.pyc	5542 bytes	0644
versionpredicate.pyo	5542 bytes	0644

File Content: archive_util.py

File Content: `archive_util.py`