Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 1 | import sys |
| 2 | import imp |
| 3 | import os |
| 4 | import unittest |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 5 | from test import support |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 6 | |
| 7 | |
| 8 | test_src = """\ |
| 9 | def get_name(): |
| 10 | return __name__ |
| 11 | def get_file(): |
| 12 | return __file__ |
| 13 | """ |
| 14 | |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 15 | absimp = "import sub\n" |
| 16 | relimp = "from . import sub\n" |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 17 | deeprelimp = "from .... import sub\n" |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 18 | futimp = "from __future__ import absolute_import\n" |
| 19 | |
Phillip J. Eby | 7ec642a | 2004-09-23 04:37:36 +0000 | [diff] [blame] | 20 | reload_src = test_src+"""\ |
| 21 | reloaded = True |
| 22 | """ |
| 23 | |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 24 | test_co = compile(test_src, "<???>", "exec") |
Phillip J. Eby | 7ec642a | 2004-09-23 04:37:36 +0000 | [diff] [blame] | 25 | reload_co = compile(reload_src, "<???>", "exec") |
| 26 | |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 27 | test2_oldabs_co = compile(absimp + test_src, "<???>", "exec") |
| 28 | test2_newabs_co = compile(futimp + absimp + test_src, "<???>", "exec") |
| 29 | test2_newrel_co = compile(relimp + test_src, "<???>", "exec") |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 30 | test2_deeprel_co = compile(deeprelimp + test_src, "<???>", "exec") |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 31 | test2_futrel_co = compile(futimp + relimp + test_src, "<???>", "exec") |
| 32 | |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 33 | test_path = "!!!_test_!!!" |
| 34 | |
| 35 | |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 36 | class TestImporter: |
| 37 | |
| 38 | modules = { |
| 39 | "hooktestmodule": (False, test_co), |
| 40 | "hooktestpackage": (True, test_co), |
| 41 | "hooktestpackage.sub": (True, test_co), |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 42 | "hooktestpackage.sub.subber": (True, test_co), |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 43 | "hooktestpackage.oldabs": (False, test2_oldabs_co), |
| 44 | "hooktestpackage.newabs": (False, test2_newabs_co), |
| 45 | "hooktestpackage.newrel": (False, test2_newrel_co), |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 46 | "hooktestpackage.sub.subber.subest": (True, test2_deeprel_co), |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 47 | "hooktestpackage.futrel": (False, test2_futrel_co), |
| 48 | "sub": (False, test_co), |
Phillip J. Eby | 7ec642a | 2004-09-23 04:37:36 +0000 | [diff] [blame] | 49 | "reloadmodule": (False, test_co), |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 50 | } |
| 51 | |
| 52 | def __init__(self, path=test_path): |
| 53 | if path != test_path: |
Eric V. Smith | 2e3112f | 2011-03-15 04:16:42 -0400 | [diff] [blame] | 54 | # if our class is on sys.path_hooks, we must raise |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 55 | # ImportError for any path item that we can't handle. |
| 56 | raise ImportError |
| 57 | self.path = path |
| 58 | |
| 59 | def _get__path__(self): |
| 60 | raise NotImplementedError |
| 61 | |
| 62 | def find_module(self, fullname, path=None): |
| 63 | if fullname in self.modules: |
| 64 | return self |
| 65 | else: |
| 66 | return None |
| 67 | |
| 68 | def load_module(self, fullname): |
| 69 | ispkg, code = self.modules[fullname] |
Phillip J. Eby | 7ec642a | 2004-09-23 04:37:36 +0000 | [diff] [blame] | 70 | mod = sys.modules.setdefault(fullname,imp.new_module(fullname)) |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 71 | mod.__file__ = "<%s>" % self.__class__.__name__ |
| 72 | mod.__loader__ = self |
| 73 | if ispkg: |
| 74 | mod.__path__ = self._get__path__() |
Georg Brandl | 7cae87c | 2006-09-06 06:51:57 +0000 | [diff] [blame] | 75 | exec(code, mod.__dict__) |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 76 | return mod |
| 77 | |
| 78 | |
| 79 | class MetaImporter(TestImporter): |
| 80 | def _get__path__(self): |
| 81 | return [] |
| 82 | |
| 83 | class PathImporter(TestImporter): |
| 84 | def _get__path__(self): |
| 85 | return [self.path] |
| 86 | |
| 87 | |
| 88 | class ImportBlocker: |
| 89 | """Place an ImportBlocker instance on sys.meta_path and you |
| 90 | can be sure the modules you specified can't be imported, even |
| 91 | if it's a builtin.""" |
| 92 | def __init__(self, *namestoblock): |
| 93 | self.namestoblock = dict.fromkeys(namestoblock) |
| 94 | def find_module(self, fullname, path=None): |
| 95 | if fullname in self.namestoblock: |
| 96 | return self |
| 97 | return None |
| 98 | def load_module(self, fullname): |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 99 | raise ImportError("I dare you") |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 100 | |
| 101 | |
| 102 | class ImpWrapper: |
| 103 | |
| 104 | def __init__(self, path=None): |
| 105 | if path is not None and not os.path.isdir(path): |
| 106 | raise ImportError |
| 107 | self.path = path |
| 108 | |
| 109 | def find_module(self, fullname, path=None): |
| 110 | subname = fullname.split(".")[-1] |
| 111 | if subname != fullname and self.path is None: |
| 112 | return None |
| 113 | if self.path is None: |
| 114 | path = None |
| 115 | else: |
| 116 | path = [self.path] |
| 117 | try: |
| 118 | file, filename, stuff = imp.find_module(subname, path) |
| 119 | except ImportError: |
| 120 | return None |
| 121 | return ImpLoader(file, filename, stuff) |
| 122 | |
| 123 | |
| 124 | class ImpLoader: |
| 125 | |
| 126 | def __init__(self, file, filename, stuff): |
| 127 | self.file = file |
| 128 | self.filename = filename |
| 129 | self.stuff = stuff |
| 130 | |
| 131 | def load_module(self, fullname): |
| 132 | mod = imp.load_module(fullname, self.file, self.filename, self.stuff) |
| 133 | if self.file: |
| 134 | self.file.close() |
| 135 | mod.__loader__ = self # for introspection |
| 136 | return mod |
| 137 | |
| 138 | |
| 139 | class ImportHooksBaseTestCase(unittest.TestCase): |
| 140 | |
| 141 | def setUp(self): |
| 142 | self.path = sys.path[:] |
| 143 | self.meta_path = sys.meta_path[:] |
| 144 | self.path_hooks = sys.path_hooks[:] |
| 145 | sys.path_importer_cache.clear() |
Antoine Pitrou | 060cee2 | 2009-11-13 16:29:04 +0000 | [diff] [blame] | 146 | self.modules_before = support.modules_setup() |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 147 | |
| 148 | def tearDown(self): |
| 149 | sys.path[:] = self.path |
| 150 | sys.meta_path[:] = self.meta_path |
| 151 | sys.path_hooks[:] = self.path_hooks |
| 152 | sys.path_importer_cache.clear() |
Antoine Pitrou | 060cee2 | 2009-11-13 16:29:04 +0000 | [diff] [blame] | 153 | support.modules_cleanup(*self.modules_before) |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 154 | |
| 155 | |
| 156 | class ImportHooksTestCase(ImportHooksBaseTestCase): |
| 157 | |
| 158 | def doTestImports(self, importer=None): |
| 159 | import hooktestmodule |
| 160 | import hooktestpackage |
| 161 | import hooktestpackage.sub |
| 162 | import hooktestpackage.sub.subber |
| 163 | self.assertEqual(hooktestmodule.get_name(), |
| 164 | "hooktestmodule") |
| 165 | self.assertEqual(hooktestpackage.get_name(), |
| 166 | "hooktestpackage") |
| 167 | self.assertEqual(hooktestpackage.sub.get_name(), |
| 168 | "hooktestpackage.sub") |
| 169 | self.assertEqual(hooktestpackage.sub.subber.get_name(), |
| 170 | "hooktestpackage.sub.subber") |
| 171 | if importer: |
| 172 | self.assertEqual(hooktestmodule.__loader__, importer) |
| 173 | self.assertEqual(hooktestpackage.__loader__, importer) |
| 174 | self.assertEqual(hooktestpackage.sub.__loader__, importer) |
| 175 | self.assertEqual(hooktestpackage.sub.subber.__loader__, importer) |
| 176 | |
Phillip J. Eby | 7ec642a | 2004-09-23 04:37:36 +0000 | [diff] [blame] | 177 | TestImporter.modules['reloadmodule'] = (False, test_co) |
| 178 | import reloadmodule |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 179 | self.assertFalse(hasattr(reloadmodule,'reloaded')) |
Phillip J. Eby | 7ec642a | 2004-09-23 04:37:36 +0000 | [diff] [blame] | 180 | |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 181 | import hooktestpackage.newrel |
| 182 | self.assertEqual(hooktestpackage.newrel.get_name(), |
| 183 | "hooktestpackage.newrel") |
| 184 | self.assertEqual(hooktestpackage.newrel.sub, |
| 185 | hooktestpackage.sub) |
| 186 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 187 | import hooktestpackage.sub.subber.subest as subest |
| 188 | self.assertEqual(subest.get_name(), |
| 189 | "hooktestpackage.sub.subber.subest") |
| 190 | self.assertEqual(subest.sub, |
| 191 | hooktestpackage.sub) |
| 192 | |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 193 | import hooktestpackage.futrel |
| 194 | self.assertEqual(hooktestpackage.futrel.get_name(), |
| 195 | "hooktestpackage.futrel") |
| 196 | self.assertEqual(hooktestpackage.futrel.sub, |
| 197 | hooktestpackage.sub) |
Tim Peters | 710ab3b | 2006-02-28 18:30:36 +0000 | [diff] [blame] | 198 | |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 199 | import sub |
| 200 | self.assertEqual(sub.get_name(), "sub") |
| 201 | |
Thomas Wouters | 60254fe | 2006-05-28 10:46:55 +0000 | [diff] [blame] | 202 | import hooktestpackage.oldabs |
| 203 | self.assertEqual(hooktestpackage.oldabs.get_name(), |
| 204 | "hooktestpackage.oldabs") |
| 205 | self.assertEqual(hooktestpackage.oldabs.sub, sub) |
| 206 | |
Thomas Wouters | f7f438b | 2006-02-28 16:09:29 +0000 | [diff] [blame] | 207 | import hooktestpackage.newabs |
| 208 | self.assertEqual(hooktestpackage.newabs.get_name(), |
| 209 | "hooktestpackage.newabs") |
| 210 | self.assertEqual(hooktestpackage.newabs.sub, sub) |
Tim Peters | 1cc3738 | 2004-09-24 04:36:47 +0000 | [diff] [blame] | 211 | |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 212 | def testMetaPath(self): |
| 213 | i = MetaImporter() |
| 214 | sys.meta_path.append(i) |
| 215 | self.doTestImports(i) |
| 216 | |
| 217 | def testPathHook(self): |
Brett Cannon | 8923a4d | 2012-04-24 22:03:46 -0400 | [diff] [blame] | 218 | sys.path_hooks.insert(0, PathImporter) |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 219 | sys.path.append(test_path) |
| 220 | self.doTestImports() |
| 221 | |
| 222 | def testBlocker(self): |
| 223 | mname = "exceptions" # an arbitrary harmless builtin module |
Benjamin Peterson | 886af96 | 2010-03-21 23:13:07 +0000 | [diff] [blame] | 224 | support.unload(mname) |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 225 | sys.meta_path.append(ImportBlocker(mname)) |
Benjamin Peterson | 886af96 | 2010-03-21 23:13:07 +0000 | [diff] [blame] | 226 | self.assertRaises(ImportError, __import__, mname) |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 227 | |
| 228 | def testImpWrapper(self): |
| 229 | i = ImpWrapper() |
| 230 | sys.meta_path.append(i) |
Brett Cannon | 8923a4d | 2012-04-24 22:03:46 -0400 | [diff] [blame] | 231 | sys.path_hooks.insert(0, ImpWrapper) |
Victor Stinner | 6ae1e7f | 2011-03-20 22:37:17 +0100 | [diff] [blame] | 232 | mnames = ( |
| 233 | "colorsys", "urllib.parse", "distutils.core", "sys", |
| 234 | ) |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 235 | for mname in mnames: |
| 236 | parent = mname.split(".")[0] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 237 | for n in list(sys.modules): |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 238 | if n.startswith(parent): |
| 239 | del sys.modules[n] |
| 240 | for mname in mnames: |
| 241 | m = __import__(mname, globals(), locals(), ["__dummy__"]) |
Victor Stinner | 6ae1e7f | 2011-03-20 22:37:17 +0100 | [diff] [blame] | 242 | # to make sure we actually handled the import |
| 243 | self.assertTrue(hasattr(m, "__loader__")) |
Georg Brandl | d68442d | 2008-07-20 23:21:49 +0000 | [diff] [blame] | 244 | |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 245 | |
Neal Norwitz | 996acf1 | 2003-02-17 14:51:41 +0000 | [diff] [blame] | 246 | def test_main(): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 247 | support.run_unittest(ImportHooksTestCase) |
Just van Rossum | 52e14d6 | 2002-12-30 22:08:05 +0000 | [diff] [blame] | 248 | |
| 249 | if __name__ == "__main__": |
Neal Norwitz | 996acf1 | 2003-02-17 14:51:41 +0000 | [diff] [blame] | 250 | test_main() |