| 1 | n/a | from .. import abc |
|---|
| 2 | n/a | from . import util as source_util |
|---|
| 3 | n/a | |
|---|
| 4 | n/a | from importlib import machinery |
|---|
| 5 | n/a | import errno |
|---|
| 6 | n/a | import imp |
|---|
| 7 | n/a | import os |
|---|
| 8 | n/a | import py_compile |
|---|
| 9 | n/a | from test.support import make_legacy_pyc |
|---|
| 10 | n/a | import unittest |
|---|
| 11 | n/a | import warnings |
|---|
| 12 | n/a | |
|---|
| 13 | n/a | |
|---|
| 14 | n/a | class FinderTests(abc.FinderTests): |
|---|
| 15 | n/a | |
|---|
| 16 | n/a | """For a top-level module, it should just be found directly in the |
|---|
| 17 | n/a | directory being searched. This is true for a directory with source |
|---|
| 18 | n/a | [top-level source], bytecode [top-level bc], or both [top-level both]. |
|---|
| 19 | n/a | There is also the possibility that it is a package [top-level package], in |
|---|
| 20 | n/a | which case there will be a directory with the module name and an |
|---|
| 21 | n/a | __init__.py file. If there is a directory without an __init__.py an |
|---|
| 22 | n/a | ImportWarning is returned [empty dir]. |
|---|
| 23 | n/a | |
|---|
| 24 | n/a | For sub-modules and sub-packages, the same happens as above but only use |
|---|
| 25 | n/a | the tail end of the name [sub module] [sub package] [sub empty]. |
|---|
| 26 | n/a | |
|---|
| 27 | n/a | When there is a conflict between a package and module having the same name |
|---|
| 28 | n/a | in the same directory, the package wins out [package over module]. This is |
|---|
| 29 | n/a | so that imports of modules within the package can occur rather than trigger |
|---|
| 30 | n/a | an import error. |
|---|
| 31 | n/a | |
|---|
| 32 | n/a | When there is a package and module with the same name, always pick the |
|---|
| 33 | n/a | package over the module [package over module]. This is so that imports from |
|---|
| 34 | n/a | the package have the possibility of succeeding. |
|---|
| 35 | n/a | |
|---|
| 36 | n/a | """ |
|---|
| 37 | n/a | |
|---|
| 38 | n/a | def import_(self, root, module): |
|---|
| 39 | n/a | loader_details = [(machinery.SourceFileLoader, |
|---|
| 40 | n/a | machinery.SOURCE_SUFFIXES, True), |
|---|
| 41 | n/a | (machinery.SourcelessFileLoader, |
|---|
| 42 | n/a | machinery.BYTECODE_SUFFIXES, True)] |
|---|
| 43 | n/a | finder = machinery.FileFinder(root, *loader_details) |
|---|
| 44 | n/a | return finder.find_module(module) |
|---|
| 45 | n/a | |
|---|
| 46 | n/a | def run_test(self, test, create=None, *, compile_=None, unlink=None): |
|---|
| 47 | n/a | """Test the finding of 'test' with the creation of modules listed in |
|---|
| 48 | n/a | 'create'. |
|---|
| 49 | n/a | |
|---|
| 50 | n/a | Any names listed in 'compile_' are byte-compiled. Modules |
|---|
| 51 | n/a | listed in 'unlink' have their source files deleted. |
|---|
| 52 | n/a | |
|---|
| 53 | n/a | """ |
|---|
| 54 | n/a | if create is None: |
|---|
| 55 | n/a | create = {test} |
|---|
| 56 | n/a | with source_util.create_modules(*create) as mapping: |
|---|
| 57 | n/a | if compile_: |
|---|
| 58 | n/a | for name in compile_: |
|---|
| 59 | n/a | py_compile.compile(mapping[name]) |
|---|
| 60 | n/a | if unlink: |
|---|
| 61 | n/a | for name in unlink: |
|---|
| 62 | n/a | os.unlink(mapping[name]) |
|---|
| 63 | n/a | try: |
|---|
| 64 | n/a | make_legacy_pyc(mapping[name]) |
|---|
| 65 | n/a | except OSError as error: |
|---|
| 66 | n/a | # Some tests do not set compile_=True so the source |
|---|
| 67 | n/a | # module will not get compiled and there will be no |
|---|
| 68 | n/a | # PEP 3147 pyc file to rename. |
|---|
| 69 | n/a | if error.errno != errno.ENOENT: |
|---|
| 70 | n/a | raise |
|---|
| 71 | n/a | loader = self.import_(mapping['.root'], test) |
|---|
| 72 | n/a | self.assertTrue(hasattr(loader, 'load_module')) |
|---|
| 73 | n/a | return loader |
|---|
| 74 | n/a | |
|---|
| 75 | n/a | def test_module(self): |
|---|
| 76 | n/a | # [top-level source] |
|---|
| 77 | n/a | self.run_test('top_level') |
|---|
| 78 | n/a | # [top-level bc] |
|---|
| 79 | n/a | self.run_test('top_level', compile_={'top_level'}, |
|---|
| 80 | n/a | unlink={'top_level'}) |
|---|
| 81 | n/a | # [top-level both] |
|---|
| 82 | n/a | self.run_test('top_level', compile_={'top_level'}) |
|---|
| 83 | n/a | |
|---|
| 84 | n/a | # [top-level package] |
|---|
| 85 | n/a | def test_package(self): |
|---|
| 86 | n/a | # Source. |
|---|
| 87 | n/a | self.run_test('pkg', {'pkg.__init__'}) |
|---|
| 88 | n/a | # Bytecode. |
|---|
| 89 | n/a | self.run_test('pkg', {'pkg.__init__'}, compile_={'pkg.__init__'}, |
|---|
| 90 | n/a | unlink={'pkg.__init__'}) |
|---|
| 91 | n/a | # Both. |
|---|
| 92 | n/a | self.run_test('pkg', {'pkg.__init__'}, compile_={'pkg.__init__'}) |
|---|
| 93 | n/a | |
|---|
| 94 | n/a | # [sub module] |
|---|
| 95 | n/a | def test_module_in_package(self): |
|---|
| 96 | n/a | with source_util.create_modules('pkg.__init__', 'pkg.sub') as mapping: |
|---|
| 97 | n/a | pkg_dir = os.path.dirname(mapping['pkg.__init__']) |
|---|
| 98 | n/a | loader = self.import_(pkg_dir, 'pkg.sub') |
|---|
| 99 | n/a | self.assertTrue(hasattr(loader, 'load_module')) |
|---|
| 100 | n/a | |
|---|
| 101 | n/a | # [sub package] |
|---|
| 102 | n/a | def test_package_in_package(self): |
|---|
| 103 | n/a | context = source_util.create_modules('pkg.__init__', 'pkg.sub.__init__') |
|---|
| 104 | n/a | with context as mapping: |
|---|
| 105 | n/a | pkg_dir = os.path.dirname(mapping['pkg.__init__']) |
|---|
| 106 | n/a | loader = self.import_(pkg_dir, 'pkg.sub') |
|---|
| 107 | n/a | self.assertTrue(hasattr(loader, 'load_module')) |
|---|
| 108 | n/a | |
|---|
| 109 | n/a | # [package over modules] |
|---|
| 110 | n/a | def test_package_over_module(self): |
|---|
| 111 | n/a | name = '_temp' |
|---|
| 112 | n/a | loader = self.run_test(name, {'{0}.__init__'.format(name), name}) |
|---|
| 113 | n/a | self.assertIn('__init__', loader.get_filename(name)) |
|---|
| 114 | n/a | |
|---|
| 115 | n/a | def test_failure(self): |
|---|
| 116 | n/a | with source_util.create_modules('blah') as mapping: |
|---|
| 117 | n/a | nothing = self.import_(mapping['.root'], 'sdfsadsadf') |
|---|
| 118 | n/a | self.assertIsNone(nothing) |
|---|
| 119 | n/a | |
|---|
| 120 | n/a | def test_empty_string_for_dir(self): |
|---|
| 121 | n/a | # The empty string from sys.path means to search in the cwd. |
|---|
| 122 | n/a | finder = machinery.FileFinder('', (machinery.SourceFileLoader, |
|---|
| 123 | n/a | machinery.SOURCE_SUFFIXES, True)) |
|---|
| 124 | n/a | with open('mod.py', 'w') as file: |
|---|
| 125 | n/a | file.write("# test file for importlib") |
|---|
| 126 | n/a | try: |
|---|
| 127 | n/a | loader = finder.find_module('mod') |
|---|
| 128 | n/a | self.assertTrue(hasattr(loader, 'load_module')) |
|---|
| 129 | n/a | finally: |
|---|
| 130 | n/a | os.unlink('mod.py') |
|---|
| 131 | n/a | |
|---|
| 132 | n/a | def test_invalidate_caches(self): |
|---|
| 133 | n/a | # invalidate_caches() should reset the mtime. |
|---|
| 134 | n/a | finder = machinery.FileFinder('', (machinery.SourceFileLoader, |
|---|
| 135 | n/a | machinery.SOURCE_SUFFIXES, True)) |
|---|
| 136 | n/a | finder._path_mtime = 42 |
|---|
| 137 | n/a | finder.invalidate_caches() |
|---|
| 138 | n/a | self.assertEqual(finder._path_mtime, -1) |
|---|
| 139 | n/a | |
|---|
| 140 | n/a | |
|---|
| 141 | n/a | def test_main(): |
|---|
| 142 | n/a | from test.support import run_unittest |
|---|
| 143 | n/a | run_unittest(FinderTests) |
|---|
| 144 | n/a | |
|---|
| 145 | n/a | |
|---|
| 146 | n/a | if __name__ == '__main__': |
|---|
| 147 | n/a | test_main() |
|---|