Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 23:21:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve byte-compilation in packaging to be independent of -O or -B.

Browse source 
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.
This commit is contained in:
Éric Araujo 2011-11-03 05:08:28 +01:00
parent dfd232898d
commit 880801501b
13 changed files with 168 additions and 179 deletions
Download patch file Download diff file Expand all files Collapse all files

47
Lib/packaging/command/build_py.py
View file

@ -2,7 +2,6 @@
import os
import imp
import sys
from glob import glob
from packaging import logger
@ -14,10 +13,14 @@
# marking public APIs
__all__ = ['build_py']
class build_py(Command, Mixin2to3):
description = "build pure Python modules (copy to build directory)"
# The options for controlling byte compilations are two independent sets;
# more info in install_lib or the reST docs
user_options = [
('build-lib=', 'd', "directory to build (copy) to"),
('compile', 'c', "compile .py to .pyc"),
@ -35,7 +38,8 @@ class build_py(Command, Mixin2to3):
]
boolean_options = ['compile', 'force']
negative_opt = {'no-compile' : 'compile'}
negative_opt = {'no-compile': 'compile'}
def initialize_options(self):
self.build_lib = None
@ -116,7 +120,7 @@ def run(self):
def get_data_files(self):
"""Generate list of '(package,src_dir,build_dir,filenames)' tuples.
Helper function for `finalize_options()`.
Helper function for finalize_options.
"""
data = []
if not self.packages:
@ -131,7 +135,7 @@ def get_data_files(self):
# Length of path to strip from found files
plen = 0
if src_dir:
plen = len(src_dir)+1
plen = len(src_dir) + 1
# Strip directory from globbed filenames
filenames = [
@ -143,7 +147,7 @@ def get_data_files(self):
def find_data_files(self, package, src_dir):
"""Return filenames for package's data files in 'src_dir'.
Helper function for `get_data_files()`.
Helper function for get_data_files.
"""
globs = (self.package_data.get('', [])
+ self.package_data.get(package, []))
@ -158,7 +162,7 @@ def find_data_files(self, package, src_dir):
def build_package_data(self):
"""Copy data files into build directory.
Helper function for `run()`.
Helper function for run.
"""
# FIXME add tests for this method
for package, src_dir, build_dir, filenames in self.data_files:
@ -168,16 +172,17 @@ def build_package_data(self):
self.mkpath(os.path.dirname(target))
outf, copied = self.copy_file(srcfile,
target, preserve_mode=False)
if copied and srcfile in self.distribution.convert_2to3.doctests:
doctests = self.distribution.convert_2to3_doctests
if copied and srcfile in doctests:
self._doctests_2to3.append(outf)
# XXX - this should be moved to the Distribution class as it is not
# only needed for build_py. It also has no dependencies on this class.
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)."""
distribution, where package 'package' should be found
(at least according to the 'package_dir' option, if any).
"""
path = package.split('.')
if self.package_dir is not None:
path.insert(0, self.package_dir)
@ -188,8 +193,7 @@ def get_package_dir(self, package):
return ''
def check_package(self, package, package_dir):
"""Helper function for `find_package_modules()` and `find_modules()'.
"""
"""Helper function for find_package_modules and find_modules."""
# 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
@ -209,8 +213,8 @@ def check_package(self, package, package_dir):
if os.path.isfile(init_py):
return init_py
else:
logger.warning(("package init file '%s' not found " +
"(or not a regular file)"), init_py)
logger.warning("package init file %r 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.
@ -218,7 +222,7 @@ def check_package(self, package, package_dir):
def check_module(self, module, module_file):
if not os.path.isfile(module_file):
logger.warning("file %s (for module %s) not found",
logger.warning("file %r (for module %r) not found",
module_file, module)
return False
else:
@ -239,7 +243,7 @@ def find_package_modules(self, package, package_dir):
module = os.path.splitext(os.path.basename(f))[0]
modules.append((package, module, f))
else:
logger.debug("excluding %s", setup_script)
logger.debug("excluding %r", setup_script)
return modules
def find_modules(self):
@ -331,7 +335,8 @@ def get_outputs(self, include_bytecode=True):
outputs.append(filename)
if include_bytecode:
if self.compile:
outputs.append(imp.cache_from_source(filename))
outputs.append(imp.cache_from_source(filename,
debug_override=True))
if self.optimize > 0:
outputs.append(imp.cache_from_source(filename,
debug_override=False))
@ -361,7 +366,6 @@ def build_module(self, module, module_file, package):
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
@ -370,7 +374,6 @@ def build_modules(self):
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
@ -390,11 +393,6 @@ def build_packages(self):
self.build_module(module, module_file, package)
def byte_compile(self, files):
if sys.dont_write_bytecode:
logger.warning('%s: byte-compiling is disabled, skipping.',
self.get_command_name())
return
from packaging.util import byte_compile # FIXME use compileall
prefix = self.build_lib
if prefix[-1] != os.sep:
@ -403,7 +401,6 @@ def byte_compile(self, files):
# XXX this code is essentially the same as the 'byte_compile()
# method of the "install_lib" command, except for the determination
# of the 'prefix' string. Hmmm.
if self.compile:
byte_compile(files, optimize=0,
force=self.force, prefix=prefix, dry_run=self.dry_run)