From a29e4f64c1dfeb4ca1cf9f4c9636cb4528b2fd8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Sat, 8 Oct 2011 04:09:15 +0200 Subject: [PATCH] Fix packaging byte-compilation to comply with PEP 3147 (#11254). MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I want to replace custom byte-compiling function with calls to compileall before 3.3b1, but in the short term it’s good to have this fixed. Adapted from the distutils patch by Jeff Ramnani. I tested with -B, -O and -OO; test_util and test_mixin2to3 fail in -O mode because lib2to3 doesn’t support it. --- Doc/library/packaging.util.rst | 9 ++++++--- Lib/packaging/tests/test_command_build_py.py | 9 ++++++--- Lib/packaging/tests/test_command_install_lib.py | 10 +++++++--- Lib/packaging/util.py | 8 ++++++-- Misc/NEWS | 2 +- 5 files changed, 26 insertions(+), 12 deletions(-) diff --git a/Doc/library/packaging.util.rst b/Doc/library/packaging.util.rst index 019f3e945c4..ae96d879df5 100644 --- a/Doc/library/packaging.util.rst +++ b/Doc/library/packaging.util.rst @@ -121,9 +121,12 @@ This module contains various helpers for the other modules. .. function:: byte_compile(py_files[, optimize=0, force=0, prefix=None, base_dir=None, verbose=1, dry_run=0, direct=None]) Byte-compile a collection of Python source files to either :file:`.pyc` or - :file:`.pyo` files in the same directory. *py_files* is a list of files to - compile; any files that don't end in :file:`.py` are silently skipped. - *optimize* must be one of the following: + :file:`.pyo` files in a :file:`__pycache__` subdirectory (see :pep:`3147`), + or to the same directory when using the distutils2 backport on Python + versions older than 3.2. + + *py_files* is a list of files to compile; any files that don't end in + :file:`.py` are silently skipped. *optimize* must be one of the following: * ``0`` - don't optimize (generate :file:`.pyc`) * ``1`` - normal optimization (like ``python -O``) diff --git a/Lib/packaging/tests/test_command_build_py.py b/Lib/packaging/tests/test_command_build_py.py index 4eeb34e1178..a978c916027 100644 --- a/Lib/packaging/tests/test_command_build_py.py +++ b/Lib/packaging/tests/test_command_build_py.py @@ -2,6 +2,7 @@ import os import sys +import imp from packaging.command.build_py import build_py from packaging.dist import Distribution @@ -58,13 +59,15 @@ class BuildPyTestCase(support.TempdirManager, self.assertEqual(len(cmd.get_outputs()), 3) pkgdest = os.path.join(destination, "pkg") files = os.listdir(pkgdest) + pycache_dir = os.path.join(pkgdest, "__pycache__") self.assertIn("__init__.py", files) self.assertIn("README.txt", files) - # XXX even with -O, distutils writes pyc, not pyo; bug? if sys.dont_write_bytecode: - self.assertNotIn("__init__.pyc", files) + self.assertFalse(os.path.exists(pycache_dir)) else: - self.assertIn("__init__.pyc", files) + # XXX even with -O, packaging writes pyc, not pyo; bug? + pyc_files = os.listdir(pycache_dir) + self.assertIn("__init__.%s.pyc" % imp.get_tag(), pyc_files) def test_empty_package_dir(self): # See SF 1668596/1720897. diff --git a/Lib/packaging/tests/test_command_install_lib.py b/Lib/packaging/tests/test_command_install_lib.py index 9118e688aee..3f3682241dd 100644 --- a/Lib/packaging/tests/test_command_install_lib.py +++ b/Lib/packaging/tests/test_command_install_lib.py @@ -1,6 +1,7 @@ """Tests for packaging.command.install_data.""" -import sys import os +import sys +import imp from packaging.tests import unittest, support from packaging.command.install_lib import install_lib @@ -36,6 +37,7 @@ class InstallLibTestCase(support.TempdirManager, @unittest.skipIf(sys.dont_write_bytecode, 'byte-compile disabled') def test_byte_compile(self): pkg_dir, dist = self.create_dist() + os.chdir(pkg_dir) cmd = install_lib(dist) cmd.compile = True cmd.optimize = 1 @@ -43,8 +45,10 @@ class InstallLibTestCase(support.TempdirManager, f = os.path.join(pkg_dir, 'foo.py') self.write_file(f, '# python file') cmd.byte_compile([f]) - self.assertTrue(os.path.exists(os.path.join(pkg_dir, 'foo.pyc'))) - self.assertTrue(os.path.exists(os.path.join(pkg_dir, 'foo.pyo'))) + pyc_file = imp.cache_from_source('foo.py') + pyo_file = imp.cache_from_source('foo.py', debug_override=False) + self.assertTrue(os.path.exists(pyc_file)) + self.assertTrue(os.path.exists(pyo_file)) def test_get_outputs(self): pkg_dir, dist = self.create_dist() diff --git a/Lib/packaging/util.py b/Lib/packaging/util.py index 89f5389be90..f8a805844e3 100644 --- a/Lib/packaging/util.py +++ b/Lib/packaging/util.py @@ -3,6 +3,7 @@ import os import re import csv +import imp import sys import errno import shutil @@ -296,7 +297,7 @@ def strtobool(val): def byte_compile(py_files, optimize=0, force=False, prefix=None, base_dir=None, verbose=0, dry_run=False, direct=None): """Byte-compile a collection of Python source files to either .pyc - or .pyo files in the same directory. + or .pyo files in a __pycache__ subdirectory. 'py_files' is a list of files to compile; any files that don't end in ".py" are silently skipped. 'optimize' must be one of the following: @@ -415,7 +416,10 @@ byte_compile(files, optimize=%r, force=%r, # Terminology from the py_compile module: # cfile - byte-compiled file # dfile - purported source filename (same as 'file' by default) - cfile = file + (__debug__ and "c" or "o") + if optimize >= 0: + cfile = imp.cache_from_source(file, debug_override=not optimize) + else: + cfile = imp.cache_from_source(file) dfile = file if prefix: if file[:len(prefix)] != prefix: diff --git a/Misc/NEWS b/Misc/NEWS index f185b415c4f..953671bf450 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -304,7 +304,7 @@ Library - Fix distutils.sysconfig.get_makefile_filename when Python was configured with different prefix and exec-prefix. -- Issue #11254: Teach distutils to compile .pyc and .pyo files in +- Issue #11254: Teach distutils and packaging to compile .pyc and .pyo files in PEP 3147-compliant __pycache__ directories. - Issue #7367: Fix pkgutil.walk_paths to skip directories whose