mirror of
https://github.com/python/cpython.git
synced 2024-12-18 14:24:33 +08:00
42aa93b8ff
Python now supports checking bytecode cache up-to-dateness with a hash of the source contents rather than volatile source metadata. See the PEP for details. While a fairly straightforward idea, quite a lot of code had to be modified due to the pervasiveness of pyc implementation details in the codebase. Changes in this commit include: - The core changes to importlib to understand how to read, validate, and regenerate hash-based pycs. - Support for generating hash-based pycs in py_compile and compileall. - Modifications to our siphash implementation to support passing a custom key. We then expose it to importlib through _imp. - Updates to all places in the interpreter, standard library, and tests that manually generate or parse pyc files to grok the new format. - Support in the interpreter command line code for long options like --check-hash-based-pycs. - Tests and documentation for all of the above.
805 lines
30 KiB
Python
805 lines
30 KiB
Python
import sys
|
|
import os
|
|
import marshal
|
|
import importlib
|
|
import importlib.util
|
|
import struct
|
|
import time
|
|
import unittest
|
|
|
|
from test import support
|
|
|
|
from zipfile import ZipFile, ZipInfo, ZIP_STORED, ZIP_DEFLATED
|
|
|
|
import zipimport
|
|
import linecache
|
|
import doctest
|
|
import inspect
|
|
import io
|
|
from traceback import extract_tb, extract_stack, print_tb
|
|
try:
|
|
import zlib
|
|
except ImportError:
|
|
zlib = None
|
|
|
|
test_src = """\
|
|
def get_name():
|
|
return __name__
|
|
def get_file():
|
|
return __file__
|
|
"""
|
|
test_co = compile(test_src, "<???>", "exec")
|
|
raise_src = 'def do_raise(): raise TypeError\n'
|
|
|
|
def make_pyc(co, mtime, size):
|
|
data = marshal.dumps(co)
|
|
if type(mtime) is type(0.0):
|
|
# Mac mtimes need a bit of special casing
|
|
if mtime < 0x7fffffff:
|
|
mtime = int(mtime)
|
|
else:
|
|
mtime = int(-0x100000000 + int(mtime))
|
|
pyc = (importlib.util.MAGIC_NUMBER +
|
|
struct.pack("<iii", 0, int(mtime), size & 0xFFFFFFFF) + data)
|
|
return pyc
|
|
|
|
def module_path_to_dotted_name(path):
|
|
return path.replace(os.sep, '.')
|
|
|
|
NOW = time.time()
|
|
test_pyc = make_pyc(test_co, NOW, len(test_src))
|
|
|
|
|
|
TESTMOD = "ziptestmodule"
|
|
TESTPACK = "ziptestpackage"
|
|
TESTPACK2 = "ziptestpackage2"
|
|
TEMP_DIR = os.path.abspath("junk95142")
|
|
TEMP_ZIP = os.path.abspath("junk95142.zip")
|
|
|
|
pyc_file = importlib.util.cache_from_source(TESTMOD + '.py')
|
|
pyc_ext = '.pyc'
|
|
|
|
|
|
class ImportHooksBaseTestCase(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
self.path = sys.path[:]
|
|
self.meta_path = sys.meta_path[:]
|
|
self.path_hooks = sys.path_hooks[:]
|
|
sys.path_importer_cache.clear()
|
|
self.modules_before = support.modules_setup()
|
|
|
|
def tearDown(self):
|
|
sys.path[:] = self.path
|
|
sys.meta_path[:] = self.meta_path
|
|
sys.path_hooks[:] = self.path_hooks
|
|
sys.path_importer_cache.clear()
|
|
support.modules_cleanup(*self.modules_before)
|
|
|
|
|
|
class UncompressedZipImportTestCase(ImportHooksBaseTestCase):
|
|
|
|
compression = ZIP_STORED
|
|
|
|
def setUp(self):
|
|
# We're reusing the zip archive path, so we must clear the
|
|
# cached directory info and linecache.
|
|
linecache.clearcache()
|
|
zipimport._zip_directory_cache.clear()
|
|
ImportHooksBaseTestCase.setUp(self)
|
|
|
|
def makeTree(self, files, dirName=TEMP_DIR):
|
|
# Create a filesystem based set of modules/packages
|
|
# defined by files under the directory dirName.
|
|
self.addCleanup(support.rmtree, dirName)
|
|
|
|
for name, (mtime, data) in files.items():
|
|
path = os.path.join(dirName, name)
|
|
if path[-1] == os.sep:
|
|
if not os.path.isdir(path):
|
|
os.makedirs(path)
|
|
else:
|
|
dname = os.path.dirname(path)
|
|
if not os.path.isdir(dname):
|
|
os.makedirs(dname)
|
|
with open(path, 'wb') as fp:
|
|
fp.write(data)
|
|
|
|
def makeZip(self, files, zipName=TEMP_ZIP, **kw):
|
|
# Create a zip archive based set of modules/packages
|
|
# defined by files in the zip file zipName. If the
|
|
# key 'stuff' exists in kw it is prepended to the archive.
|
|
self.addCleanup(support.unlink, zipName)
|
|
|
|
with ZipFile(zipName, "w") as z:
|
|
for name, (mtime, data) in files.items():
|
|
zinfo = ZipInfo(name, time.localtime(mtime))
|
|
zinfo.compress_type = self.compression
|
|
z.writestr(zinfo, data)
|
|
|
|
stuff = kw.get("stuff", None)
|
|
if stuff is not None:
|
|
# Prepend 'stuff' to the start of the zipfile
|
|
with open(zipName, "rb") as f:
|
|
data = f.read()
|
|
with open(zipName, "wb") as f:
|
|
f.write(stuff)
|
|
f.write(data)
|
|
|
|
def doTest(self, expected_ext, files, *modules, **kw):
|
|
self.makeZip(files, **kw)
|
|
|
|
sys.path.insert(0, TEMP_ZIP)
|
|
|
|
mod = importlib.import_module(".".join(modules))
|
|
|
|
call = kw.get('call')
|
|
if call is not None:
|
|
call(mod)
|
|
|
|
if expected_ext:
|
|
file = mod.get_file()
|
|
self.assertEqual(file, os.path.join(TEMP_ZIP,
|
|
*modules) + expected_ext)
|
|
|
|
def testAFakeZlib(self):
|
|
#
|
|
# This could cause a stack overflow before: importing zlib.py
|
|
# from a compressed archive would cause zlib to be imported
|
|
# which would find zlib.py in the archive, which would... etc.
|
|
#
|
|
# This test *must* be executed first: it must be the first one
|
|
# to trigger zipimport to import zlib (zipimport caches the
|
|
# zlib.decompress function object, after which the problem being
|
|
# tested here wouldn't be a problem anymore...
|
|
# (Hence the 'A' in the test method name: to make it the first
|
|
# item in a list sorted by name, like unittest.makeSuite() does.)
|
|
#
|
|
# This test fails on platforms on which the zlib module is
|
|
# statically linked, but the problem it tests for can't
|
|
# occur in that case (builtin modules are always found first),
|
|
# so we'll simply skip it then. Bug #765456.
|
|
#
|
|
if "zlib" in sys.builtin_module_names:
|
|
self.skipTest('zlib is a builtin module')
|
|
if "zlib" in sys.modules:
|
|
del sys.modules["zlib"]
|
|
files = {"zlib.py": (NOW, test_src)}
|
|
try:
|
|
self.doTest(".py", files, "zlib")
|
|
except ImportError:
|
|
if self.compression != ZIP_DEFLATED:
|
|
self.fail("expected test to not raise ImportError")
|
|
else:
|
|
if self.compression != ZIP_STORED:
|
|
self.fail("expected test to raise ImportError")
|
|
|
|
def testPy(self):
|
|
files = {TESTMOD + ".py": (NOW, test_src)}
|
|
self.doTest(".py", files, TESTMOD)
|
|
|
|
def testPyc(self):
|
|
files = {TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
self.doTest(pyc_ext, files, TESTMOD)
|
|
|
|
def testBoth(self):
|
|
files = {TESTMOD + ".py": (NOW, test_src),
|
|
TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
self.doTest(pyc_ext, files, TESTMOD)
|
|
|
|
def testUncheckedHashBasedPyc(self):
|
|
source = b"state = 'old'"
|
|
source_hash = importlib.util.source_hash(source)
|
|
bytecode = importlib._bootstrap_external._code_to_hash_pyc(
|
|
compile(source, "???", "exec"),
|
|
source_hash,
|
|
False, # unchecked
|
|
)
|
|
files = {TESTMOD + ".py": (NOW, "state = 'new'"),
|
|
TESTMOD + ".pyc": (NOW - 20, bytecode)}
|
|
def check(mod):
|
|
self.assertEqual(mod.state, 'old')
|
|
self.doTest(None, files, TESTMOD, call=check)
|
|
|
|
def testEmptyPy(self):
|
|
files = {TESTMOD + ".py": (NOW, "")}
|
|
self.doTest(None, files, TESTMOD)
|
|
|
|
def testBadMagic(self):
|
|
# make pyc magic word invalid, forcing loading from .py
|
|
badmagic_pyc = bytearray(test_pyc)
|
|
badmagic_pyc[0] ^= 0x04 # flip an arbitrary bit
|
|
files = {TESTMOD + ".py": (NOW, test_src),
|
|
TESTMOD + pyc_ext: (NOW, badmagic_pyc)}
|
|
self.doTest(".py", files, TESTMOD)
|
|
|
|
def testBadMagic2(self):
|
|
# make pyc magic word invalid, causing an ImportError
|
|
badmagic_pyc = bytearray(test_pyc)
|
|
badmagic_pyc[0] ^= 0x04 # flip an arbitrary bit
|
|
files = {TESTMOD + pyc_ext: (NOW, badmagic_pyc)}
|
|
try:
|
|
self.doTest(".py", files, TESTMOD)
|
|
except ImportError:
|
|
pass
|
|
else:
|
|
self.fail("expected ImportError; import from bad pyc")
|
|
|
|
def testBadMTime(self):
|
|
badtime_pyc = bytearray(test_pyc)
|
|
# flip the second bit -- not the first as that one isn't stored in the
|
|
# .py's mtime in the zip archive.
|
|
badtime_pyc[11] ^= 0x02
|
|
files = {TESTMOD + ".py": (NOW, test_src),
|
|
TESTMOD + pyc_ext: (NOW, badtime_pyc)}
|
|
self.doTest(".py", files, TESTMOD)
|
|
|
|
def testPackage(self):
|
|
packdir = TESTPACK + os.sep
|
|
files = {packdir + "__init__" + pyc_ext: (NOW, test_pyc),
|
|
packdir + TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
self.doTest(pyc_ext, files, TESTPACK, TESTMOD)
|
|
|
|
def testSubPackage(self):
|
|
# Test that subpackages function when loaded from zip
|
|
# archives.
|
|
packdir = TESTPACK + os.sep
|
|
packdir2 = packdir + TESTPACK2 + os.sep
|
|
files = {packdir + "__init__" + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + "__init__" + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
self.doTest(pyc_ext, files, TESTPACK, TESTPACK2, TESTMOD)
|
|
|
|
def testSubNamespacePackage(self):
|
|
# Test that implicit namespace subpackages function
|
|
# when loaded from zip archives.
|
|
packdir = TESTPACK + os.sep
|
|
packdir2 = packdir + TESTPACK2 + os.sep
|
|
# The first two files are just directory entries (so have no data).
|
|
files = {packdir: (NOW, ""),
|
|
packdir2: (NOW, ""),
|
|
packdir2 + TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
self.doTest(pyc_ext, files, TESTPACK, TESTPACK2, TESTMOD)
|
|
|
|
def testMixedNamespacePackage(self):
|
|
# Test implicit namespace packages spread between a
|
|
# real filesystem and a zip archive.
|
|
packdir = TESTPACK + os.sep
|
|
packdir2 = packdir + TESTPACK2 + os.sep
|
|
packdir3 = packdir2 + TESTPACK + '3' + os.sep
|
|
files1 = {packdir: (NOW, ""),
|
|
packdir + TESTMOD + pyc_ext: (NOW, test_pyc),
|
|
packdir2: (NOW, ""),
|
|
packdir3: (NOW, ""),
|
|
packdir3 + TESTMOD + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + TESTMOD + '3' + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
files2 = {packdir: (NOW, ""),
|
|
packdir + TESTMOD + '2' + pyc_ext: (NOW, test_pyc),
|
|
packdir2: (NOW, ""),
|
|
packdir2 + TESTMOD + '2' + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
|
|
zip1 = os.path.abspath("path1.zip")
|
|
self.makeZip(files1, zip1)
|
|
|
|
zip2 = TEMP_DIR
|
|
self.makeTree(files2, zip2)
|
|
|
|
# zip2 should override zip1.
|
|
sys.path.insert(0, zip1)
|
|
sys.path.insert(0, zip2)
|
|
|
|
mod = importlib.import_module(TESTPACK)
|
|
|
|
# if TESTPACK is functioning as a namespace pkg then
|
|
# there should be two entries in the __path__.
|
|
# First should be path2 and second path1.
|
|
self.assertEqual(2, len(mod.__path__))
|
|
p1, p2 = mod.__path__
|
|
self.assertEqual(os.path.basename(TEMP_DIR), p1.split(os.sep)[-2])
|
|
self.assertEqual("path1.zip", p2.split(os.sep)[-2])
|
|
|
|
# packdir3 should import as a namespace package.
|
|
# Its __path__ is an iterable of 1 element from zip1.
|
|
mod = importlib.import_module(packdir3.replace(os.sep, '.')[:-1])
|
|
self.assertEqual(1, len(mod.__path__))
|
|
mpath = list(mod.__path__)[0].split('path1.zip' + os.sep)[1]
|
|
self.assertEqual(packdir3[:-1], mpath)
|
|
|
|
# TESTPACK/TESTMOD only exists in path1.
|
|
mod = importlib.import_module('.'.join((TESTPACK, TESTMOD)))
|
|
self.assertEqual("path1.zip", mod.__file__.split(os.sep)[-3])
|
|
|
|
# And TESTPACK/(TESTMOD + '2') only exists in path2.
|
|
mod = importlib.import_module('.'.join((TESTPACK, TESTMOD + '2')))
|
|
self.assertEqual(os.path.basename(TEMP_DIR),
|
|
mod.__file__.split(os.sep)[-3])
|
|
|
|
# One level deeper...
|
|
subpkg = '.'.join((TESTPACK, TESTPACK2))
|
|
mod = importlib.import_module(subpkg)
|
|
self.assertEqual(2, len(mod.__path__))
|
|
p1, p2 = mod.__path__
|
|
self.assertEqual(os.path.basename(TEMP_DIR), p1.split(os.sep)[-3])
|
|
self.assertEqual("path1.zip", p2.split(os.sep)[-3])
|
|
|
|
# subpkg.TESTMOD exists in both zips should load from zip2.
|
|
mod = importlib.import_module('.'.join((subpkg, TESTMOD)))
|
|
self.assertEqual(os.path.basename(TEMP_DIR),
|
|
mod.__file__.split(os.sep)[-4])
|
|
|
|
# subpkg.TESTMOD + '2' only exists in zip2.
|
|
mod = importlib.import_module('.'.join((subpkg, TESTMOD + '2')))
|
|
self.assertEqual(os.path.basename(TEMP_DIR),
|
|
mod.__file__.split(os.sep)[-4])
|
|
|
|
# Finally subpkg.TESTMOD + '3' only exists in zip1.
|
|
mod = importlib.import_module('.'.join((subpkg, TESTMOD + '3')))
|
|
self.assertEqual('path1.zip', mod.__file__.split(os.sep)[-4])
|
|
|
|
def testNamespacePackage(self):
|
|
# Test implicit namespace packages spread between multiple zip
|
|
# archives.
|
|
packdir = TESTPACK + os.sep
|
|
packdir2 = packdir + TESTPACK2 + os.sep
|
|
packdir3 = packdir2 + TESTPACK + '3' + os.sep
|
|
files1 = {packdir: (NOW, ""),
|
|
packdir + TESTMOD + pyc_ext: (NOW, test_pyc),
|
|
packdir2: (NOW, ""),
|
|
packdir3: (NOW, ""),
|
|
packdir3 + TESTMOD + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + TESTMOD + '3' + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
zip1 = os.path.abspath("path1.zip")
|
|
self.makeZip(files1, zip1)
|
|
|
|
files2 = {packdir: (NOW, ""),
|
|
packdir + TESTMOD + '2' + pyc_ext: (NOW, test_pyc),
|
|
packdir2: (NOW, ""),
|
|
packdir2 + TESTMOD + '2' + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
zip2 = os.path.abspath("path2.zip")
|
|
self.makeZip(files2, zip2)
|
|
|
|
# zip2 should override zip1.
|
|
sys.path.insert(0, zip1)
|
|
sys.path.insert(0, zip2)
|
|
|
|
mod = importlib.import_module(TESTPACK)
|
|
|
|
# if TESTPACK is functioning as a namespace pkg then
|
|
# there should be two entries in the __path__.
|
|
# First should be path2 and second path1.
|
|
self.assertEqual(2, len(mod.__path__))
|
|
p1, p2 = mod.__path__
|
|
self.assertEqual("path2.zip", p1.split(os.sep)[-2])
|
|
self.assertEqual("path1.zip", p2.split(os.sep)[-2])
|
|
|
|
# packdir3 should import as a namespace package.
|
|
# Tts __path__ is an iterable of 1 element from zip1.
|
|
mod = importlib.import_module(packdir3.replace(os.sep, '.')[:-1])
|
|
self.assertEqual(1, len(mod.__path__))
|
|
mpath = list(mod.__path__)[0].split('path1.zip' + os.sep)[1]
|
|
self.assertEqual(packdir3[:-1], mpath)
|
|
|
|
# TESTPACK/TESTMOD only exists in path1.
|
|
mod = importlib.import_module('.'.join((TESTPACK, TESTMOD)))
|
|
self.assertEqual("path1.zip", mod.__file__.split(os.sep)[-3])
|
|
|
|
# And TESTPACK/(TESTMOD + '2') only exists in path2.
|
|
mod = importlib.import_module('.'.join((TESTPACK, TESTMOD + '2')))
|
|
self.assertEqual("path2.zip", mod.__file__.split(os.sep)[-3])
|
|
|
|
# One level deeper...
|
|
subpkg = '.'.join((TESTPACK, TESTPACK2))
|
|
mod = importlib.import_module(subpkg)
|
|
self.assertEqual(2, len(mod.__path__))
|
|
p1, p2 = mod.__path__
|
|
self.assertEqual("path2.zip", p1.split(os.sep)[-3])
|
|
self.assertEqual("path1.zip", p2.split(os.sep)[-3])
|
|
|
|
# subpkg.TESTMOD exists in both zips should load from zip2.
|
|
mod = importlib.import_module('.'.join((subpkg, TESTMOD)))
|
|
self.assertEqual('path2.zip', mod.__file__.split(os.sep)[-4])
|
|
|
|
# subpkg.TESTMOD + '2' only exists in zip2.
|
|
mod = importlib.import_module('.'.join((subpkg, TESTMOD + '2')))
|
|
self.assertEqual('path2.zip', mod.__file__.split(os.sep)[-4])
|
|
|
|
# Finally subpkg.TESTMOD + '3' only exists in zip1.
|
|
mod = importlib.import_module('.'.join((subpkg, TESTMOD + '3')))
|
|
self.assertEqual('path1.zip', mod.__file__.split(os.sep)[-4])
|
|
|
|
def testZipImporterMethods(self):
|
|
packdir = TESTPACK + os.sep
|
|
packdir2 = packdir + TESTPACK2 + os.sep
|
|
files = {packdir + "__init__" + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + "__init__" + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + TESTMOD + pyc_ext: (NOW, test_pyc),
|
|
"spam" + pyc_ext: (NOW, test_pyc)}
|
|
|
|
z = ZipFile(TEMP_ZIP, "w")
|
|
try:
|
|
for name, (mtime, data) in files.items():
|
|
zinfo = ZipInfo(name, time.localtime(mtime))
|
|
zinfo.compress_type = self.compression
|
|
zinfo.comment = b"spam"
|
|
z.writestr(zinfo, data)
|
|
z.close()
|
|
|
|
zi = zipimport.zipimporter(TEMP_ZIP)
|
|
self.assertEqual(zi.archive, TEMP_ZIP)
|
|
self.assertEqual(zi.is_package(TESTPACK), True)
|
|
|
|
find_mod = zi.find_module('spam')
|
|
self.assertIsNotNone(find_mod)
|
|
self.assertIsInstance(find_mod, zipimport.zipimporter)
|
|
self.assertFalse(find_mod.is_package('spam'))
|
|
load_mod = find_mod.load_module('spam')
|
|
self.assertEqual(find_mod.get_filename('spam'), load_mod.__file__)
|
|
|
|
mod = zi.load_module(TESTPACK)
|
|
self.assertEqual(zi.get_filename(TESTPACK), mod.__file__)
|
|
|
|
existing_pack_path = importlib.import_module(TESTPACK).__path__[0]
|
|
expected_path_path = os.path.join(TEMP_ZIP, TESTPACK)
|
|
self.assertEqual(existing_pack_path, expected_path_path)
|
|
|
|
self.assertEqual(zi.is_package(packdir + '__init__'), False)
|
|
self.assertEqual(zi.is_package(packdir + TESTPACK2), True)
|
|
self.assertEqual(zi.is_package(packdir2 + TESTMOD), False)
|
|
|
|
mod_path = packdir2 + TESTMOD
|
|
mod_name = module_path_to_dotted_name(mod_path)
|
|
mod = importlib.import_module(mod_name)
|
|
self.assertTrue(mod_name in sys.modules)
|
|
self.assertEqual(zi.get_source(TESTPACK), None)
|
|
self.assertEqual(zi.get_source(mod_path), None)
|
|
self.assertEqual(zi.get_filename(mod_path), mod.__file__)
|
|
# To pass in the module name instead of the path, we must use the
|
|
# right importer
|
|
loader = mod.__loader__
|
|
self.assertEqual(loader.get_source(mod_name), None)
|
|
self.assertEqual(loader.get_filename(mod_name), mod.__file__)
|
|
|
|
# test prefix and archivepath members
|
|
zi2 = zipimport.zipimporter(TEMP_ZIP + os.sep + TESTPACK)
|
|
self.assertEqual(zi2.archive, TEMP_ZIP)
|
|
self.assertEqual(zi2.prefix, TESTPACK + os.sep)
|
|
finally:
|
|
z.close()
|
|
os.remove(TEMP_ZIP)
|
|
|
|
def testZipImporterMethodsInSubDirectory(self):
|
|
packdir = TESTPACK + os.sep
|
|
packdir2 = packdir + TESTPACK2 + os.sep
|
|
files = {packdir2 + "__init__" + pyc_ext: (NOW, test_pyc),
|
|
packdir2 + TESTMOD + pyc_ext: (NOW, test_pyc)}
|
|
|
|
z = ZipFile(TEMP_ZIP, "w")
|
|
try:
|
|
for name, (mtime, data) in files.items():
|
|
zinfo = ZipInfo(name, time.localtime(mtime))
|
|
zinfo.compress_type = self.compression
|
|
zinfo.comment = b"eggs"
|
|
z.writestr(zinfo, data)
|
|
z.close()
|
|
|
|
zi = zipimport.zipimporter(TEMP_ZIP + os.sep + packdir)
|
|
self.assertEqual(zi.archive, TEMP_ZIP)
|
|
self.assertEqual(zi.prefix, packdir)
|
|
self.assertEqual(zi.is_package(TESTPACK2), True)
|
|
mod = zi.load_module(TESTPACK2)
|
|
self.assertEqual(zi.get_filename(TESTPACK2), mod.__file__)
|
|
|
|
self.assertEqual(
|
|
zi.is_package(TESTPACK2 + os.sep + '__init__'), False)
|
|
self.assertEqual(
|
|
zi.is_package(TESTPACK2 + os.sep + TESTMOD), False)
|
|
|
|
pkg_path = TEMP_ZIP + os.sep + packdir + TESTPACK2
|
|
zi2 = zipimport.zipimporter(pkg_path)
|
|
find_mod_dotted = zi2.find_module(TESTMOD)
|
|
self.assertIsNotNone(find_mod_dotted)
|
|
self.assertIsInstance(find_mod_dotted, zipimport.zipimporter)
|
|
self.assertFalse(zi2.is_package(TESTMOD))
|
|
load_mod = find_mod_dotted.load_module(TESTMOD)
|
|
self.assertEqual(
|
|
find_mod_dotted.get_filename(TESTMOD), load_mod.__file__)
|
|
|
|
mod_path = TESTPACK2 + os.sep + TESTMOD
|
|
mod_name = module_path_to_dotted_name(mod_path)
|
|
mod = importlib.import_module(mod_name)
|
|
self.assertTrue(mod_name in sys.modules)
|
|
self.assertEqual(zi.get_source(TESTPACK2), None)
|
|
self.assertEqual(zi.get_source(mod_path), None)
|
|
self.assertEqual(zi.get_filename(mod_path), mod.__file__)
|
|
# To pass in the module name instead of the path, we must use the
|
|
# right importer.
|
|
loader = mod.__loader__
|
|
self.assertEqual(loader.get_source(mod_name), None)
|
|
self.assertEqual(loader.get_filename(mod_name), mod.__file__)
|
|
finally:
|
|
z.close()
|
|
os.remove(TEMP_ZIP)
|
|
|
|
def testGetData(self):
|
|
z = ZipFile(TEMP_ZIP, "w")
|
|
z.compression = self.compression
|
|
try:
|
|
name = "testdata.dat"
|
|
data = bytes(x for x in range(256))
|
|
z.writestr(name, data)
|
|
z.close()
|
|
zi = zipimport.zipimporter(TEMP_ZIP)
|
|
self.assertEqual(data, zi.get_data(name))
|
|
self.assertIn('zipimporter object', repr(zi))
|
|
finally:
|
|
z.close()
|
|
os.remove(TEMP_ZIP)
|
|
|
|
def test_issue31291(self):
|
|
# There shouldn't be an assertion failure in get_data().
|
|
class FunnyStr(str):
|
|
def replace(self, old, new):
|
|
return 42
|
|
z = ZipFile(TEMP_ZIP, "w")
|
|
try:
|
|
name = "test31291.dat"
|
|
data = b'foo'
|
|
z.writestr(name, data)
|
|
z.close()
|
|
zi = zipimport.zipimporter(TEMP_ZIP)
|
|
self.assertEqual(data, zi.get_data(FunnyStr(name)))
|
|
finally:
|
|
z.close()
|
|
os.remove(TEMP_ZIP)
|
|
|
|
def testImporterAttr(self):
|
|
src = """if 1: # indent hack
|
|
def get_file():
|
|
return __file__
|
|
if __loader__.get_data("some.data") != b"some data":
|
|
raise AssertionError("bad data")\n"""
|
|
pyc = make_pyc(compile(src, "<???>", "exec"), NOW, len(src))
|
|
files = {TESTMOD + pyc_ext: (NOW, pyc),
|
|
"some.data": (NOW, "some data")}
|
|
self.doTest(pyc_ext, files, TESTMOD)
|
|
|
|
def testDefaultOptimizationLevel(self):
|
|
# zipimport should use the default optimization level (#28131)
|
|
src = """if 1: # indent hack
|
|
def test(val):
|
|
assert(val)
|
|
return val\n"""
|
|
files = {TESTMOD + '.py': (NOW, src)}
|
|
self.makeZip(files)
|
|
sys.path.insert(0, TEMP_ZIP)
|
|
mod = importlib.import_module(TESTMOD)
|
|
self.assertEqual(mod.test(1), 1)
|
|
self.assertRaises(AssertionError, mod.test, False)
|
|
|
|
def testImport_WithStuff(self):
|
|
# try importing from a zipfile which contains additional
|
|
# stuff at the beginning of the file
|
|
files = {TESTMOD + ".py": (NOW, test_src)}
|
|
self.doTest(".py", files, TESTMOD,
|
|
stuff=b"Some Stuff"*31)
|
|
|
|
def assertModuleSource(self, module):
|
|
self.assertEqual(inspect.getsource(module), test_src)
|
|
|
|
def testGetSource(self):
|
|
files = {TESTMOD + ".py": (NOW, test_src)}
|
|
self.doTest(".py", files, TESTMOD, call=self.assertModuleSource)
|
|
|
|
def testGetCompiledSource(self):
|
|
pyc = make_pyc(compile(test_src, "<???>", "exec"), NOW, len(test_src))
|
|
files = {TESTMOD + ".py": (NOW, test_src),
|
|
TESTMOD + pyc_ext: (NOW, pyc)}
|
|
self.doTest(pyc_ext, files, TESTMOD, call=self.assertModuleSource)
|
|
|
|
def runDoctest(self, callback):
|
|
files = {TESTMOD + ".py": (NOW, test_src),
|
|
"xyz.txt": (NOW, ">>> log.append(True)\n")}
|
|
self.doTest(".py", files, TESTMOD, call=callback)
|
|
|
|
def doDoctestFile(self, module):
|
|
log = []
|
|
old_master, doctest.master = doctest.master, None
|
|
try:
|
|
doctest.testfile(
|
|
'xyz.txt', package=module, module_relative=True,
|
|
globs=locals()
|
|
)
|
|
finally:
|
|
doctest.master = old_master
|
|
self.assertEqual(log,[True])
|
|
|
|
def testDoctestFile(self):
|
|
self.runDoctest(self.doDoctestFile)
|
|
|
|
def doDoctestSuite(self, module):
|
|
log = []
|
|
doctest.DocFileTest(
|
|
'xyz.txt', package=module, module_relative=True,
|
|
globs=locals()
|
|
).run()
|
|
self.assertEqual(log,[True])
|
|
|
|
def testDoctestSuite(self):
|
|
self.runDoctest(self.doDoctestSuite)
|
|
|
|
def doTraceback(self, module):
|
|
try:
|
|
module.do_raise()
|
|
except:
|
|
tb = sys.exc_info()[2].tb_next
|
|
|
|
f,lno,n,line = extract_tb(tb, 1)[0]
|
|
self.assertEqual(line, raise_src.strip())
|
|
|
|
f,lno,n,line = extract_stack(tb.tb_frame, 1)[0]
|
|
self.assertEqual(line, raise_src.strip())
|
|
|
|
s = io.StringIO()
|
|
print_tb(tb, 1, s)
|
|
self.assertTrue(s.getvalue().endswith(raise_src))
|
|
else:
|
|
raise AssertionError("This ought to be impossible")
|
|
|
|
def testTraceback(self):
|
|
files = {TESTMOD + ".py": (NOW, raise_src)}
|
|
self.doTest(None, files, TESTMOD, call=self.doTraceback)
|
|
|
|
@unittest.skipIf(support.TESTFN_UNENCODABLE is None,
|
|
"need an unencodable filename")
|
|
def testUnencodable(self):
|
|
filename = support.TESTFN_UNENCODABLE + ".zip"
|
|
z = ZipFile(filename, "w")
|
|
zinfo = ZipInfo(TESTMOD + ".py", time.localtime(NOW))
|
|
zinfo.compress_type = self.compression
|
|
z.writestr(zinfo, test_src)
|
|
z.close()
|
|
try:
|
|
zipimport.zipimporter(filename).load_module(TESTMOD)
|
|
finally:
|
|
os.remove(filename)
|
|
|
|
def testBytesPath(self):
|
|
filename = support.TESTFN + ".zip"
|
|
self.addCleanup(support.unlink, filename)
|
|
with ZipFile(filename, "w") as z:
|
|
zinfo = ZipInfo(TESTMOD + ".py", time.localtime(NOW))
|
|
zinfo.compress_type = self.compression
|
|
z.writestr(zinfo, test_src)
|
|
|
|
zipimport.zipimporter(filename)
|
|
zipimport.zipimporter(os.fsencode(filename))
|
|
with self.assertWarns(DeprecationWarning):
|
|
zipimport.zipimporter(bytearray(os.fsencode(filename)))
|
|
with self.assertWarns(DeprecationWarning):
|
|
zipimport.zipimporter(memoryview(os.fsencode(filename)))
|
|
|
|
@support.cpython_only
|
|
def testUninitializedZipimporter(self):
|
|
# The interpreter shouldn't crash in case of calling methods of an
|
|
# uninitialized zipimport.zipimporter object.
|
|
zi = zipimport.zipimporter.__new__(zipimport.zipimporter)
|
|
self.assertRaises(ValueError, zi.find_module, 'foo')
|
|
self.assertRaises(ValueError, zi.find_loader, 'foo')
|
|
self.assertRaises(ValueError, zi.load_module, 'foo')
|
|
self.assertRaises(ValueError, zi.get_filename, 'foo')
|
|
self.assertRaises(ValueError, zi.is_package, 'foo')
|
|
self.assertRaises(ValueError, zi.get_data, 'foo')
|
|
self.assertRaises(ValueError, zi.get_code, 'foo')
|
|
self.assertRaises(ValueError, zi.get_source, 'foo')
|
|
|
|
|
|
@support.requires_zlib
|
|
class CompressedZipImportTestCase(UncompressedZipImportTestCase):
|
|
compression = ZIP_DEFLATED
|
|
|
|
@support.cpython_only
|
|
def test_issue31602(self):
|
|
# There shouldn't be an assertion failure in zipimporter.get_source()
|
|
# in case of a bad zlib.decompress().
|
|
def bad_decompress(*args):
|
|
return None
|
|
with ZipFile(TEMP_ZIP, 'w') as zip_file:
|
|
self.addCleanup(support.unlink, TEMP_ZIP)
|
|
zip_file.writestr('bar.py', b'print("hello world")', ZIP_DEFLATED)
|
|
zi = zipimport.zipimporter(TEMP_ZIP)
|
|
with support.swap_attr(zlib, 'decompress', bad_decompress):
|
|
self.assertRaises(TypeError, zi.get_source, 'bar')
|
|
|
|
|
|
class BadFileZipImportTestCase(unittest.TestCase):
|
|
def assertZipFailure(self, filename):
|
|
self.assertRaises(zipimport.ZipImportError,
|
|
zipimport.zipimporter, filename)
|
|
|
|
def testNoFile(self):
|
|
self.assertZipFailure('AdfjdkFJKDFJjdklfjs')
|
|
|
|
def testEmptyFilename(self):
|
|
self.assertZipFailure('')
|
|
|
|
def testBadArgs(self):
|
|
self.assertRaises(TypeError, zipimport.zipimporter, None)
|
|
self.assertRaises(TypeError, zipimport.zipimporter, TESTMOD, kwd=None)
|
|
self.assertRaises(TypeError, zipimport.zipimporter,
|
|
list(os.fsencode(TESTMOD)))
|
|
|
|
def testFilenameTooLong(self):
|
|
self.assertZipFailure('A' * 33000)
|
|
|
|
def testEmptyFile(self):
|
|
support.unlink(TESTMOD)
|
|
support.create_empty_file(TESTMOD)
|
|
self.assertZipFailure(TESTMOD)
|
|
|
|
def testFileUnreadable(self):
|
|
support.unlink(TESTMOD)
|
|
fd = os.open(TESTMOD, os.O_CREAT, 000)
|
|
try:
|
|
os.close(fd)
|
|
|
|
with self.assertRaises(zipimport.ZipImportError) as cm:
|
|
zipimport.zipimporter(TESTMOD)
|
|
finally:
|
|
# If we leave "the read-only bit" set on Windows, nothing can
|
|
# delete TESTMOD, and later tests suffer bogus failures.
|
|
os.chmod(TESTMOD, 0o666)
|
|
support.unlink(TESTMOD)
|
|
|
|
def testNotZipFile(self):
|
|
support.unlink(TESTMOD)
|
|
fp = open(TESTMOD, 'w+')
|
|
fp.write('a' * 22)
|
|
fp.close()
|
|
self.assertZipFailure(TESTMOD)
|
|
|
|
# XXX: disabled until this works on Big-endian machines
|
|
def _testBogusZipFile(self):
|
|
support.unlink(TESTMOD)
|
|
fp = open(TESTMOD, 'w+')
|
|
fp.write(struct.pack('=I', 0x06054B50))
|
|
fp.write('a' * 18)
|
|
fp.close()
|
|
z = zipimport.zipimporter(TESTMOD)
|
|
|
|
try:
|
|
self.assertRaises(TypeError, z.find_module, None)
|
|
self.assertRaises(TypeError, z.load_module, None)
|
|
self.assertRaises(TypeError, z.is_package, None)
|
|
self.assertRaises(TypeError, z.get_code, None)
|
|
self.assertRaises(TypeError, z.get_data, None)
|
|
self.assertRaises(TypeError, z.get_source, None)
|
|
|
|
error = zipimport.ZipImportError
|
|
self.assertEqual(z.find_module('abc'), None)
|
|
|
|
self.assertRaises(error, z.load_module, 'abc')
|
|
self.assertRaises(error, z.get_code, 'abc')
|
|
self.assertRaises(OSError, z.get_data, 'abc')
|
|
self.assertRaises(error, z.get_source, 'abc')
|
|
self.assertRaises(error, z.is_package, 'abc')
|
|
finally:
|
|
zipimport._zip_directory_cache.clear()
|
|
|
|
|
|
def test_main():
|
|
try:
|
|
support.run_unittest(
|
|
UncompressedZipImportTestCase,
|
|
CompressedZipImportTestCase,
|
|
BadFileZipImportTestCase,
|
|
)
|
|
finally:
|
|
support.unlink(TESTMOD)
|
|
|
|
if __name__ == "__main__":
|
|
test_main()
|