[Python-checkins] python/nondist/sandbox/setuptools/setuptools/command bdist_egg.py, NONE, 1.1 __init__.py, 1.2, 1.3

[pje at users.sourceforge.net]

Update of /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/command
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8059/setuptools/command

Modified Files:
	__init__.py 
Added Files:
	bdist_egg.py 
Log Message:
Add 'bdist_egg' command/format to allow creating "Python Eggs" (see
http://peak.telecommunity.com/DevCenter/PythonEggs for details).  This
version only supports pure libraries and does not support user-defined
metadata.  But it's sufficient to make .egg files that can be placed on
PYTHONPATH and used.


--- NEW FILE: bdist_egg.py ---
"""setuptools.command.bdist_egg

Build .egg distributions"""

# This module should be kept compatible with Python 2.1

import os
from distutils.core import Command
from distutils.util import get_platform
from distutils.dir_util import create_tree, remove_tree, ensure_relative,mkpath
from distutils.errors import *
from distutils import log

class bdist_egg(Command):

    description = "create an \"egg\" distribution"

    user_options = [('bdist-dir=', 'd',
                     "temporary directory for creating the distribution"),
                    ('plat-name=', 'p',
                     "platform name to embed in generated filenames "
                     "(default: %s)" % get_platform()),
                    ('keep-temp', 'k',
                     "keep the pseudo-installation tree around after " +
                     "creating the distribution archive"),
                    ('dist-dir=', 'd',
                     "directory to put final built distributions in"),
                    ('skip-build', None,
                     "skip rebuilding everything (for testing/debugging)"),
                    ('relative', None,
                     "build the archive using relative paths"
                     "(default: false)"),
                   ]

    boolean_options = ['keep-temp', 'skip-build', 'relative']


    def initialize_options (self):
        self.bdist_dir = None
        self.plat_name = None
        self.keep_temp = 0
        self.dist_dir = None
        self.skip_build = 0
        self.relative = 0
        
    # initialize_options()


    def finalize_options (self):

        if self.bdist_dir is None:
            bdist_base = self.get_finalized_command('bdist').bdist_base
            self.bdist_dir = os.path.join(bdist_base, 'egg')

        self.set_undefined_options('bdist',
                                   ('dist_dir', 'dist_dir'),
                                   ('plat_name', 'plat_name'))

    # finalize_options()


    def run (self):

        if not self.skip_build:
            self.run_command('build')

        install = self.reinitialize_command('install_lib', reinit_subcommands=1)
        install.install_dir = self.bdist_dir
        install.skip_build = self.skip_build
        install.warn_dir = 0

        log.info("installing to %s" % self.bdist_dir)
        self.run_command('install_lib')

        # And make an archive relative to the root of the
        # pseudo-installation tree.
        archive_basename = "%s-%s" % (self.distribution.get_fullname(),
                                      self.plat_name)

        # OS/2 objects to any ":" characters in a filename (such as when
        # a timestamp is used in a version) so change them to hyphens.
        if os.name == "os2":
            archive_basename = archive_basename.replace(":", "-")

        pseudoinstall_root = os.path.join(self.dist_dir, archive_basename)
        archive_root = self.bdist_dir

        # Make the EGG-INFO directory
        log.info("creating EGG-INFO files")
        egg_info = os.path.join(archive_root,'EGG-INFO')
        self.mkpath(egg_info)

        if not self.dry_run:
            self.distribution.metadata.write_pkg_info(egg_info)

        # Make the archive
        make_zipfile(pseudoinstall_root+'.egg',
                          archive_root, verbose=self.verbose,
                          dry_run=self.dry_run)

        if not self.keep_temp:
            remove_tree(self.bdist_dir, dry_run=self.dry_run)

    # run()

# class bdist_egg



def make_zipfile (zip_filename, 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_dir' + ".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.
    """
    import zipfile
        
    mkpath(os.path.dirname(zip_filename), dry_run=dry_run)

    # If zipfile module is not available, try spawning an external
    # 'zip' command.
    log.info("creating '%s' and adding '%s' to it",
             zip_filename, base_dir)

    def visit (z, dirname, names):
        for name in names:
            path = os.path.normpath(os.path.join(dirname, name))
            if os.path.isfile(path):
                p = path[len(base_dir)+1:]
                z.write(path, p)
                log.info("adding '%s'" % p)

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

        os.path.walk(base_dir, visit, z)
        z.close()

    return zip_filename

# make_zipfile ()


Index: __init__.py
===================================================================
RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/command/__init__.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- __init__.py	5 Apr 2004 20:21:53 -0000	1.2
+++ __init__.py	21 Mar 2005 19:50:46 -0000	1.3
@@ -1,6 +1,6 @@
 import distutils.command
 
-__all__ = ['test', 'depends']
+__all__ = ['test', 'depends', 'bdist_egg']
 
 
 # Make our commands available as though they were part of the distutils
@@ -9,3 +9,11 @@
 distutils.command.__all__.extend(
     [cmd for cmd in __all__ if cmd not in distutils.command.__all__]
     )
+
+from distutils.command.bdist import bdist
+
+if 'egg' not in bdist.format_commands:
+    bdist.format_command['egg'] = ('bdist_egg', "Python .egg file")
+    bdist.format_commands.append('egg')
+
+del bdist