mirror of
https://github.com/python/cpython.git
synced 2025-07-18 16:55:20 +00:00
880801501b
The code I fixed to comply with PEP 3147 still had one bug: When run under python -O, some paths for pyc files would be pyo, because I called imp.cache_from_source without explicit debug_override argument in some places, and under -O that would return .pyo (this is well explained in the imp docs). Now all code (util.byte_compile, build_py, install_lib) can create .pyo files according to options given by users, without interference from the calling Python’s own optimize mode. On a related topic, I also removed the code that prevented byte compilation under python -B. The rationale is that packaging gives control over the creation of pyc files to the user with its own explicit option, and the behavior should not be changed if the calling Python happens to run with -B for whatever reason. I will argue that this is a bug fix and ask to be allowed to backport this change to distutils. Finally, I moved one nugget of information about the --compile and --optimize options from the source into the doc. It clears up a misunderstanding that I (and maybe other people) had.
208 lines
7.8 KiB
Python
208 lines
7.8 KiB
Python
"""Install all modules (extensions and pure Python)."""
|
|
|
|
import os
|
|
import imp
|
|
import logging
|
|
|
|
from packaging import logger
|
|
from packaging.command.cmd import Command
|
|
from packaging.errors import PackagingOptionError
|
|
|
|
|
|
# Extension for Python source files.
|
|
# XXX dead code? most of the codebase checks for literal '.py'
|
|
if hasattr(os, 'extsep'):
|
|
PYTHON_SOURCE_EXTENSION = os.extsep + "py"
|
|
else:
|
|
PYTHON_SOURCE_EXTENSION = ".py"
|
|
|
|
|
|
class install_lib(Command):
|
|
|
|
description = "install all modules (extensions and pure Python)"
|
|
|
|
# The options for controlling byte compilations are two independent sets:
|
|
# 'compile' is strictly boolean, and only decides whether to
|
|
# generate .pyc files. 'optimize' is three-way (0, 1, or 2), and
|
|
# decides both whether to generate .pyo files and what level of
|
|
# optimization to use.
|
|
|
|
user_options = [
|
|
('install-dir=', 'd', "directory to install to"),
|
|
('build-dir=', 'b', "build directory (where to install from)"),
|
|
('force', 'f', "force installation (overwrite existing files)"),
|
|
('compile', 'c', "compile .py to .pyc [default]"),
|
|
('no-compile', None, "don't compile .py files"),
|
|
('optimize=', 'O',
|
|
"also compile with optimization: -O1 for \"python -O\", "
|
|
"-O2 for \"python -OO\", and -O0 to disable [default: -O0]"),
|
|
('skip-build', None, "skip the build steps"),
|
|
]
|
|
|
|
boolean_options = ['force', 'compile', 'skip-build']
|
|
|
|
negative_opt = {'no-compile': 'compile'}
|
|
|
|
def initialize_options(self):
|
|
# let the 'install_dist' command dictate our installation directory
|
|
self.install_dir = None
|
|
self.build_dir = None
|
|
self.force = False
|
|
self.compile = None
|
|
self.optimize = None
|
|
self.skip_build = None
|
|
|
|
def finalize_options(self):
|
|
# Get all the information we need to install pure Python modules
|
|
# from the umbrella 'install_dist' command -- build (source) directory,
|
|
# install (target) directory, and whether to compile .py files.
|
|
self.set_undefined_options('install_dist',
|
|
('build_lib', 'build_dir'),
|
|
('install_lib', 'install_dir'),
|
|
'force', 'compile', 'optimize',
|
|
'skip_build')
|
|
|
|
if self.compile is None:
|
|
self.compile = True
|
|
if self.optimize is None:
|
|
self.optimize = 0
|
|
|
|
if not isinstance(self.optimize, int):
|
|
try:
|
|
self.optimize = int(self.optimize)
|
|
if self.optimize not in (0, 1, 2):
|
|
raise AssertionError
|
|
except (ValueError, AssertionError):
|
|
raise PackagingOptionError("optimize must be 0, 1, or 2")
|
|
|
|
def run(self):
|
|
# Make sure we have built everything we need first
|
|
self.build()
|
|
|
|
# Install everything: simply dump the entire contents of the build
|
|
# directory to the installation directory (that's the beauty of
|
|
# having a build directory!)
|
|
outfiles = self.install()
|
|
|
|
# (Optionally) compile .py to .pyc
|
|
if outfiles is not None and self.distribution.has_pure_modules():
|
|
self.byte_compile(outfiles)
|
|
|
|
# -- Top-level worker functions ------------------------------------
|
|
# (called from 'run()')
|
|
|
|
def build(self):
|
|
if not self.skip_build:
|
|
if self.distribution.has_pure_modules():
|
|
self.run_command('build_py')
|
|
if self.distribution.has_ext_modules():
|
|
self.run_command('build_ext')
|
|
|
|
def install(self):
|
|
if os.path.isdir(self.build_dir):
|
|
outfiles = self.copy_tree(self.build_dir, self.install_dir)
|
|
else:
|
|
logger.warning(
|
|
'%s: %r does not exist -- no Python modules to install',
|
|
self.get_command_name(), self.build_dir)
|
|
return
|
|
return outfiles
|
|
|
|
def byte_compile(self, files):
|
|
from packaging.util import byte_compile # FIXME use compileall
|
|
|
|
# Get the "--root" directory supplied to the "install_dist" command,
|
|
# and use it as a prefix to strip off the purported filename
|
|
# encoded in bytecode files. This is far from complete, but it
|
|
# should at least generate usable bytecode in RPM distributions.
|
|
install_root = self.get_finalized_command('install_dist').root
|
|
|
|
# Temporary kludge until we remove the verbose arguments and use
|
|
# logging everywhere
|
|
verbose = logger.getEffectiveLevel() >= logging.DEBUG
|
|
|
|
if self.compile:
|
|
byte_compile(files, optimize=0,
|
|
force=self.force, prefix=install_root,
|
|
verbose=verbose, dry_run=self.dry_run)
|
|
if self.optimize > 0:
|
|
byte_compile(files, optimize=self.optimize,
|
|
force=self.force, prefix=install_root,
|
|
verbose=verbose, dry_run=self.dry_run)
|
|
|
|
# -- Utility methods -----------------------------------------------
|
|
|
|
def _mutate_outputs(self, has_any, build_cmd, cmd_option, output_dir):
|
|
if not has_any:
|
|
return []
|
|
|
|
build_cmd = self.get_finalized_command(build_cmd)
|
|
build_files = build_cmd.get_outputs()
|
|
build_dir = getattr(build_cmd, cmd_option)
|
|
|
|
prefix_len = len(build_dir) + len(os.sep)
|
|
outputs = []
|
|
for file in build_files:
|
|
outputs.append(os.path.join(output_dir, file[prefix_len:]))
|
|
|
|
return outputs
|
|
|
|
def _bytecode_filenames(self, py_filenames):
|
|
bytecode_files = []
|
|
for py_file in py_filenames:
|
|
# Since build_py handles package data installation, the
|
|
# list of outputs can contain more than just .py files.
|
|
# Make sure we only report bytecode for the .py files.
|
|
ext = os.path.splitext(os.path.normcase(py_file))[1]
|
|
if ext != PYTHON_SOURCE_EXTENSION:
|
|
continue
|
|
if self.compile:
|
|
bytecode_files.append(imp.cache_from_source(
|
|
py_file, debug_override=True))
|
|
if self.optimize > 0:
|
|
bytecode_files.append(imp.cache_from_source(
|
|
py_file, debug_override=False))
|
|
|
|
return bytecode_files
|
|
|
|
# -- External interface --------------------------------------------
|
|
# (called by outsiders)
|
|
|
|
def get_outputs(self):
|
|
"""Return the list of files that would be installed if this command
|
|
were actually run. Not affected by the "dry-run" flag or whether
|
|
modules have actually been built yet.
|
|
"""
|
|
pure_outputs = \
|
|
self._mutate_outputs(self.distribution.has_pure_modules(),
|
|
'build_py', 'build_lib',
|
|
self.install_dir)
|
|
if self.compile:
|
|
bytecode_outputs = self._bytecode_filenames(pure_outputs)
|
|
else:
|
|
bytecode_outputs = []
|
|
|
|
ext_outputs = \
|
|
self._mutate_outputs(self.distribution.has_ext_modules(),
|
|
'build_ext', 'build_lib',
|
|
self.install_dir)
|
|
|
|
return pure_outputs + bytecode_outputs + ext_outputs
|
|
|
|
def get_inputs(self):
|
|
"""Get the list of files that are input to this command, ie. the
|
|
files that get installed as they are named in the build tree.
|
|
The files in this list correspond one-to-one to the output
|
|
filenames returned by 'get_outputs()'.
|
|
"""
|
|
inputs = []
|
|
|
|
if self.distribution.has_pure_modules():
|
|
build_py = self.get_finalized_command('build_py')
|
|
inputs.extend(build_py.get_outputs())
|
|
|
|
if self.distribution.has_ext_modules():
|
|
build_ext = self.get_finalized_command('build_ext')
|
|
inputs.extend(build_ext.get_outputs())
|
|
|
|
return inputs
|