mirror of
https://github.com/python/cpython.git
synced 2025-11-04 11:49:12 +00:00
8bbba17d38
attempt to verify the bold assertions in the documentation):
* entries for the "root package" in 'package_dir' didn't work --
fixed by improving the fall-through code in 'get_package_dir()'
* __init__.py files weren't installed when modules-in-packages
were listed individually (ie. in 'py_modules' in the setup script);
fixed by making 'check_package()' return the name of the __init__
file if it exists, and making 'find_modules()' add an entry to
the module list for __init__ if applicable
352 lines
13 KiB
Python
352 lines
13 KiB
Python
"""distutils.command.build_py
|
|
|
|
Implements the Distutils 'build_py' command."""
|
|
|
|
# created 1999/03/08, Greg Ward
|
|
|
|
__revision__ = "$Id$"
|
|
|
|
import sys, string, os
|
|
from types import *
|
|
from glob import glob
|
|
|
|
from distutils.core import Command
|
|
from distutils.errors import *
|
|
|
|
|
|
class build_py (Command):
|
|
|
|
description = "\"build\" pure Python modules (copy to build directory)"
|
|
|
|
user_options = [
|
|
('build-lib=', 'd', "directory to \"build\" (copy) to"),
|
|
('force', 'f', "forcibly build everything (ignore file timestamps"),
|
|
]
|
|
|
|
|
|
def initialize_options (self):
|
|
self.build_lib = None
|
|
self.modules = None
|
|
self.package = None
|
|
self.package_dir = None
|
|
self.force = None
|
|
|
|
def finalize_options (self):
|
|
self.set_undefined_options ('build',
|
|
('build_lib', 'build_lib'),
|
|
('force', 'force'))
|
|
|
|
# Get the distribution options that are aliases for build_py
|
|
# options -- list of packages and list of modules.
|
|
self.packages = self.distribution.packages
|
|
self.modules = self.distribution.py_modules
|
|
self.package_dir = self.distribution.package_dir
|
|
|
|
|
|
def run (self):
|
|
|
|
# XXX copy_file by default preserves atime and mtime. IMHO this is
|
|
# the right thing to do, but perhaps it should be an option -- in
|
|
# particular, a site administrator might want installed files to
|
|
# reflect the time of installation rather than the last
|
|
# modification time before the installed release.
|
|
|
|
# XXX copy_file by default preserves mode, which appears to be the
|
|
# wrong thing to do: if a file is read-only in the working
|
|
# directory, we want it to be installed read/write so that the next
|
|
# installation of the same module distribution can overwrite it
|
|
# without problems. (This might be a Unix-specific issue.) Thus
|
|
# we turn off 'preserve_mode' when copying to the build directory,
|
|
# since the build directory is supposed to be exactly what the
|
|
# installation will look like (ie. we preserve mode when
|
|
# installing).
|
|
|
|
# Two options control which modules will be installed: 'packages'
|
|
# and 'modules'. The former lets us work with whole packages, not
|
|
# specifying individual modules at all; the latter is for
|
|
# specifying modules one-at-a-time. Currently they are mutually
|
|
# exclusive: you can define one or the other (or neither), but not
|
|
# both. It remains to be seen how limiting this is.
|
|
|
|
# Dispose of the two "unusual" cases first: no pure Python modules
|
|
# at all (no problem, just return silently), and over-specified
|
|
# 'packages' and 'modules' options.
|
|
|
|
if not self.modules and not self.packages:
|
|
return
|
|
if self.modules and self.packages:
|
|
raise DistutilsOptionError, \
|
|
"build_py: supplying both 'packages' and 'modules' " + \
|
|
"options is not allowed"
|
|
|
|
# Now we're down to two cases: 'modules' only and 'packages' only.
|
|
if self.modules:
|
|
self.build_modules ()
|
|
else:
|
|
self.build_packages ()
|
|
|
|
# run ()
|
|
|
|
|
|
def get_package_dir (self, package):
|
|
"""Return the directory, relative to the top of the source
|
|
distribution, where package 'package' should be found
|
|
(at least according to the 'package_dir' option, if any)."""
|
|
|
|
if type (package) is StringType:
|
|
path = string.split (package, '.')
|
|
elif type (package) in (TupleType, ListType):
|
|
path = list (package)
|
|
else:
|
|
raise TypeError, "'package' must be a string, list, or tuple"
|
|
|
|
if not self.package_dir:
|
|
if path:
|
|
return apply (os.path.join, path)
|
|
else:
|
|
return ''
|
|
else:
|
|
tail = []
|
|
while path:
|
|
try:
|
|
pdir = self.package_dir[string.join (path, '.')]
|
|
except KeyError:
|
|
tail.insert (0, path[-1])
|
|
del path[-1]
|
|
else:
|
|
tail.insert (0, pdir)
|
|
return apply (os.path.join, tail)
|
|
else:
|
|
# Oops, got all the way through 'path' without finding a
|
|
# match in package_dir. If package_dir defines a directory
|
|
# for the root (nameless) package, then fallback on it;
|
|
# otherwise, we might as well have not consulted
|
|
# package_dir at all, as we just use the directory implied
|
|
# by 'tail' (which should be the same as the original value
|
|
# of 'path' at this point).
|
|
pdir = self.package_dir.get('')
|
|
if pdir is not None:
|
|
tail.insert(0, pdir)
|
|
|
|
if tail:
|
|
return apply (os.path.join, tail)
|
|
else:
|
|
return ''
|
|
|
|
# get_package_dir ()
|
|
|
|
|
|
def check_package (self, package, package_dir):
|
|
|
|
# Empty dir name means current directory, which we can probably
|
|
# assume exists. Also, os.path.exists and isdir don't know about
|
|
# my "empty string means current dir" convention, so we have to
|
|
# circumvent them.
|
|
if package_dir != "":
|
|
if not os.path.exists (package_dir):
|
|
raise DistutilsFileError, \
|
|
"package directory '%s' does not exist" % package_dir
|
|
if not os.path.isdir (package_dir):
|
|
raise DistutilsFileError, \
|
|
("supposed package directory '%s' exists, " +
|
|
"but is not a directory") % package_dir
|
|
|
|
# Require __init__.py for all but the "root package"
|
|
if package:
|
|
init_py = os.path.join (package_dir, "__init__.py")
|
|
if os.path.isfile (init_py):
|
|
return init_py
|
|
else:
|
|
self.warn (("package init file '%s' not found " +
|
|
"(or not a regular file)") % init_py)
|
|
|
|
# Either not in a package at all (__init__.py not expected), or
|
|
# __init__.py doesn't exist -- so don't return the filename.
|
|
return
|
|
|
|
# check_package ()
|
|
|
|
|
|
def check_module (self, module, module_file):
|
|
if not os.path.isfile (module_file):
|
|
self.warn ("file %s (for module %s) not found" %
|
|
(module_file, module))
|
|
return 0
|
|
else:
|
|
return 1
|
|
|
|
# check_module ()
|
|
|
|
|
|
def find_package_modules (self, package, package_dir):
|
|
self.check_package (package, package_dir)
|
|
module_files = glob (os.path.join (package_dir, "*.py"))
|
|
modules = []
|
|
setup_script = os.path.abspath (sys.argv[0])
|
|
|
|
for f in module_files:
|
|
abs_f = os.path.abspath (f)
|
|
if abs_f != setup_script:
|
|
module = os.path.splitext (os.path.basename (f))[0]
|
|
modules.append ((package, module, f))
|
|
return modules
|
|
|
|
|
|
def find_modules (self):
|
|
"""Finds individually-specified Python modules, ie. those listed by
|
|
module name in 'self.modules'. Returns a list of tuples (package,
|
|
module_base, filename): 'package' is a tuple of the path through
|
|
package-space to the module; 'module_base' is the bare (no
|
|
packages, no dots) module name, and 'filename' is the path to the
|
|
".py" file (relative to the distribution root) that implements the
|
|
module.
|
|
"""
|
|
|
|
# Map package names to tuples of useful info about the package:
|
|
# (package_dir, checked)
|
|
# package_dir - the directory where we'll find source files for
|
|
# this package
|
|
# checked - true if we have checked that the package directory
|
|
# is valid (exists, contains __init__.py, ... ?)
|
|
packages = {}
|
|
|
|
# List of (package, module, filename) tuples to return
|
|
modules = []
|
|
|
|
# We treat modules-in-packages almost the same as toplevel modules,
|
|
# just the "package" for a toplevel is empty (either an empty
|
|
# string or empty list, depending on context). Differences:
|
|
# - don't check for __init__.py in directory for empty package
|
|
|
|
for module in self.modules:
|
|
path = string.split (module, '.')
|
|
package = tuple (path[0:-1])
|
|
module_base = path[-1]
|
|
|
|
try:
|
|
(package_dir, checked) = packages[package]
|
|
except KeyError:
|
|
package_dir = self.get_package_dir (package)
|
|
checked = 0
|
|
|
|
if not checked:
|
|
init_py = self.check_package (package, package_dir)
|
|
packages[package] = (package_dir, 1)
|
|
if init_py:
|
|
modules.append((package, "__init__", init_py))
|
|
|
|
# XXX perhaps we should also check for just .pyc files
|
|
# (so greedy closed-source bastards can distribute Python
|
|
# modules too)
|
|
module_file = os.path.join (package_dir, module_base + ".py")
|
|
if not self.check_module (module, module_file):
|
|
continue
|
|
|
|
modules.append ((package, module_base, module_file))
|
|
|
|
return modules
|
|
|
|
# find_modules ()
|
|
|
|
|
|
def find_all_modules (self):
|
|
"""Compute the list of all modules that will be built, whether
|
|
they are specified one-module-at-a-time ('self.modules') or
|
|
by whole packages ('self.packages'). Return a list of tuples
|
|
(package, module, module_file), just like 'find_modules()' and
|
|
'find_package_modules()' do."""
|
|
|
|
if self.modules:
|
|
modules = self.find_modules ()
|
|
else:
|
|
modules = []
|
|
for package in self.packages:
|
|
package_dir = self.get_package_dir (package)
|
|
m = self.find_package_modules (package, package_dir)
|
|
modules.extend (m)
|
|
|
|
return modules
|
|
|
|
# find_all_modules ()
|
|
|
|
|
|
def get_source_files (self):
|
|
|
|
modules = self.find_all_modules ()
|
|
filenames = []
|
|
for module in modules:
|
|
filenames.append (module[-1])
|
|
|
|
return filenames
|
|
|
|
|
|
def get_module_outfile (self, build_dir, package, module):
|
|
outfile_path = [build_dir] + list(package) + [module + ".py"]
|
|
return apply (os.path.join, outfile_path)
|
|
|
|
|
|
def get_outputs (self):
|
|
modules = self.find_all_modules ()
|
|
outputs = []
|
|
for (package, module, module_file) in modules:
|
|
package = string.split (package, '.')
|
|
outputs.append (self.get_module_outfile (self.build_lib,
|
|
package, module))
|
|
return outputs
|
|
|
|
|
|
def build_module (self, module, module_file, package):
|
|
if type (package) is StringType:
|
|
package = string.split (package, '.')
|
|
elif type (package) not in (ListType, TupleType):
|
|
raise TypeError, \
|
|
"'package' must be a string (dot-separated), list, or tuple"
|
|
|
|
# Now put the module source file into the "build" area -- this is
|
|
# easy, we just copy it somewhere under self.build_lib (the build
|
|
# directory for Python source).
|
|
outfile = self.get_module_outfile (self.build_lib, package, module)
|
|
dir = os.path.dirname (outfile)
|
|
self.mkpath (dir)
|
|
self.copy_file (module_file, outfile, preserve_mode=0)
|
|
|
|
|
|
def build_modules (self):
|
|
|
|
modules = self.find_modules()
|
|
for (package, module, module_file) in modules:
|
|
|
|
# Now "build" the module -- ie. copy the source file to
|
|
# self.build_lib (the build directory for Python source).
|
|
# (Actually, it gets copied to the directory for this package
|
|
# under self.build_lib.)
|
|
self.build_module (module, module_file, package)
|
|
|
|
# build_modules ()
|
|
|
|
|
|
def build_packages (self):
|
|
|
|
for package in self.packages:
|
|
|
|
# Get list of (package, module, module_file) tuples based on
|
|
# scanning the package directory. 'package' is only included
|
|
# in the tuple so that 'find_modules()' and
|
|
# 'find_package_tuples()' have a consistent interface; it's
|
|
# ignored here (apart from a sanity check). Also, 'module' is
|
|
# the *unqualified* module name (ie. no dots, no package -- we
|
|
# already know its package!), and 'module_file' is the path to
|
|
# the .py file, relative to the current directory
|
|
# (ie. including 'package_dir').
|
|
package_dir = self.get_package_dir (package)
|
|
modules = self.find_package_modules (package, package_dir)
|
|
|
|
# Now loop over the modules we found, "building" each one (just
|
|
# copy it to self.build_lib).
|
|
for (package_, module, module_file) in modules:
|
|
assert package == package_
|
|
self.build_module (module, module_file, package)
|
|
|
|
# build_packages ()
|
|
|
|
# class build_py
|