blob: db55db702bffbba758e70784f24b5155a3dfeb9c [file] [log] [blame]
Thomas Woutersa9773292006-04-21 09:43:23 +00001# Test the runpy module
2import unittest
3import os
4import os.path
5import sys
Nick Coghlan16eb0fb2009-11-18 11:35:25 +00006import re
Thomas Woutersa9773292006-04-21 09:43:23 +00007import tempfile
Nick Coghlan720c7e22013-12-15 20:33:02 +10008import importlib, importlib.machinery, importlib.util
Barry Warsaw28a691b2010-04-17 00:19:56 +00009import py_compile
Martin Panter9c8aa9b2016-08-21 04:07:58 +000010import warnings
Brett Cannon31f59292011-02-21 19:29:56 +000011from test.support import (
Zachary Ware38c707e2015-04-13 15:00:43 -050012 forget, make_legacy_pyc, unload, verbose, no_tracing,
Berker Peksagce643912015-05-06 06:33:17 +030013 create_empty_file, temp_dir)
14from test.support.script_helper import (
15 make_pkg, make_script, make_zip_pkg, make_zip_script)
Christian Heimescbf3b5c2007-12-03 21:02:03 +000016
Nick Coghlan8ecf5042012-07-15 21:19:18 +100017
Nick Coghlan761bb112012-07-14 23:59:22 +100018import runpy
Nick Coghlan260bd3e2009-11-16 06:49:25 +000019from runpy import _run_code, _run_module_code, run_module, run_path
Christian Heimescbf3b5c2007-12-03 21:02:03 +000020# Note: This module can't safely test _run_module_as_main as it
21# runs its tests in the current process, which would mess with the
22# real __main__ module (usually test.regrtest)
23# See test_cmd_line_script for a test that executes that code path
Thomas Woutersa9773292006-04-21 09:43:23 +000024
Thomas Woutersa9773292006-04-21 09:43:23 +000025
Nick Coghlan761bb112012-07-14 23:59:22 +100026# Set up the test code and expected results
27example_source = """\
28# Check basic code execution
29result = ['Top level assignment']
30def f():
31 result.append('Lower level reference')
32f()
33del f
34# Check the sys module
35import sys
36run_argv0 = sys.argv[0]
37run_name_in_sys_modules = __name__ in sys.modules
38module_in_sys_modules = (run_name_in_sys_modules and
39 globals() is sys.modules[__name__].__dict__)
40# Check nested operation
41import runpy
42nested = runpy._run_module_code('x=1\\n', mod_name='<run>')
43"""
44
45implicit_namespace = {
46 "__name__": None,
47 "__file__": None,
48 "__cached__": None,
49 "__package__": None,
50 "__doc__": None,
Nick Coghlan720c7e22013-12-15 20:33:02 +100051 "__spec__": None
Nick Coghlan761bb112012-07-14 23:59:22 +100052}
53example_namespace = {
54 "sys": sys,
55 "runpy": runpy,
56 "result": ["Top level assignment", "Lower level reference"],
57 "run_argv0": sys.argv[0],
58 "run_name_in_sys_modules": False,
59 "module_in_sys_modules": False,
60 "nested": dict(implicit_namespace,
Nick Coghlan720c7e22013-12-15 20:33:02 +100061 x=1, __name__="<run>", __loader__=None),
Nick Coghlan761bb112012-07-14 23:59:22 +100062}
63example_namespace.update(implicit_namespace)
64
65class CodeExecutionMixin:
66 # Issue #15230 (run_path not handling run_name correctly) highlighted a
67 # problem with the way arguments were being passed from higher level APIs
68 # down to lower level code. This mixin makes it easier to ensure full
69 # testing occurs at those upper layers as well, not just at the utility
70 # layer
71
Nick Coghlan720c7e22013-12-15 20:33:02 +100072 # Figuring out the loader details in advance is hard to do, so we skip
73 # checking the full details of loader and loader_state
74 CHECKED_SPEC_ATTRIBUTES = ["name", "parent", "origin", "cached",
75 "has_location", "submodule_search_locations"]
76
Nick Coghlan761bb112012-07-14 23:59:22 +100077 def assertNamespaceMatches(self, result_ns, expected_ns):
78 """Check two namespaces match.
79
80 Ignores any unspecified interpreter created names
81 """
Nick Coghlan720c7e22013-12-15 20:33:02 +100082 # Avoid side effects
83 result_ns = result_ns.copy()
84 expected_ns = expected_ns.copy()
Nick Coghlan761bb112012-07-14 23:59:22 +100085 # Impls are permitted to add extra names, so filter them out
86 for k in list(result_ns):
87 if k.startswith("__") and k.endswith("__"):
88 if k not in expected_ns:
89 result_ns.pop(k)
90 if k not in expected_ns["nested"]:
91 result_ns["nested"].pop(k)
Nick Coghlan720c7e22013-12-15 20:33:02 +100092 # Spec equality includes the loader, so we take the spec out of the
93 # result namespace and check that separately
94 result_spec = result_ns.pop("__spec__")
95 expected_spec = expected_ns.pop("__spec__")
96 if expected_spec is None:
97 self.assertIsNone(result_spec)
98 else:
99 # If an expected loader is set, we just check we got the right
100 # type, rather than checking for full equality
101 if expected_spec.loader is not None:
102 self.assertEqual(type(result_spec.loader),
103 type(expected_spec.loader))
104 for attr in self.CHECKED_SPEC_ATTRIBUTES:
105 k = "__spec__." + attr
106 actual = (k, getattr(result_spec, attr))
107 expected = (k, getattr(expected_spec, attr))
108 self.assertEqual(actual, expected)
109 # For the rest, we still don't use direct dict comparison on the
110 # namespace, as the diffs are too hard to debug if anything breaks
Nick Coghlan761bb112012-07-14 23:59:22 +1000111 self.assertEqual(set(result_ns), set(expected_ns))
112 for k in result_ns:
113 actual = (k, result_ns[k])
114 expected = (k, expected_ns[k])
115 self.assertEqual(actual, expected)
116
117 def check_code_execution(self, create_namespace, expected_namespace):
118 """Check that an interface runs the example code correctly
119
120 First argument is a callable accepting the initial globals and
121 using them to create the actual namespace
122 Second argument is the expected result
123 """
124 sentinel = object()
125 expected_ns = expected_namespace.copy()
126 run_name = expected_ns["__name__"]
127 saved_argv0 = sys.argv[0]
128 saved_mod = sys.modules.get(run_name, sentinel)
129 # Check without initial globals
130 result_ns = create_namespace(None)
131 self.assertNamespaceMatches(result_ns, expected_ns)
132 self.assertIs(sys.argv[0], saved_argv0)
133 self.assertIs(sys.modules.get(run_name, sentinel), saved_mod)
134 # And then with initial globals
135 initial_ns = {"sentinel": sentinel}
136 expected_ns["sentinel"] = sentinel
137 result_ns = create_namespace(initial_ns)
138 self.assertIsNot(result_ns, initial_ns)
139 self.assertNamespaceMatches(result_ns, expected_ns)
140 self.assertIs(sys.argv[0], saved_argv0)
141 self.assertIs(sys.modules.get(run_name, sentinel), saved_mod)
142
143
144class ExecutionLayerTestCase(unittest.TestCase, CodeExecutionMixin):
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000145 """Unit tests for runpy._run_code and runpy._run_module_code"""
Thomas Woutersa9773292006-04-21 09:43:23 +0000146
Thomas Woutersed03b412007-08-28 21:37:11 +0000147 def test_run_code(self):
Nick Coghlan761bb112012-07-14 23:59:22 +1000148 expected_ns = example_namespace.copy()
149 expected_ns.update({
150 "__loader__": None,
151 })
152 def create_ns(init_globals):
153 return _run_code(example_source, {}, init_globals)
154 self.check_code_execution(create_ns, expected_ns)
Thomas Woutersa9773292006-04-21 09:43:23 +0000155
156 def test_run_module_code(self):
Nick Coghlan761bb112012-07-14 23:59:22 +1000157 mod_name = "<Nonsense>"
158 mod_fname = "Some other nonsense"
159 mod_loader = "Now you're just being silly"
160 mod_package = '' # Treat as a top level module
Nick Coghlan720c7e22013-12-15 20:33:02 +1000161 mod_spec = importlib.machinery.ModuleSpec(mod_name,
162 origin=mod_fname,
163 loader=mod_loader)
Nick Coghlan761bb112012-07-14 23:59:22 +1000164 expected_ns = example_namespace.copy()
165 expected_ns.update({
166 "__name__": mod_name,
167 "__file__": mod_fname,
168 "__loader__": mod_loader,
169 "__package__": mod_package,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000170 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000171 "run_argv0": mod_fname,
172 "run_name_in_sys_modules": True,
173 "module_in_sys_modules": True,
174 })
175 def create_ns(init_globals):
176 return _run_module_code(example_source,
177 init_globals,
178 mod_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000179 mod_spec)
Nick Coghlan761bb112012-07-14 23:59:22 +1000180 self.check_code_execution(create_ns, expected_ns)
Thomas Woutersed03b412007-08-28 21:37:11 +0000181
Nick Coghlan8ecf5042012-07-15 21:19:18 +1000182# TODO: Use self.addCleanup to get rid of a lot of try-finally blocks
Nick Coghlan761bb112012-07-14 23:59:22 +1000183class RunModuleTestCase(unittest.TestCase, CodeExecutionMixin):
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000184 """Unit tests for runpy.run_module"""
Thomas Woutersa9773292006-04-21 09:43:23 +0000185
186 def expect_import_error(self, mod_name):
187 try:
188 run_module(mod_name)
189 except ImportError:
190 pass
191 else:
192 self.fail("Expected import error for " + mod_name)
193
194 def test_invalid_names(self):
Guido van Rossum806c2462007-08-06 23:33:07 +0000195 # Builtin module
Thomas Woutersa9773292006-04-21 09:43:23 +0000196 self.expect_import_error("sys")
Guido van Rossum806c2462007-08-06 23:33:07 +0000197 # Non-existent modules
Thomas Woutersa9773292006-04-21 09:43:23 +0000198 self.expect_import_error("sys.imp.eric")
199 self.expect_import_error("os.path.half")
200 self.expect_import_error("a.bee")
Martin Panter7dda4212015-12-10 06:47:06 +0000201 # Relative names not allowed
Thomas Woutersa9773292006-04-21 09:43:23 +0000202 self.expect_import_error(".howard")
203 self.expect_import_error("..eaten")
Martin Panter7dda4212015-12-10 06:47:06 +0000204 self.expect_import_error(".test_runpy")
205 self.expect_import_error(".unittest")
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000206 # Package without __main__.py
207 self.expect_import_error("multiprocessing")
Thomas Woutersa9773292006-04-21 09:43:23 +0000208
209 def test_library_module(self):
Nick Coghlan761bb112012-07-14 23:59:22 +1000210 self.assertEqual(run_module("runpy")["__name__"], "runpy")
Thomas Woutersa9773292006-04-21 09:43:23 +0000211
Nick Coghlan720c7e22013-12-15 20:33:02 +1000212 def _add_pkg_dir(self, pkg_dir, namespace=False):
Guido van Rossum806c2462007-08-06 23:33:07 +0000213 os.mkdir(pkg_dir)
Nick Coghlan720c7e22013-12-15 20:33:02 +1000214 if namespace:
215 return None
Skip Montanaro7a98be22007-08-16 14:35:24 +0000216 pkg_fname = os.path.join(pkg_dir, "__init__.py")
Victor Stinnerbf816222011-06-30 23:25:47 +0200217 create_empty_file(pkg_fname)
Guido van Rossum806c2462007-08-06 23:33:07 +0000218 return pkg_fname
219
Nick Coghlan720c7e22013-12-15 20:33:02 +1000220 def _make_pkg(self, source, depth, mod_base="runpy_test",
221 *, namespace=False, parent_namespaces=False):
222 # Enforce a couple of internal sanity checks on test cases
223 if (namespace or parent_namespaces) and not depth:
224 raise RuntimeError("Can't mark top level module as a "
225 "namespace package")
Thomas Woutersa9773292006-04-21 09:43:23 +0000226 pkg_name = "__runpy_pkg__"
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000227 test_fname = mod_base+os.extsep+"py"
Nick Coghlaneb3e62f2012-07-17 20:42:39 +1000228 pkg_dir = sub_dir = os.path.realpath(tempfile.mkdtemp())
Nick Coghlan761bb112012-07-14 23:59:22 +1000229 if verbose > 1: print(" Package tree in:", sub_dir)
Thomas Woutersa9773292006-04-21 09:43:23 +0000230 sys.path.insert(0, pkg_dir)
Nick Coghlan761bb112012-07-14 23:59:22 +1000231 if verbose > 1: print(" Updated sys.path:", sys.path[0])
Nick Coghlan720c7e22013-12-15 20:33:02 +1000232 if depth:
233 namespace_flags = [parent_namespaces] * depth
234 namespace_flags[-1] = namespace
235 for namespace_flag in namespace_flags:
236 sub_dir = os.path.join(sub_dir, pkg_name)
237 pkg_fname = self._add_pkg_dir(sub_dir, namespace_flag)
238 if verbose > 1: print(" Next level in:", sub_dir)
239 if verbose > 1: print(" Created:", pkg_fname)
Thomas Woutersa9773292006-04-21 09:43:23 +0000240 mod_fname = os.path.join(sub_dir, test_fname)
241 mod_file = open(mod_fname, "w")
242 mod_file.write(source)
243 mod_file.close()
Nick Coghlan761bb112012-07-14 23:59:22 +1000244 if verbose > 1: print(" Created:", mod_fname)
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000245 mod_name = (pkg_name+".")*depth + mod_base
Nick Coghlan720c7e22013-12-15 20:33:02 +1000246 mod_spec = importlib.util.spec_from_file_location(mod_name,
247 mod_fname)
248 return pkg_dir, mod_fname, mod_name, mod_spec
Thomas Woutersa9773292006-04-21 09:43:23 +0000249
Martin Panter9c8aa9b2016-08-21 04:07:58 +0000250 def _del_pkg(self, top):
Guido van Rossum806c2462007-08-06 23:33:07 +0000251 for entry in list(sys.modules):
252 if entry.startswith("__runpy_pkg__"):
Thomas Woutersa9773292006-04-21 09:43:23 +0000253 del sys.modules[entry]
Nick Coghlan761bb112012-07-14 23:59:22 +1000254 if verbose > 1: print(" Removed sys.modules entries")
Thomas Woutersa9773292006-04-21 09:43:23 +0000255 del sys.path[0]
Nick Coghlan761bb112012-07-14 23:59:22 +1000256 if verbose > 1: print(" Removed sys.path entry")
Thomas Woutersa9773292006-04-21 09:43:23 +0000257 for root, dirs, files in os.walk(top, topdown=False):
258 for name in files:
259 try:
260 os.remove(os.path.join(root, name))
Guido van Rossumb940e112007-01-10 16:19:56 +0000261 except OSError as ex:
Nick Coghlan761bb112012-07-14 23:59:22 +1000262 if verbose > 1: print(ex) # Persist with cleaning up
Thomas Woutersa9773292006-04-21 09:43:23 +0000263 for name in dirs:
264 fullname = os.path.join(root, name)
265 try:
266 os.rmdir(fullname)
Guido van Rossumb940e112007-01-10 16:19:56 +0000267 except OSError as ex:
Nick Coghlan761bb112012-07-14 23:59:22 +1000268 if verbose > 1: print(ex) # Persist with cleaning up
Thomas Woutersa9773292006-04-21 09:43:23 +0000269 try:
270 os.rmdir(top)
Nick Coghlan761bb112012-07-14 23:59:22 +1000271 if verbose > 1: print(" Removed package tree")
Guido van Rossumb940e112007-01-10 16:19:56 +0000272 except OSError as ex:
Nick Coghlan761bb112012-07-14 23:59:22 +1000273 if verbose > 1: print(ex) # Persist with cleaning up
Thomas Woutersa9773292006-04-21 09:43:23 +0000274
Nick Coghlan761bb112012-07-14 23:59:22 +1000275 def _fix_ns_for_legacy_pyc(self, ns, alter_sys):
Brett Cannonf299abd2015-04-13 14:21:02 -0400276 char_to_add = "c"
Nick Coghlan761bb112012-07-14 23:59:22 +1000277 ns["__file__"] += char_to_add
Nick Coghlan720c7e22013-12-15 20:33:02 +1000278 ns["__cached__"] = ns["__file__"]
279 spec = ns["__spec__"]
280 new_spec = importlib.util.spec_from_file_location(spec.name,
281 ns["__file__"])
282 ns["__spec__"] = new_spec
Nick Coghlan761bb112012-07-14 23:59:22 +1000283 if alter_sys:
284 ns["run_argv0"] += char_to_add
285
286
Nick Coghlan720c7e22013-12-15 20:33:02 +1000287 def _check_module(self, depth, alter_sys=False,
288 *, namespace=False, parent_namespaces=False):
289 pkg_dir, mod_fname, mod_name, mod_spec = (
290 self._make_pkg(example_source, depth,
291 namespace=namespace,
292 parent_namespaces=parent_namespaces))
Guido van Rossum04110fb2007-08-24 16:32:05 +0000293 forget(mod_name)
Nick Coghlan761bb112012-07-14 23:59:22 +1000294 expected_ns = example_namespace.copy()
295 expected_ns.update({
296 "__name__": mod_name,
297 "__file__": mod_fname,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000298 "__cached__": mod_spec.cached,
Nick Coghlan761bb112012-07-14 23:59:22 +1000299 "__package__": mod_name.rpartition(".")[0],
Nick Coghlan720c7e22013-12-15 20:33:02 +1000300 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000301 })
302 if alter_sys:
303 expected_ns.update({
304 "run_argv0": mod_fname,
305 "run_name_in_sys_modules": True,
306 "module_in_sys_modules": True,
307 })
308 def create_ns(init_globals):
309 return run_module(mod_name, init_globals, alter_sys=alter_sys)
Thomas Woutersa9773292006-04-21 09:43:23 +0000310 try:
Nick Coghlan761bb112012-07-14 23:59:22 +1000311 if verbose > 1: print("Running from source:", mod_name)
312 self.check_code_execution(create_ns, expected_ns)
Brett Cannonfd074152012-04-14 14:10:13 -0400313 importlib.invalidate_caches()
Thomas Woutersa9773292006-04-21 09:43:23 +0000314 __import__(mod_name)
315 os.remove(mod_fname)
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200316 if not sys.dont_write_bytecode:
317 make_legacy_pyc(mod_fname)
318 unload(mod_name) # In case loader caches paths
Ezio Melottie5e7a7c2013-03-16 21:49:20 +0200319 importlib.invalidate_caches()
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200320 if verbose > 1: print("Running from compiled:", mod_name)
321 self._fix_ns_for_legacy_pyc(expected_ns, alter_sys)
322 self.check_code_execution(create_ns, expected_ns)
Thomas Woutersa9773292006-04-21 09:43:23 +0000323 finally:
Martin Panter9c8aa9b2016-08-21 04:07:58 +0000324 self._del_pkg(pkg_dir)
Nick Coghlan761bb112012-07-14 23:59:22 +1000325 if verbose > 1: print("Module executed successfully")
Thomas Woutersa9773292006-04-21 09:43:23 +0000326
Nick Coghlan720c7e22013-12-15 20:33:02 +1000327 def _check_package(self, depth, alter_sys=False,
328 *, namespace=False, parent_namespaces=False):
329 pkg_dir, mod_fname, mod_name, mod_spec = (
330 self._make_pkg(example_source, depth, "__main__",
331 namespace=namespace,
332 parent_namespaces=parent_namespaces))
Nick Coghlan761bb112012-07-14 23:59:22 +1000333 pkg_name = mod_name.rpartition(".")[0]
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000334 forget(mod_name)
Nick Coghlan761bb112012-07-14 23:59:22 +1000335 expected_ns = example_namespace.copy()
336 expected_ns.update({
337 "__name__": mod_name,
338 "__file__": mod_fname,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000339 "__cached__": importlib.util.cache_from_source(mod_fname),
Nick Coghlan761bb112012-07-14 23:59:22 +1000340 "__package__": pkg_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000341 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000342 })
343 if alter_sys:
344 expected_ns.update({
345 "run_argv0": mod_fname,
346 "run_name_in_sys_modules": True,
347 "module_in_sys_modules": True,
348 })
349 def create_ns(init_globals):
350 return run_module(pkg_name, init_globals, alter_sys=alter_sys)
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000351 try:
Nick Coghlan761bb112012-07-14 23:59:22 +1000352 if verbose > 1: print("Running from source:", pkg_name)
353 self.check_code_execution(create_ns, expected_ns)
Brett Cannonfd074152012-04-14 14:10:13 -0400354 importlib.invalidate_caches()
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000355 __import__(mod_name)
356 os.remove(mod_fname)
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200357 if not sys.dont_write_bytecode:
358 make_legacy_pyc(mod_fname)
359 unload(mod_name) # In case loader caches paths
360 if verbose > 1: print("Running from compiled:", pkg_name)
Ezio Melottie5e7a7c2013-03-16 21:49:20 +0200361 importlib.invalidate_caches()
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200362 self._fix_ns_for_legacy_pyc(expected_ns, alter_sys)
363 self.check_code_execution(create_ns, expected_ns)
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000364 finally:
Martin Panter9c8aa9b2016-08-21 04:07:58 +0000365 self._del_pkg(pkg_dir)
Nick Coghlan761bb112012-07-14 23:59:22 +1000366 if verbose > 1: print("Package executed successfully")
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000367
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000368 def _add_relative_modules(self, base_dir, source, depth):
Guido van Rossum806c2462007-08-06 23:33:07 +0000369 if depth <= 1:
370 raise ValueError("Relative module test needs depth > 1")
371 pkg_name = "__runpy_pkg__"
372 module_dir = base_dir
373 for i in range(depth):
374 parent_dir = module_dir
375 module_dir = os.path.join(module_dir, pkg_name)
376 # Add sibling module
Skip Montanaro7a98be22007-08-16 14:35:24 +0000377 sibling_fname = os.path.join(module_dir, "sibling.py")
Victor Stinnerbf816222011-06-30 23:25:47 +0200378 create_empty_file(sibling_fname)
Nick Coghlan761bb112012-07-14 23:59:22 +1000379 if verbose > 1: print(" Added sibling module:", sibling_fname)
Guido van Rossum806c2462007-08-06 23:33:07 +0000380 # Add nephew module
381 uncle_dir = os.path.join(parent_dir, "uncle")
382 self._add_pkg_dir(uncle_dir)
Nick Coghlan761bb112012-07-14 23:59:22 +1000383 if verbose > 1: print(" Added uncle package:", uncle_dir)
Guido van Rossum806c2462007-08-06 23:33:07 +0000384 cousin_dir = os.path.join(uncle_dir, "cousin")
385 self._add_pkg_dir(cousin_dir)
Nick Coghlan761bb112012-07-14 23:59:22 +1000386 if verbose > 1: print(" Added cousin package:", cousin_dir)
Skip Montanaro7a98be22007-08-16 14:35:24 +0000387 nephew_fname = os.path.join(cousin_dir, "nephew.py")
Victor Stinnerbf816222011-06-30 23:25:47 +0200388 create_empty_file(nephew_fname)
Nick Coghlan761bb112012-07-14 23:59:22 +1000389 if verbose > 1: print(" Added nephew module:", nephew_fname)
Guido van Rossum806c2462007-08-06 23:33:07 +0000390
391 def _check_relative_imports(self, depth, run_name=None):
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000392 contents = r"""\
Guido van Rossum806c2462007-08-06 23:33:07 +0000393from __future__ import absolute_import
394from . import sibling
395from ..uncle.cousin import nephew
396"""
Nick Coghlan720c7e22013-12-15 20:33:02 +1000397 pkg_dir, mod_fname, mod_name, mod_spec = (
Guido van Rossum806c2462007-08-06 23:33:07 +0000398 self._make_pkg(contents, depth))
Nick Coghlan761bb112012-07-14 23:59:22 +1000399 if run_name is None:
400 expected_name = mod_name
401 else:
402 expected_name = run_name
Guido van Rossum806c2462007-08-06 23:33:07 +0000403 try:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000404 self._add_relative_modules(pkg_dir, contents, depth)
405 pkg_name = mod_name.rpartition('.')[0]
Nick Coghlan761bb112012-07-14 23:59:22 +1000406 if verbose > 1: print("Running from source:", mod_name)
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000407 d1 = run_module(mod_name, run_name=run_name) # Read from source
Nick Coghlan761bb112012-07-14 23:59:22 +1000408 self.assertEqual(d1["__name__"], expected_name)
409 self.assertEqual(d1["__package__"], pkg_name)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000410 self.assertIn("sibling", d1)
411 self.assertIn("nephew", d1)
Guido van Rossum806c2462007-08-06 23:33:07 +0000412 del d1 # Ensure __loader__ entry doesn't keep file open
Brett Cannonfd074152012-04-14 14:10:13 -0400413 importlib.invalidate_caches()
Guido van Rossum806c2462007-08-06 23:33:07 +0000414 __import__(mod_name)
415 os.remove(mod_fname)
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200416 if not sys.dont_write_bytecode:
417 make_legacy_pyc(mod_fname)
418 unload(mod_name) # In case the loader caches paths
419 if verbose > 1: print("Running from compiled:", mod_name)
Ezio Melottie5e7a7c2013-03-16 21:49:20 +0200420 importlib.invalidate_caches()
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200421 d2 = run_module(mod_name, run_name=run_name) # Read from bytecode
422 self.assertEqual(d2["__name__"], expected_name)
423 self.assertEqual(d2["__package__"], pkg_name)
424 self.assertIn("sibling", d2)
425 self.assertIn("nephew", d2)
426 del d2 # Ensure __loader__ entry doesn't keep file open
Guido van Rossum806c2462007-08-06 23:33:07 +0000427 finally:
Martin Panter9c8aa9b2016-08-21 04:07:58 +0000428 self._del_pkg(pkg_dir)
Nick Coghlan761bb112012-07-14 23:59:22 +1000429 if verbose > 1: print("Module executed successfully")
Guido van Rossum806c2462007-08-06 23:33:07 +0000430
Thomas Woutersa9773292006-04-21 09:43:23 +0000431 def test_run_module(self):
432 for depth in range(4):
Nick Coghlan761bb112012-07-14 23:59:22 +1000433 if verbose > 1: print("Testing package depth:", depth)
Thomas Woutersa9773292006-04-21 09:43:23 +0000434 self._check_module(depth)
435
Nick Coghlan720c7e22013-12-15 20:33:02 +1000436 def test_run_module_in_namespace_package(self):
437 for depth in range(1, 4):
438 if verbose > 1: print("Testing package depth:", depth)
439 self._check_module(depth, namespace=True, parent_namespaces=True)
440
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000441 def test_run_package(self):
442 for depth in range(1, 4):
Nick Coghlan761bb112012-07-14 23:59:22 +1000443 if verbose > 1: print("Testing package depth:", depth)
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000444 self._check_package(depth)
445
Martin Panter657257e2015-12-03 01:23:10 +0000446 def test_run_package_init_exceptions(self):
447 # These were previously wrapped in an ImportError; see Issue 14285
448 result = self._make_pkg("", 1, "__main__")
449 pkg_dir, _, mod_name, _ = result
450 mod_name = mod_name.replace(".__main__", "")
Martin Panter9c8aa9b2016-08-21 04:07:58 +0000451 self.addCleanup(self._del_pkg, pkg_dir)
Martin Panter657257e2015-12-03 01:23:10 +0000452 init = os.path.join(pkg_dir, "__runpy_pkg__", "__init__.py")
453
454 exceptions = (ImportError, AttributeError, TypeError, ValueError)
455 for exception in exceptions:
456 name = exception.__name__
457 with self.subTest(name):
458 source = "raise {0}('{0} in __init__.py.')".format(name)
459 with open(init, "wt", encoding="ascii") as mod_file:
460 mod_file.write(source)
461 try:
462 run_module(mod_name)
463 except exception as err:
464 self.assertNotIn("finding spec", format(err))
465 else:
466 self.fail("Nothing raised; expected {}".format(name))
Martin Panter7dda4212015-12-10 06:47:06 +0000467 try:
468 run_module(mod_name + ".submodule")
469 except exception as err:
470 self.assertNotIn("finding spec", format(err))
471 else:
472 self.fail("Nothing raised; expected {}".format(name))
Martin Panter657257e2015-12-03 01:23:10 +0000473
Martin Panter9c8aa9b2016-08-21 04:07:58 +0000474 def test_submodule_imported_warning(self):
475 pkg_dir, _, mod_name, _ = self._make_pkg("", 1)
476 try:
477 __import__(mod_name)
478 with self.assertWarnsRegex(RuntimeWarning,
479 r"found in sys\.modules"):
480 run_module(mod_name)
481 finally:
482 self._del_pkg(pkg_dir)
483
484 def test_package_imported_no_warning(self):
485 pkg_dir, _, mod_name, _ = self._make_pkg("", 1, "__main__")
486 self.addCleanup(self._del_pkg, pkg_dir)
487 package = mod_name.replace(".__main__", "")
488 # No warning should occur if we only imported the parent package
489 __import__(package)
490 self.assertIn(package, sys.modules)
491 with warnings.catch_warnings():
492 warnings.simplefilter("error", RuntimeWarning)
493 run_module(package)
494 # But the warning should occur if we imported the __main__ submodule
495 __import__(mod_name)
496 with self.assertWarnsRegex(RuntimeWarning, r"found in sys\.modules"):
497 run_module(package)
498
Nick Coghlan720c7e22013-12-15 20:33:02 +1000499 def test_run_package_in_namespace_package(self):
500 for depth in range(1, 4):
501 if verbose > 1: print("Testing package depth:", depth)
502 self._check_package(depth, parent_namespaces=True)
503
504 def test_run_namespace_package(self):
505 for depth in range(1, 4):
506 if verbose > 1: print("Testing package depth:", depth)
507 self._check_package(depth, namespace=True)
508
509 def test_run_namespace_package_in_namespace_package(self):
510 for depth in range(1, 4):
511 if verbose > 1: print("Testing package depth:", depth)
512 self._check_package(depth, namespace=True, parent_namespaces=True)
513
Nick Coghlan761bb112012-07-14 23:59:22 +1000514 def test_run_module_alter_sys(self):
515 for depth in range(4):
516 if verbose > 1: print("Testing package depth:", depth)
517 self._check_module(depth, alter_sys=True)
518
519 def test_run_package_alter_sys(self):
520 for depth in range(1, 4):
521 if verbose > 1: print("Testing package depth:", depth)
522 self._check_package(depth, alter_sys=True)
523
Guido van Rossum806c2462007-08-06 23:33:07 +0000524 def test_explicit_relative_import(self):
525 for depth in range(2, 5):
Nick Coghlan761bb112012-07-14 23:59:22 +1000526 if verbose > 1: print("Testing relative imports at depth:", depth)
Guido van Rossum806c2462007-08-06 23:33:07 +0000527 self._check_relative_imports(depth)
528
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000529 def test_main_relative_import(self):
530 for depth in range(2, 5):
Nick Coghlan761bb112012-07-14 23:59:22 +1000531 if verbose > 1: print("Testing main relative imports at depth:", depth)
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000532 self._check_relative_imports(depth, "__main__")
533
Nick Coghlan761bb112012-07-14 23:59:22 +1000534 def test_run_name(self):
535 depth = 1
536 run_name = "And now for something completely different"
Nick Coghlan720c7e22013-12-15 20:33:02 +1000537 pkg_dir, mod_fname, mod_name, mod_spec = (
Nick Coghlan761bb112012-07-14 23:59:22 +1000538 self._make_pkg(example_source, depth))
539 forget(mod_name)
540 expected_ns = example_namespace.copy()
541 expected_ns.update({
542 "__name__": run_name,
543 "__file__": mod_fname,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000544 "__cached__": importlib.util.cache_from_source(mod_fname),
Nick Coghlan761bb112012-07-14 23:59:22 +1000545 "__package__": mod_name.rpartition(".")[0],
Nick Coghlan720c7e22013-12-15 20:33:02 +1000546 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000547 })
548 def create_ns(init_globals):
549 return run_module(mod_name, init_globals, run_name)
550 try:
551 self.check_code_execution(create_ns, expected_ns)
552 finally:
Martin Panter9c8aa9b2016-08-21 04:07:58 +0000553 self._del_pkg(pkg_dir)
Thomas Woutersa9773292006-04-21 09:43:23 +0000554
Nick Coghlan8ecf5042012-07-15 21:19:18 +1000555 def test_pkgutil_walk_packages(self):
556 # This is a dodgy hack to use the test_runpy infrastructure to test
557 # issue #15343. Issue #15348 declares this is indeed a dodgy hack ;)
558 import pkgutil
559 max_depth = 4
560 base_name = "__runpy_pkg__"
561 package_suffixes = ["uncle", "uncle.cousin"]
562 module_suffixes = ["uncle.cousin.nephew", base_name + ".sibling"]
563 expected_packages = set()
564 expected_modules = set()
565 for depth in range(1, max_depth):
566 pkg_name = ".".join([base_name] * depth)
567 expected_packages.add(pkg_name)
568 for name in package_suffixes:
569 expected_packages.add(pkg_name + "." + name)
570 for name in module_suffixes:
571 expected_modules.add(pkg_name + "." + name)
572 pkg_name = ".".join([base_name] * max_depth)
573 expected_packages.add(pkg_name)
574 expected_modules.add(pkg_name + ".runpy_test")
Nick Coghlan720c7e22013-12-15 20:33:02 +1000575 pkg_dir, mod_fname, mod_name, mod_spec = (
Nick Coghlan8ecf5042012-07-15 21:19:18 +1000576 self._make_pkg("", max_depth))
Martin Panter9c8aa9b2016-08-21 04:07:58 +0000577 self.addCleanup(self._del_pkg, pkg_dir)
Nick Coghlan8ecf5042012-07-15 21:19:18 +1000578 for depth in range(2, max_depth+1):
579 self._add_relative_modules(pkg_dir, "", depth)
580 for finder, mod_name, ispkg in pkgutil.walk_packages([pkg_dir]):
581 self.assertIsInstance(finder,
582 importlib.machinery.FileFinder)
583 if ispkg:
584 expected_packages.remove(mod_name)
585 else:
586 expected_modules.remove(mod_name)
587 self.assertEqual(len(expected_packages), 0, expected_packages)
588 self.assertEqual(len(expected_modules), 0, expected_modules)
Nick Coghlan761bb112012-07-14 23:59:22 +1000589
590class RunPathTestCase(unittest.TestCase, CodeExecutionMixin):
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000591 """Unit tests for runpy.run_path"""
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000592
Nick Coghlan720c7e22013-12-15 20:33:02 +1000593 def _make_test_script(self, script_dir, script_basename,
594 source=None, omit_suffix=False):
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000595 if source is None:
Nick Coghlan761bb112012-07-14 23:59:22 +1000596 source = example_source
Nick Coghlan720c7e22013-12-15 20:33:02 +1000597 return make_script(script_dir, script_basename,
598 source, omit_suffix)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000599
600 def _check_script(self, script_name, expected_name, expected_file,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000601 expected_argv0, mod_name=None,
602 expect_spec=True, check_loader=True):
Nick Coghlan761bb112012-07-14 23:59:22 +1000603 # First check is without run_name
604 def create_ns(init_globals):
605 return run_path(script_name, init_globals)
606 expected_ns = example_namespace.copy()
Nick Coghlan720c7e22013-12-15 20:33:02 +1000607 if mod_name is None:
608 spec_name = expected_name
609 else:
610 spec_name = mod_name
611 if expect_spec:
612 mod_spec = importlib.util.spec_from_file_location(spec_name,
613 expected_file)
614 mod_cached = mod_spec.cached
615 if not check_loader:
616 mod_spec.loader = None
617 else:
618 mod_spec = mod_cached = None
619
Nick Coghlan761bb112012-07-14 23:59:22 +1000620 expected_ns.update({
621 "__name__": expected_name,
622 "__file__": expected_file,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000623 "__cached__": mod_cached,
Nick Coghlan761bb112012-07-14 23:59:22 +1000624 "__package__": "",
Nick Coghlan720c7e22013-12-15 20:33:02 +1000625 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000626 "run_argv0": expected_argv0,
627 "run_name_in_sys_modules": True,
628 "module_in_sys_modules": True,
629 })
630 self.check_code_execution(create_ns, expected_ns)
631 # Second check makes sure run_name works in all cases
632 run_name = "prove.issue15230.is.fixed"
633 def create_ns(init_globals):
634 return run_path(script_name, init_globals, run_name)
Nick Coghlan720c7e22013-12-15 20:33:02 +1000635 if expect_spec and mod_name is None:
636 mod_spec = importlib.util.spec_from_file_location(run_name,
637 expected_file)
638 if not check_loader:
639 mod_spec.loader = None
640 expected_ns["__spec__"] = mod_spec
Nick Coghlan761bb112012-07-14 23:59:22 +1000641 expected_ns["__name__"] = run_name
642 expected_ns["__package__"] = run_name.rpartition(".")[0]
643 self.check_code_execution(create_ns, expected_ns)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000644
645 def _check_import_error(self, script_name, msg):
Nick Coghlan16eb0fb2009-11-18 11:35:25 +0000646 msg = re.escape(msg)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000647 self.assertRaisesRegex(ImportError, msg, run_path, script_name)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000648
649 def test_basic_script(self):
650 with temp_dir() as script_dir:
651 mod_name = 'script'
652 script_name = self._make_test_script(script_dir, mod_name)
653 self._check_script(script_name, "<run_path>", script_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000654 script_name, expect_spec=False)
655
656 def test_basic_script_no_suffix(self):
657 with temp_dir() as script_dir:
658 mod_name = 'script'
659 script_name = self._make_test_script(script_dir, mod_name,
660 omit_suffix=True)
661 self._check_script(script_name, "<run_path>", script_name,
662 script_name, expect_spec=False)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000663
664 def test_script_compiled(self):
665 with temp_dir() as script_dir:
666 mod_name = 'script'
667 script_name = self._make_test_script(script_dir, mod_name)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000668 compiled_name = py_compile.compile(script_name, doraise=True)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000669 os.remove(script_name)
670 self._check_script(compiled_name, "<run_path>", compiled_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000671 compiled_name, expect_spec=False)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000672
673 def test_directory(self):
674 with temp_dir() as script_dir:
675 mod_name = '__main__'
676 script_name = self._make_test_script(script_dir, mod_name)
677 self._check_script(script_dir, "<run_path>", script_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000678 script_dir, mod_name=mod_name)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000679
680 def test_directory_compiled(self):
681 with temp_dir() as script_dir:
682 mod_name = '__main__'
683 script_name = self._make_test_script(script_dir, mod_name)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000684 compiled_name = py_compile.compile(script_name, doraise=True)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000685 os.remove(script_name)
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200686 if not sys.dont_write_bytecode:
687 legacy_pyc = make_legacy_pyc(script_name)
688 self._check_script(script_dir, "<run_path>", legacy_pyc,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000689 script_dir, mod_name=mod_name)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000690
691 def test_directory_error(self):
692 with temp_dir() as script_dir:
693 mod_name = 'not_main'
694 script_name = self._make_test_script(script_dir, mod_name)
695 msg = "can't find '__main__' module in %r" % script_dir
696 self._check_import_error(script_dir, msg)
697
698 def test_zipfile(self):
699 with temp_dir() as script_dir:
700 mod_name = '__main__'
701 script_name = self._make_test_script(script_dir, mod_name)
702 zip_name, fname = make_zip_script(script_dir, 'test_zip', script_name)
Nick Coghlan720c7e22013-12-15 20:33:02 +1000703 self._check_script(zip_name, "<run_path>", fname, zip_name,
704 mod_name=mod_name, check_loader=False)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000705
706 def test_zipfile_compiled(self):
707 with temp_dir() as script_dir:
708 mod_name = '__main__'
709 script_name = self._make_test_script(script_dir, mod_name)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000710 compiled_name = py_compile.compile(script_name, doraise=True)
711 zip_name, fname = make_zip_script(script_dir, 'test_zip',
712 compiled_name)
Nick Coghlan720c7e22013-12-15 20:33:02 +1000713 self._check_script(zip_name, "<run_path>", fname, zip_name,
714 mod_name=mod_name, check_loader=False)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000715
716 def test_zipfile_error(self):
717 with temp_dir() as script_dir:
718 mod_name = 'not_main'
719 script_name = self._make_test_script(script_dir, mod_name)
720 zip_name, fname = make_zip_script(script_dir, 'test_zip', script_name)
721 msg = "can't find '__main__' module in %r" % zip_name
722 self._check_import_error(zip_name, msg)
723
Brett Cannon31f59292011-02-21 19:29:56 +0000724 @no_tracing
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000725 def test_main_recursion_error(self):
726 with temp_dir() as script_dir, temp_dir() as dummy_dir:
727 mod_name = '__main__'
728 source = ("import runpy\n"
729 "runpy.run_path(%r)\n") % dummy_dir
730 script_name = self._make_test_script(script_dir, mod_name, source)
731 zip_name, fname = make_zip_script(script_dir, 'test_zip', script_name)
732 msg = "recursion depth exceeded"
Yury Selivanovf488fb42015-07-03 01:04:23 -0400733 self.assertRaisesRegex(RecursionError, msg, run_path, zip_name)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000734
Victor Stinner6c471022011-07-04 01:45:39 +0200735 def test_encoding(self):
736 with temp_dir() as script_dir:
737 filename = os.path.join(script_dir, 'script.py')
738 with open(filename, 'w', encoding='latin1') as f:
739 f.write("""
740#coding:latin1
Benjamin Peterson951a9e32012-10-12 11:44:10 -0400741s = "non-ASCII: h\xe9"
Victor Stinner6c471022011-07-04 01:45:39 +0200742""")
743 result = run_path(filename)
Benjamin Peterson951a9e32012-10-12 11:44:10 -0400744 self.assertEqual(result['s'], "non-ASCII: h\xe9")
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000745
746
Thomas Woutersa9773292006-04-21 09:43:23 +0000747if __name__ == "__main__":
Brett Cannon3e9a9ae2013-06-12 21:25:59 -0400748 unittest.main()