home *** CD-ROM | disk | FTP | other *** search
/ Freelog 33 / Freelog033.iso / Progr / Python-2.2.1.exe / BUILD_PY.PY < prev    next >
Encoding:
Python Source  |  2002-02-19  |  15.3 KB  |  402 lines
  1. """distutils.command.build_py
  2.  
  3. Implements the Distutils 'build_py' command."""
  4.  
  5. # created 1999/03/08, Greg Ward
  6.  
  7. __revision__ = "$Id: build_py.py,v 1.34.6.1 2002/02/19 14:15:40 mwh Exp $"
  8.  
  9. import sys, string, os
  10. from types import *
  11. from glob import glob
  12.  
  13. from distutils.core import Command
  14. from distutils.errors import *
  15. from distutils.util import convert_path
  16.  
  17.  
  18. class build_py (Command):
  19.  
  20.     description = "\"build\" pure Python modules (copy to build directory)"
  21.  
  22.     user_options = [
  23.         ('build-lib=', 'd', "directory to \"build\" (copy) to"),
  24.         ('compile', 'c', "compile .py to .pyc"),
  25.         ('no-compile', None, "don't compile .py files [default]"),
  26.         ('optimize=', 'O',
  27.          "also compile with optimization: -O1 for \"python -O\", "
  28.          "-O2 for \"python -OO\", and -O0 to disable [default: -O0]"),
  29.         ('force', 'f', "forcibly build everything (ignore file timestamps)"),
  30.         ]
  31.  
  32.     boolean_options = ['compile', 'force']
  33.     negative_opt = {'no-compile' : 'compile'}
  34.  
  35.  
  36.     def initialize_options (self):
  37.         self.build_lib = None
  38.         self.py_modules = None
  39.         self.package = None
  40.         self.package_dir = None
  41.         self.compile = 0
  42.         self.optimize = 0
  43.         self.force = None
  44.  
  45.     def finalize_options (self):
  46.         self.set_undefined_options('build',
  47.                                    ('build_lib', 'build_lib'),
  48.                                    ('force', 'force'))
  49.  
  50.         # Get the distribution options that are aliases for build_py
  51.         # options -- list of packages and list of modules.
  52.         self.packages = self.distribution.packages
  53.         self.py_modules = self.distribution.py_modules
  54.         self.package_dir = {}
  55.         if self.distribution.package_dir:
  56.             for name, path in self.distribution.package_dir.items():
  57.                 self.package_dir[name] = convert_path(path)
  58.  
  59.         # Ick, copied straight from install_lib.py (fancy_getopt needs a
  60.         # type system!  Hell, *everything* needs a type system!!!)
  61.         if type(self.optimize) is not IntType:
  62.             try:
  63.                 self.optimize = int(self.optimize)
  64.                 assert 0 <= self.optimize <= 2
  65.             except (ValueError, AssertionError):
  66.                 raise DistutilsOptionError, "optimize must be 0, 1, or 2"
  67.  
  68.     def run (self):
  69.  
  70.         # XXX copy_file by default preserves atime and mtime.  IMHO this is
  71.         # the right thing to do, but perhaps it should be an option -- in
  72.         # particular, a site administrator might want installed files to
  73.         # reflect the time of installation rather than the last
  74.         # modification time before the installed release.
  75.  
  76.         # XXX copy_file by default preserves mode, which appears to be the
  77.         # wrong thing to do: if a file is read-only in the working
  78.         # directory, we want it to be installed read/write so that the next
  79.         # installation of the same module distribution can overwrite it
  80.         # without problems.  (This might be a Unix-specific issue.)  Thus
  81.         # we turn off 'preserve_mode' when copying to the build directory,
  82.         # since the build directory is supposed to be exactly what the
  83.         # installation will look like (ie. we preserve mode when
  84.         # installing).
  85.  
  86.         # Two options control which modules will be installed: 'packages'
  87.         # and 'py_modules'.  The former lets us work with whole packages, not
  88.         # specifying individual modules at all; the latter is for
  89.         # specifying modules one-at-a-time.  Currently they are mutually
  90.         # exclusive: you can define one or the other (or neither), but not
  91.         # both.  It remains to be seen how limiting this is.
  92.  
  93.         # Dispose of the two "unusual" cases first: no pure Python modules
  94.         # at all (no problem, just return silently), and over-specified
  95.         # 'packages' and 'py_modules' options.
  96.  
  97.         if not self.py_modules and not self.packages:
  98.             return
  99.         if self.py_modules and self.packages:
  100.             raise DistutilsOptionError, \
  101.                   "build_py: supplying both 'packages' and 'py_modules' " + \
  102.                   "options is not allowed"
  103.  
  104.         # Now we're down to two cases: 'py_modules' only and 'packages' only.
  105.         if self.py_modules:
  106.             self.build_modules()
  107.         else:
  108.             self.build_packages()
  109.  
  110.         self.byte_compile(self.get_outputs(include_bytecode=0))
  111.  
  112.     # run ()
  113.  
  114.  
  115.     def get_package_dir (self, package):
  116.         """Return the directory, relative to the top of the source
  117.            distribution, where package 'package' should be found
  118.            (at least according to the 'package_dir' option, if any)."""
  119.  
  120.         path = string.split(package, '.')
  121.  
  122.         if not self.package_dir:
  123.             if path:
  124.                 return apply(os.path.join, path)
  125.             else:
  126.                 return ''
  127.         else:
  128.             tail = []
  129.             while path:
  130.                 try:
  131.                     pdir = self.package_dir[string.join(path, '.')]
  132.                 except KeyError:
  133.                     tail.insert(0, path[-1])
  134.                     del path[-1]
  135.                 else:
  136.                     tail.insert(0, pdir)
  137.                     return apply(os.path.join, tail)
  138.             else:
  139.                 # Oops, got all the way through 'path' without finding a
  140.                 # match in package_dir.  If package_dir defines a directory
  141.                 # for the root (nameless) package, then fallback on it;
  142.                 # otherwise, we might as well have not consulted
  143.                 # package_dir at all, as we just use the directory implied
  144.                 # by 'tail' (which should be the same as the original value
  145.                 # of 'path' at this point).
  146.                 pdir = self.package_dir.get('')
  147.                 if pdir is not None:
  148.                     tail.insert(0, pdir)
  149.  
  150.                 if tail:
  151.                     return apply(os.path.join, tail)
  152.                 else:
  153.                     return ''
  154.  
  155.     # get_package_dir ()
  156.  
  157.  
  158.     def check_package (self, package, package_dir):
  159.  
  160.         # Empty dir name means current directory, which we can probably
  161.         # assume exists.  Also, os.path.exists and isdir don't know about
  162.         # my "empty string means current dir" convention, so we have to
  163.         # circumvent them.
  164.         if package_dir != "":
  165.             if not os.path.exists(package_dir):
  166.                 raise DistutilsFileError, \
  167.                       "package directory '%s' does not exist" % package_dir
  168.             if not os.path.isdir(package_dir):
  169.                 raise DistutilsFileError, \
  170.                       ("supposed package directory '%s' exists, " +
  171.                        "but is not a directory") % package_dir
  172.  
  173.         # Require __init__.py for all but the "root package"
  174.         if package:
  175.             init_py = os.path.join(package_dir, "__init__.py")
  176.             if os.path.isfile(init_py):
  177.                 return init_py
  178.             else:
  179.                 self.warn(("package init file '%s' not found " +
  180.                            "(or not a regular file)") % init_py)
  181.  
  182.         # Either not in a package at all (__init__.py not expected), or
  183.         # __init__.py doesn't exist -- so don't return the filename.
  184.         return
  185.  
  186.     # check_package ()
  187.  
  188.  
  189.     def check_module (self, module, module_file):
  190.         if not os.path.isfile(module_file):
  191.             self.warn("file %s (for module %s) not found" %
  192.                       (module_file, module))
  193.             return 0
  194.         else:
  195.             return 1
  196.  
  197.     # check_module ()
  198.  
  199.  
  200.     def find_package_modules (self, package, package_dir):
  201.         self.check_package(package, package_dir)
  202.         module_files = glob(os.path.join(package_dir, "*.py"))
  203.         modules = []
  204.         setup_script = os.path.abspath(self.distribution.script_name)
  205.  
  206.         for f in module_files:
  207.             abs_f = os.path.abspath(f)
  208.             if abs_f != setup_script:
  209.                 module = os.path.splitext(os.path.basename(f))[0]
  210.                 modules.append((package, module, f))
  211.             else:
  212.                 self.debug_print("excluding %s" % setup_script)
  213.         return modules
  214.  
  215.  
  216.     def find_modules (self):
  217.         """Finds individually-specified Python modules, ie. those listed by
  218.         module name in 'self.py_modules'.  Returns a list of tuples (package,
  219.         module_base, filename): 'package' is a tuple of the path through
  220.         package-space to the module; 'module_base' is the bare (no
  221.         packages, no dots) module name, and 'filename' is the path to the
  222.         ".py" file (relative to the distribution root) that implements the
  223.         module.
  224.         """
  225.  
  226.         # Map package names to tuples of useful info about the package:
  227.         #    (package_dir, checked)
  228.         # package_dir - the directory where we'll find source files for
  229.         #   this package
  230.         # checked - true if we have checked that the package directory
  231.         #   is valid (exists, contains __init__.py, ... ?)
  232.         packages = {}
  233.  
  234.         # List of (package, module, filename) tuples to return
  235.         modules = []
  236.  
  237.         # We treat modules-in-packages almost the same as toplevel modules,
  238.         # just the "package" for a toplevel is empty (either an empty
  239.         # string or empty list, depending on context).  Differences:
  240.         #   - don't check for __init__.py in directory for empty package
  241.  
  242.         for module in self.py_modules:
  243.             path = string.split(module, '.')
  244.             package = string.join(path[0:-1], '.')
  245.             module_base = path[-1]
  246.  
  247.             try:
  248.                 (package_dir, checked) = packages[package]
  249.             except KeyError:
  250.                 package_dir = self.get_package_dir(package)
  251.                 checked = 0
  252.  
  253.             if not checked:
  254.                 init_py = self.check_package(package, package_dir)
  255.                 packages[package] = (package_dir, 1)
  256.                 if init_py:
  257.                     modules.append((package, "__init__", init_py))
  258.  
  259.             # XXX perhaps we should also check for just .pyc files
  260.             # (so greedy closed-source bastards can distribute Python
  261.             # modules too)
  262.             module_file = os.path.join(package_dir, module_base + ".py")
  263.             if not self.check_module(module, module_file):
  264.                 continue
  265.  
  266.             modules.append((package, module_base, module_file))
  267.  
  268.         return modules
  269.  
  270.     # find_modules ()
  271.  
  272.  
  273.     def find_all_modules (self):
  274.         """Compute the list of all modules that will be built, whether
  275.         they are specified one-module-at-a-time ('self.py_modules') or
  276.         by whole packages ('self.packages').  Return a list of tuples
  277.         (package, module, module_file), just like 'find_modules()' and
  278.         'find_package_modules()' do."""
  279.  
  280.         if self.py_modules:
  281.             modules = self.find_modules()
  282.         else:
  283.             modules = []
  284.             for package in self.packages:
  285.                 package_dir = self.get_package_dir(package)
  286.                 m = self.find_package_modules(package, package_dir)
  287.                 modules.extend(m)
  288.  
  289.         return modules
  290.  
  291.     # find_all_modules ()
  292.  
  293.  
  294.     def get_source_files (self):
  295.  
  296.         modules = self.find_all_modules()
  297.         filenames = []
  298.         for module in modules:
  299.             filenames.append(module[-1])
  300.  
  301.         return filenames
  302.  
  303.  
  304.     def get_module_outfile (self, build_dir, package, module):
  305.         outfile_path = [build_dir] + list(package) + [module + ".py"]
  306.         return apply(os.path.join, outfile_path)
  307.  
  308.  
  309.     def get_outputs (self, include_bytecode=1):
  310.         modules = self.find_all_modules()
  311.         outputs = []
  312.         for (package, module, module_file) in modules:
  313.             package = string.split(package, '.')
  314.             filename = self.get_module_outfile(self.build_lib, package, module)
  315.             outputs.append(filename)
  316.             if include_bytecode:
  317.                 if self.compile:
  318.                     outputs.append(filename + "c")
  319.                 if self.optimize > 0:
  320.                     outputs.append(filename + "o")
  321.  
  322.         return outputs
  323.  
  324.  
  325.     def build_module (self, module, module_file, package):
  326.         if type(package) is StringType:
  327.             package = string.split(package, '.')
  328.         elif type(package) not in (ListType, TupleType):
  329.             raise TypeError, \
  330.                   "'package' must be a string (dot-separated), list, or tuple"
  331.  
  332.         # Now put the module source file into the "build" area -- this is
  333.         # easy, we just copy it somewhere under self.build_lib (the build
  334.         # directory for Python source).
  335.         outfile = self.get_module_outfile(self.build_lib, package, module)
  336.         dir = os.path.dirname(outfile)
  337.         self.mkpath(dir)
  338.         return self.copy_file(module_file, outfile, preserve_mode=0)
  339.  
  340.  
  341.     def build_modules (self):
  342.  
  343.         modules = self.find_modules()
  344.         for (package, module, module_file) in modules:
  345.  
  346.             # Now "build" the module -- ie. copy the source file to
  347.             # self.build_lib (the build directory for Python source).
  348.             # (Actually, it gets copied to the directory for this package
  349.             # under self.build_lib.)
  350.             self.build_module(module, module_file, package)
  351.  
  352.     # build_modules ()
  353.  
  354.  
  355.     def build_packages (self):
  356.  
  357.         for package in self.packages:
  358.  
  359.             # Get list of (package, module, module_file) tuples based on
  360.             # scanning the package directory.  'package' is only included
  361.             # in the tuple so that 'find_modules()' and
  362.             # 'find_package_tuples()' have a consistent interface; it's
  363.             # ignored here (apart from a sanity check).  Also, 'module' is
  364.             # the *unqualified* module name (ie. no dots, no package -- we
  365.             # already know its package!), and 'module_file' is the path to
  366.             # the .py file, relative to the current directory
  367.             # (ie. including 'package_dir').
  368.             package_dir = self.get_package_dir(package)
  369.             modules = self.find_package_modules(package, package_dir)
  370.  
  371.             # Now loop over the modules we found, "building" each one (just
  372.             # copy it to self.build_lib).
  373.             for (package_, module, module_file) in modules:
  374.                 assert package == package_
  375.                 self.build_module(module, module_file, package)
  376.  
  377.     # build_packages ()
  378.  
  379.  
  380.     def byte_compile (self, files):
  381.         from distutils.util import byte_compile
  382.         prefix = self.build_lib
  383.         if prefix[-1] != os.sep:
  384.             prefix = prefix + os.sep
  385.  
  386.         # XXX this code is essentially the same as the 'byte_compile()
  387.         # method of the "install_lib" command, except for the determination
  388.         # of the 'prefix' string.  Hmmm.
  389.  
  390.         if self.compile:
  391.             byte_compile(files, optimize=0,
  392.                          force=self.force,
  393.                          prefix=prefix,
  394.                          verbose=self.verbose, dry_run=self.dry_run)
  395.         if self.optimize > 0:
  396.             byte_compile(files, optimize=self.optimize,
  397.                          force=self.force,
  398.                          prefix=prefix,
  399.                          verbose=self.verbose, dry_run=self.dry_run)
  400.  
  401. # class build_py
  402.