blob: 786b813b32e7e2e723594e4b32c6e25ef5e329de [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
Brett Cannon31f59292011-02-21 19:29:56 +000010from test.support import (
Victor Stinnerbf816222011-06-30 23:25:47 +020011 forget, make_legacy_pyc, run_unittest, unload, verbose, no_tracing,
12 create_empty_file)
Barry Warsaw28a691b2010-04-17 00:19:56 +000013from test.script_helper import (
14 make_pkg, make_script, make_zip_pkg, make_zip_script, temp_dir)
Christian Heimescbf3b5c2007-12-03 21:02:03 +000015
Nick Coghlan8ecf5042012-07-15 21:19:18 +100016
Nick Coghlan761bb112012-07-14 23:59:22 +100017import runpy
Nick Coghlan260bd3e2009-11-16 06:49:25 +000018from runpy import _run_code, _run_module_code, run_module, run_path
Christian Heimescbf3b5c2007-12-03 21:02:03 +000019# Note: This module can't safely test _run_module_as_main as it
20# runs its tests in the current process, which would mess with the
21# real __main__ module (usually test.regrtest)
22# See test_cmd_line_script for a test that executes that code path
Thomas Woutersa9773292006-04-21 09:43:23 +000023
Thomas Woutersa9773292006-04-21 09:43:23 +000024
Nick Coghlan761bb112012-07-14 23:59:22 +100025# Set up the test code and expected results
26example_source = """\
27# Check basic code execution
28result = ['Top level assignment']
29def f():
30 result.append('Lower level reference')
31f()
32del f
33# Check the sys module
34import sys
35run_argv0 = sys.argv[0]
36run_name_in_sys_modules = __name__ in sys.modules
37module_in_sys_modules = (run_name_in_sys_modules and
38 globals() is sys.modules[__name__].__dict__)
39# Check nested operation
40import runpy
41nested = runpy._run_module_code('x=1\\n', mod_name='<run>')
42"""
43
44implicit_namespace = {
45 "__name__": None,
46 "__file__": None,
47 "__cached__": None,
48 "__package__": None,
49 "__doc__": None,
Nick Coghlan720c7e22013-12-15 20:33:02 +100050 "__spec__": None
Nick Coghlan761bb112012-07-14 23:59:22 +100051}
52example_namespace = {
53 "sys": sys,
54 "runpy": runpy,
55 "result": ["Top level assignment", "Lower level reference"],
56 "run_argv0": sys.argv[0],
57 "run_name_in_sys_modules": False,
58 "module_in_sys_modules": False,
59 "nested": dict(implicit_namespace,
Nick Coghlan720c7e22013-12-15 20:33:02 +100060 x=1, __name__="<run>", __loader__=None),
Nick Coghlan761bb112012-07-14 23:59:22 +100061}
62example_namespace.update(implicit_namespace)
63
64class CodeExecutionMixin:
65 # Issue #15230 (run_path not handling run_name correctly) highlighted a
66 # problem with the way arguments were being passed from higher level APIs
67 # down to lower level code. This mixin makes it easier to ensure full
68 # testing occurs at those upper layers as well, not just at the utility
69 # layer
70
Nick Coghlan720c7e22013-12-15 20:33:02 +100071 # Figuring out the loader details in advance is hard to do, so we skip
72 # checking the full details of loader and loader_state
73 CHECKED_SPEC_ATTRIBUTES = ["name", "parent", "origin", "cached",
74 "has_location", "submodule_search_locations"]
75
Nick Coghlan761bb112012-07-14 23:59:22 +100076 def assertNamespaceMatches(self, result_ns, expected_ns):
77 """Check two namespaces match.
78
79 Ignores any unspecified interpreter created names
80 """
Nick Coghlan720c7e22013-12-15 20:33:02 +100081 # Avoid side effects
82 result_ns = result_ns.copy()
83 expected_ns = expected_ns.copy()
Nick Coghlan761bb112012-07-14 23:59:22 +100084 # Impls are permitted to add extra names, so filter them out
85 for k in list(result_ns):
86 if k.startswith("__") and k.endswith("__"):
87 if k not in expected_ns:
88 result_ns.pop(k)
89 if k not in expected_ns["nested"]:
90 result_ns["nested"].pop(k)
Nick Coghlan720c7e22013-12-15 20:33:02 +100091 # Spec equality includes the loader, so we take the spec out of the
92 # result namespace and check that separately
93 result_spec = result_ns.pop("__spec__")
94 expected_spec = expected_ns.pop("__spec__")
95 if expected_spec is None:
96 self.assertIsNone(result_spec)
97 else:
98 # If an expected loader is set, we just check we got the right
99 # type, rather than checking for full equality
100 if expected_spec.loader is not None:
101 self.assertEqual(type(result_spec.loader),
102 type(expected_spec.loader))
103 for attr in self.CHECKED_SPEC_ATTRIBUTES:
104 k = "__spec__." + attr
105 actual = (k, getattr(result_spec, attr))
106 expected = (k, getattr(expected_spec, attr))
107 self.assertEqual(actual, expected)
108 # For the rest, we still don't use direct dict comparison on the
109 # namespace, as the diffs are too hard to debug if anything breaks
Nick Coghlan761bb112012-07-14 23:59:22 +1000110 self.assertEqual(set(result_ns), set(expected_ns))
111 for k in result_ns:
112 actual = (k, result_ns[k])
113 expected = (k, expected_ns[k])
114 self.assertEqual(actual, expected)
115
116 def check_code_execution(self, create_namespace, expected_namespace):
117 """Check that an interface runs the example code correctly
118
119 First argument is a callable accepting the initial globals and
120 using them to create the actual namespace
121 Second argument is the expected result
122 """
123 sentinel = object()
124 expected_ns = expected_namespace.copy()
125 run_name = expected_ns["__name__"]
126 saved_argv0 = sys.argv[0]
127 saved_mod = sys.modules.get(run_name, sentinel)
128 # Check without initial globals
129 result_ns = create_namespace(None)
130 self.assertNamespaceMatches(result_ns, expected_ns)
131 self.assertIs(sys.argv[0], saved_argv0)
132 self.assertIs(sys.modules.get(run_name, sentinel), saved_mod)
133 # And then with initial globals
134 initial_ns = {"sentinel": sentinel}
135 expected_ns["sentinel"] = sentinel
136 result_ns = create_namespace(initial_ns)
137 self.assertIsNot(result_ns, initial_ns)
138 self.assertNamespaceMatches(result_ns, expected_ns)
139 self.assertIs(sys.argv[0], saved_argv0)
140 self.assertIs(sys.modules.get(run_name, sentinel), saved_mod)
141
142
143class ExecutionLayerTestCase(unittest.TestCase, CodeExecutionMixin):
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000144 """Unit tests for runpy._run_code and runpy._run_module_code"""
Thomas Woutersa9773292006-04-21 09:43:23 +0000145
Thomas Woutersed03b412007-08-28 21:37:11 +0000146 def test_run_code(self):
Nick Coghlan761bb112012-07-14 23:59:22 +1000147 expected_ns = example_namespace.copy()
148 expected_ns.update({
149 "__loader__": None,
150 })
151 def create_ns(init_globals):
152 return _run_code(example_source, {}, init_globals)
153 self.check_code_execution(create_ns, expected_ns)
Thomas Woutersa9773292006-04-21 09:43:23 +0000154
155 def test_run_module_code(self):
Nick Coghlan761bb112012-07-14 23:59:22 +1000156 mod_name = "<Nonsense>"
157 mod_fname = "Some other nonsense"
158 mod_loader = "Now you're just being silly"
159 mod_package = '' # Treat as a top level module
Nick Coghlan720c7e22013-12-15 20:33:02 +1000160 mod_spec = importlib.machinery.ModuleSpec(mod_name,
161 origin=mod_fname,
162 loader=mod_loader)
Nick Coghlan761bb112012-07-14 23:59:22 +1000163 expected_ns = example_namespace.copy()
164 expected_ns.update({
165 "__name__": mod_name,
166 "__file__": mod_fname,
167 "__loader__": mod_loader,
168 "__package__": mod_package,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000169 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000170 "run_argv0": mod_fname,
171 "run_name_in_sys_modules": True,
172 "module_in_sys_modules": True,
173 })
174 def create_ns(init_globals):
175 return _run_module_code(example_source,
176 init_globals,
177 mod_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000178 mod_spec)
Nick Coghlan761bb112012-07-14 23:59:22 +1000179 self.check_code_execution(create_ns, expected_ns)
Thomas Woutersed03b412007-08-28 21:37:11 +0000180
Nick Coghlan8ecf5042012-07-15 21:19:18 +1000181# TODO: Use self.addCleanup to get rid of a lot of try-finally blocks
Nick Coghlan761bb112012-07-14 23:59:22 +1000182class RunModuleTestCase(unittest.TestCase, CodeExecutionMixin):
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000183 """Unit tests for runpy.run_module"""
Thomas Woutersa9773292006-04-21 09:43:23 +0000184
185 def expect_import_error(self, mod_name):
186 try:
187 run_module(mod_name)
188 except ImportError:
189 pass
190 else:
191 self.fail("Expected import error for " + mod_name)
192
193 def test_invalid_names(self):
Guido van Rossum806c2462007-08-06 23:33:07 +0000194 # Builtin module
Thomas Woutersa9773292006-04-21 09:43:23 +0000195 self.expect_import_error("sys")
Guido van Rossum806c2462007-08-06 23:33:07 +0000196 # Non-existent modules
Thomas Woutersa9773292006-04-21 09:43:23 +0000197 self.expect_import_error("sys.imp.eric")
198 self.expect_import_error("os.path.half")
199 self.expect_import_error("a.bee")
200 self.expect_import_error(".howard")
201 self.expect_import_error("..eaten")
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000202 # Package without __main__.py
203 self.expect_import_error("multiprocessing")
Thomas Woutersa9773292006-04-21 09:43:23 +0000204
205 def test_library_module(self):
Nick Coghlan761bb112012-07-14 23:59:22 +1000206 self.assertEqual(run_module("runpy")["__name__"], "runpy")
Thomas Woutersa9773292006-04-21 09:43:23 +0000207
Nick Coghlan720c7e22013-12-15 20:33:02 +1000208 def _add_pkg_dir(self, pkg_dir, namespace=False):
Guido van Rossum806c2462007-08-06 23:33:07 +0000209 os.mkdir(pkg_dir)
Nick Coghlan720c7e22013-12-15 20:33:02 +1000210 if namespace:
211 return None
Skip Montanaro7a98be22007-08-16 14:35:24 +0000212 pkg_fname = os.path.join(pkg_dir, "__init__.py")
Victor Stinnerbf816222011-06-30 23:25:47 +0200213 create_empty_file(pkg_fname)
Guido van Rossum806c2462007-08-06 23:33:07 +0000214 return pkg_fname
215
Nick Coghlan720c7e22013-12-15 20:33:02 +1000216 def _make_pkg(self, source, depth, mod_base="runpy_test",
217 *, namespace=False, parent_namespaces=False):
218 # Enforce a couple of internal sanity checks on test cases
219 if (namespace or parent_namespaces) and not depth:
220 raise RuntimeError("Can't mark top level module as a "
221 "namespace package")
Thomas Woutersa9773292006-04-21 09:43:23 +0000222 pkg_name = "__runpy_pkg__"
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000223 test_fname = mod_base+os.extsep+"py"
Nick Coghlaneb3e62f2012-07-17 20:42:39 +1000224 pkg_dir = sub_dir = os.path.realpath(tempfile.mkdtemp())
Nick Coghlan761bb112012-07-14 23:59:22 +1000225 if verbose > 1: print(" Package tree in:", sub_dir)
Thomas Woutersa9773292006-04-21 09:43:23 +0000226 sys.path.insert(0, pkg_dir)
Nick Coghlan761bb112012-07-14 23:59:22 +1000227 if verbose > 1: print(" Updated sys.path:", sys.path[0])
Nick Coghlan720c7e22013-12-15 20:33:02 +1000228 if depth:
229 namespace_flags = [parent_namespaces] * depth
230 namespace_flags[-1] = namespace
231 for namespace_flag in namespace_flags:
232 sub_dir = os.path.join(sub_dir, pkg_name)
233 pkg_fname = self._add_pkg_dir(sub_dir, namespace_flag)
234 if verbose > 1: print(" Next level in:", sub_dir)
235 if verbose > 1: print(" Created:", pkg_fname)
Thomas Woutersa9773292006-04-21 09:43:23 +0000236 mod_fname = os.path.join(sub_dir, test_fname)
237 mod_file = open(mod_fname, "w")
238 mod_file.write(source)
239 mod_file.close()
Nick Coghlan761bb112012-07-14 23:59:22 +1000240 if verbose > 1: print(" Created:", mod_fname)
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000241 mod_name = (pkg_name+".")*depth + mod_base
Nick Coghlan720c7e22013-12-15 20:33:02 +1000242 mod_spec = importlib.util.spec_from_file_location(mod_name,
243 mod_fname)
244 return pkg_dir, mod_fname, mod_name, mod_spec
Thomas Woutersa9773292006-04-21 09:43:23 +0000245
246 def _del_pkg(self, top, depth, mod_name):
Guido van Rossum806c2462007-08-06 23:33:07 +0000247 for entry in list(sys.modules):
248 if entry.startswith("__runpy_pkg__"):
Thomas Woutersa9773292006-04-21 09:43:23 +0000249 del sys.modules[entry]
Nick Coghlan761bb112012-07-14 23:59:22 +1000250 if verbose > 1: print(" Removed sys.modules entries")
Thomas Woutersa9773292006-04-21 09:43:23 +0000251 del sys.path[0]
Nick Coghlan761bb112012-07-14 23:59:22 +1000252 if verbose > 1: print(" Removed sys.path entry")
Thomas Woutersa9773292006-04-21 09:43:23 +0000253 for root, dirs, files in os.walk(top, topdown=False):
254 for name in files:
255 try:
256 os.remove(os.path.join(root, name))
Guido van Rossumb940e112007-01-10 16:19:56 +0000257 except OSError as ex:
Nick Coghlan761bb112012-07-14 23:59:22 +1000258 if verbose > 1: print(ex) # Persist with cleaning up
Thomas Woutersa9773292006-04-21 09:43:23 +0000259 for name in dirs:
260 fullname = os.path.join(root, name)
261 try:
262 os.rmdir(fullname)
Guido van Rossumb940e112007-01-10 16:19:56 +0000263 except OSError as ex:
Nick Coghlan761bb112012-07-14 23:59:22 +1000264 if verbose > 1: print(ex) # Persist with cleaning up
Thomas Woutersa9773292006-04-21 09:43:23 +0000265 try:
266 os.rmdir(top)
Nick Coghlan761bb112012-07-14 23:59:22 +1000267 if verbose > 1: print(" Removed package tree")
Guido van Rossumb940e112007-01-10 16:19:56 +0000268 except OSError as ex:
Nick Coghlan761bb112012-07-14 23:59:22 +1000269 if verbose > 1: print(ex) # Persist with cleaning up
Thomas Woutersa9773292006-04-21 09:43:23 +0000270
Nick Coghlan761bb112012-07-14 23:59:22 +1000271 def _fix_ns_for_legacy_pyc(self, ns, alter_sys):
272 char_to_add = "c" if __debug__ else "o"
273 ns["__file__"] += char_to_add
Nick Coghlan720c7e22013-12-15 20:33:02 +1000274 ns["__cached__"] = ns["__file__"]
275 spec = ns["__spec__"]
276 new_spec = importlib.util.spec_from_file_location(spec.name,
277 ns["__file__"])
278 ns["__spec__"] = new_spec
Nick Coghlan761bb112012-07-14 23:59:22 +1000279 if alter_sys:
280 ns["run_argv0"] += char_to_add
281
282
Nick Coghlan720c7e22013-12-15 20:33:02 +1000283 def _check_module(self, depth, alter_sys=False,
284 *, namespace=False, parent_namespaces=False):
285 pkg_dir, mod_fname, mod_name, mod_spec = (
286 self._make_pkg(example_source, depth,
287 namespace=namespace,
288 parent_namespaces=parent_namespaces))
Guido van Rossum04110fb2007-08-24 16:32:05 +0000289 forget(mod_name)
Nick Coghlan761bb112012-07-14 23:59:22 +1000290 expected_ns = example_namespace.copy()
291 expected_ns.update({
292 "__name__": mod_name,
293 "__file__": mod_fname,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000294 "__cached__": mod_spec.cached,
Nick Coghlan761bb112012-07-14 23:59:22 +1000295 "__package__": mod_name.rpartition(".")[0],
Nick Coghlan720c7e22013-12-15 20:33:02 +1000296 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000297 })
298 if alter_sys:
299 expected_ns.update({
300 "run_argv0": mod_fname,
301 "run_name_in_sys_modules": True,
302 "module_in_sys_modules": True,
303 })
304 def create_ns(init_globals):
305 return run_module(mod_name, init_globals, alter_sys=alter_sys)
Thomas Woutersa9773292006-04-21 09:43:23 +0000306 try:
Nick Coghlan761bb112012-07-14 23:59:22 +1000307 if verbose > 1: print("Running from source:", mod_name)
308 self.check_code_execution(create_ns, expected_ns)
Brett Cannonfd074152012-04-14 14:10:13 -0400309 importlib.invalidate_caches()
Thomas Woutersa9773292006-04-21 09:43:23 +0000310 __import__(mod_name)
311 os.remove(mod_fname)
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200312 if not sys.dont_write_bytecode:
313 make_legacy_pyc(mod_fname)
314 unload(mod_name) # In case loader caches paths
Ezio Melottie5e7a7c2013-03-16 21:49:20 +0200315 importlib.invalidate_caches()
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200316 if verbose > 1: print("Running from compiled:", mod_name)
317 self._fix_ns_for_legacy_pyc(expected_ns, alter_sys)
318 self.check_code_execution(create_ns, expected_ns)
Thomas Woutersa9773292006-04-21 09:43:23 +0000319 finally:
320 self._del_pkg(pkg_dir, depth, mod_name)
Nick Coghlan761bb112012-07-14 23:59:22 +1000321 if verbose > 1: print("Module executed successfully")
Thomas Woutersa9773292006-04-21 09:43:23 +0000322
Nick Coghlan720c7e22013-12-15 20:33:02 +1000323 def _check_package(self, depth, alter_sys=False,
324 *, namespace=False, parent_namespaces=False):
325 pkg_dir, mod_fname, mod_name, mod_spec = (
326 self._make_pkg(example_source, depth, "__main__",
327 namespace=namespace,
328 parent_namespaces=parent_namespaces))
Nick Coghlan761bb112012-07-14 23:59:22 +1000329 pkg_name = mod_name.rpartition(".")[0]
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000330 forget(mod_name)
Nick Coghlan761bb112012-07-14 23:59:22 +1000331 expected_ns = example_namespace.copy()
332 expected_ns.update({
333 "__name__": mod_name,
334 "__file__": mod_fname,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000335 "__cached__": importlib.util.cache_from_source(mod_fname),
Nick Coghlan761bb112012-07-14 23:59:22 +1000336 "__package__": pkg_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000337 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000338 })
339 if alter_sys:
340 expected_ns.update({
341 "run_argv0": mod_fname,
342 "run_name_in_sys_modules": True,
343 "module_in_sys_modules": True,
344 })
345 def create_ns(init_globals):
346 return run_module(pkg_name, init_globals, alter_sys=alter_sys)
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000347 try:
Nick Coghlan761bb112012-07-14 23:59:22 +1000348 if verbose > 1: print("Running from source:", pkg_name)
349 self.check_code_execution(create_ns, expected_ns)
Brett Cannonfd074152012-04-14 14:10:13 -0400350 importlib.invalidate_caches()
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000351 __import__(mod_name)
352 os.remove(mod_fname)
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200353 if not sys.dont_write_bytecode:
354 make_legacy_pyc(mod_fname)
355 unload(mod_name) # In case loader caches paths
356 if verbose > 1: print("Running from compiled:", pkg_name)
Ezio Melottie5e7a7c2013-03-16 21:49:20 +0200357 importlib.invalidate_caches()
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200358 self._fix_ns_for_legacy_pyc(expected_ns, alter_sys)
359 self.check_code_execution(create_ns, expected_ns)
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000360 finally:
361 self._del_pkg(pkg_dir, depth, pkg_name)
Nick Coghlan761bb112012-07-14 23:59:22 +1000362 if verbose > 1: print("Package executed successfully")
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000363
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000364 def _add_relative_modules(self, base_dir, source, depth):
Guido van Rossum806c2462007-08-06 23:33:07 +0000365 if depth <= 1:
366 raise ValueError("Relative module test needs depth > 1")
367 pkg_name = "__runpy_pkg__"
368 module_dir = base_dir
369 for i in range(depth):
370 parent_dir = module_dir
371 module_dir = os.path.join(module_dir, pkg_name)
372 # Add sibling module
Skip Montanaro7a98be22007-08-16 14:35:24 +0000373 sibling_fname = os.path.join(module_dir, "sibling.py")
Victor Stinnerbf816222011-06-30 23:25:47 +0200374 create_empty_file(sibling_fname)
Nick Coghlan761bb112012-07-14 23:59:22 +1000375 if verbose > 1: print(" Added sibling module:", sibling_fname)
Guido van Rossum806c2462007-08-06 23:33:07 +0000376 # Add nephew module
377 uncle_dir = os.path.join(parent_dir, "uncle")
378 self._add_pkg_dir(uncle_dir)
Nick Coghlan761bb112012-07-14 23:59:22 +1000379 if verbose > 1: print(" Added uncle package:", uncle_dir)
Guido van Rossum806c2462007-08-06 23:33:07 +0000380 cousin_dir = os.path.join(uncle_dir, "cousin")
381 self._add_pkg_dir(cousin_dir)
Nick Coghlan761bb112012-07-14 23:59:22 +1000382 if verbose > 1: print(" Added cousin package:", cousin_dir)
Skip Montanaro7a98be22007-08-16 14:35:24 +0000383 nephew_fname = os.path.join(cousin_dir, "nephew.py")
Victor Stinnerbf816222011-06-30 23:25:47 +0200384 create_empty_file(nephew_fname)
Nick Coghlan761bb112012-07-14 23:59:22 +1000385 if verbose > 1: print(" Added nephew module:", nephew_fname)
Guido van Rossum806c2462007-08-06 23:33:07 +0000386
387 def _check_relative_imports(self, depth, run_name=None):
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000388 contents = r"""\
Guido van Rossum806c2462007-08-06 23:33:07 +0000389from __future__ import absolute_import
390from . import sibling
391from ..uncle.cousin import nephew
392"""
Nick Coghlan720c7e22013-12-15 20:33:02 +1000393 pkg_dir, mod_fname, mod_name, mod_spec = (
Guido van Rossum806c2462007-08-06 23:33:07 +0000394 self._make_pkg(contents, depth))
Nick Coghlan761bb112012-07-14 23:59:22 +1000395 if run_name is None:
396 expected_name = mod_name
397 else:
398 expected_name = run_name
Guido van Rossum806c2462007-08-06 23:33:07 +0000399 try:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000400 self._add_relative_modules(pkg_dir, contents, depth)
401 pkg_name = mod_name.rpartition('.')[0]
Nick Coghlan761bb112012-07-14 23:59:22 +1000402 if verbose > 1: print("Running from source:", mod_name)
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000403 d1 = run_module(mod_name, run_name=run_name) # Read from source
Nick Coghlan761bb112012-07-14 23:59:22 +1000404 self.assertEqual(d1["__name__"], expected_name)
405 self.assertEqual(d1["__package__"], pkg_name)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000406 self.assertIn("sibling", d1)
407 self.assertIn("nephew", d1)
Guido van Rossum806c2462007-08-06 23:33:07 +0000408 del d1 # Ensure __loader__ entry doesn't keep file open
Brett Cannonfd074152012-04-14 14:10:13 -0400409 importlib.invalidate_caches()
Guido van Rossum806c2462007-08-06 23:33:07 +0000410 __import__(mod_name)
411 os.remove(mod_fname)
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200412 if not sys.dont_write_bytecode:
413 make_legacy_pyc(mod_fname)
414 unload(mod_name) # In case the loader caches paths
415 if verbose > 1: print("Running from compiled:", mod_name)
Ezio Melottie5e7a7c2013-03-16 21:49:20 +0200416 importlib.invalidate_caches()
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200417 d2 = run_module(mod_name, run_name=run_name) # Read from bytecode
418 self.assertEqual(d2["__name__"], expected_name)
419 self.assertEqual(d2["__package__"], pkg_name)
420 self.assertIn("sibling", d2)
421 self.assertIn("nephew", d2)
422 del d2 # Ensure __loader__ entry doesn't keep file open
Guido van Rossum806c2462007-08-06 23:33:07 +0000423 finally:
424 self._del_pkg(pkg_dir, depth, mod_name)
Nick Coghlan761bb112012-07-14 23:59:22 +1000425 if verbose > 1: print("Module executed successfully")
Guido van Rossum806c2462007-08-06 23:33:07 +0000426
Thomas Woutersa9773292006-04-21 09:43:23 +0000427 def test_run_module(self):
428 for depth in range(4):
Nick Coghlan761bb112012-07-14 23:59:22 +1000429 if verbose > 1: print("Testing package depth:", depth)
Thomas Woutersa9773292006-04-21 09:43:23 +0000430 self._check_module(depth)
431
Nick Coghlan720c7e22013-12-15 20:33:02 +1000432 def test_run_module_in_namespace_package(self):
433 for depth in range(1, 4):
434 if verbose > 1: print("Testing package depth:", depth)
435 self._check_module(depth, namespace=True, parent_namespaces=True)
436
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000437 def test_run_package(self):
438 for depth in range(1, 4):
Nick Coghlan761bb112012-07-14 23:59:22 +1000439 if verbose > 1: print("Testing package depth:", depth)
Benjamin Petersonf6489f92009-11-25 17:46:26 +0000440 self._check_package(depth)
441
Nick Coghlan720c7e22013-12-15 20:33:02 +1000442 def test_run_package_in_namespace_package(self):
443 for depth in range(1, 4):
444 if verbose > 1: print("Testing package depth:", depth)
445 self._check_package(depth, parent_namespaces=True)
446
447 def test_run_namespace_package(self):
448 for depth in range(1, 4):
449 if verbose > 1: print("Testing package depth:", depth)
450 self._check_package(depth, namespace=True)
451
452 def test_run_namespace_package_in_namespace_package(self):
453 for depth in range(1, 4):
454 if verbose > 1: print("Testing package depth:", depth)
455 self._check_package(depth, namespace=True, parent_namespaces=True)
456
Nick Coghlan761bb112012-07-14 23:59:22 +1000457 def test_run_module_alter_sys(self):
458 for depth in range(4):
459 if verbose > 1: print("Testing package depth:", depth)
460 self._check_module(depth, alter_sys=True)
461
462 def test_run_package_alter_sys(self):
463 for depth in range(1, 4):
464 if verbose > 1: print("Testing package depth:", depth)
465 self._check_package(depth, alter_sys=True)
466
Guido van Rossum806c2462007-08-06 23:33:07 +0000467 def test_explicit_relative_import(self):
468 for depth in range(2, 5):
Nick Coghlan761bb112012-07-14 23:59:22 +1000469 if verbose > 1: print("Testing relative imports at depth:", depth)
Guido van Rossum806c2462007-08-06 23:33:07 +0000470 self._check_relative_imports(depth)
471
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000472 def test_main_relative_import(self):
473 for depth in range(2, 5):
Nick Coghlan761bb112012-07-14 23:59:22 +1000474 if verbose > 1: print("Testing main relative imports at depth:", depth)
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000475 self._check_relative_imports(depth, "__main__")
476
Nick Coghlan761bb112012-07-14 23:59:22 +1000477 def test_run_name(self):
478 depth = 1
479 run_name = "And now for something completely different"
Nick Coghlan720c7e22013-12-15 20:33:02 +1000480 pkg_dir, mod_fname, mod_name, mod_spec = (
Nick Coghlan761bb112012-07-14 23:59:22 +1000481 self._make_pkg(example_source, depth))
482 forget(mod_name)
483 expected_ns = example_namespace.copy()
484 expected_ns.update({
485 "__name__": run_name,
486 "__file__": mod_fname,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000487 "__cached__": importlib.util.cache_from_source(mod_fname),
Nick Coghlan761bb112012-07-14 23:59:22 +1000488 "__package__": mod_name.rpartition(".")[0],
Nick Coghlan720c7e22013-12-15 20:33:02 +1000489 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000490 })
491 def create_ns(init_globals):
492 return run_module(mod_name, init_globals, run_name)
493 try:
494 self.check_code_execution(create_ns, expected_ns)
495 finally:
496 self._del_pkg(pkg_dir, depth, mod_name)
Thomas Woutersa9773292006-04-21 09:43:23 +0000497
Nick Coghlan8ecf5042012-07-15 21:19:18 +1000498 def test_pkgutil_walk_packages(self):
499 # This is a dodgy hack to use the test_runpy infrastructure to test
500 # issue #15343. Issue #15348 declares this is indeed a dodgy hack ;)
501 import pkgutil
502 max_depth = 4
503 base_name = "__runpy_pkg__"
504 package_suffixes = ["uncle", "uncle.cousin"]
505 module_suffixes = ["uncle.cousin.nephew", base_name + ".sibling"]
506 expected_packages = set()
507 expected_modules = set()
508 for depth in range(1, max_depth):
509 pkg_name = ".".join([base_name] * depth)
510 expected_packages.add(pkg_name)
511 for name in package_suffixes:
512 expected_packages.add(pkg_name + "." + name)
513 for name in module_suffixes:
514 expected_modules.add(pkg_name + "." + name)
515 pkg_name = ".".join([base_name] * max_depth)
516 expected_packages.add(pkg_name)
517 expected_modules.add(pkg_name + ".runpy_test")
Nick Coghlan720c7e22013-12-15 20:33:02 +1000518 pkg_dir, mod_fname, mod_name, mod_spec = (
Nick Coghlan8ecf5042012-07-15 21:19:18 +1000519 self._make_pkg("", max_depth))
520 self.addCleanup(self._del_pkg, pkg_dir, max_depth, mod_name)
521 for depth in range(2, max_depth+1):
522 self._add_relative_modules(pkg_dir, "", depth)
523 for finder, mod_name, ispkg in pkgutil.walk_packages([pkg_dir]):
524 self.assertIsInstance(finder,
525 importlib.machinery.FileFinder)
526 if ispkg:
527 expected_packages.remove(mod_name)
528 else:
529 expected_modules.remove(mod_name)
530 self.assertEqual(len(expected_packages), 0, expected_packages)
531 self.assertEqual(len(expected_modules), 0, expected_modules)
Nick Coghlan761bb112012-07-14 23:59:22 +1000532
533class RunPathTestCase(unittest.TestCase, CodeExecutionMixin):
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000534 """Unit tests for runpy.run_path"""
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000535
Nick Coghlan720c7e22013-12-15 20:33:02 +1000536 def _make_test_script(self, script_dir, script_basename,
537 source=None, omit_suffix=False):
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000538 if source is None:
Nick Coghlan761bb112012-07-14 23:59:22 +1000539 source = example_source
Nick Coghlan720c7e22013-12-15 20:33:02 +1000540 return make_script(script_dir, script_basename,
541 source, omit_suffix)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000542
543 def _check_script(self, script_name, expected_name, expected_file,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000544 expected_argv0, mod_name=None,
545 expect_spec=True, check_loader=True):
Nick Coghlan761bb112012-07-14 23:59:22 +1000546 # First check is without run_name
547 def create_ns(init_globals):
548 return run_path(script_name, init_globals)
549 expected_ns = example_namespace.copy()
Nick Coghlan720c7e22013-12-15 20:33:02 +1000550 if mod_name is None:
551 spec_name = expected_name
552 else:
553 spec_name = mod_name
554 if expect_spec:
555 mod_spec = importlib.util.spec_from_file_location(spec_name,
556 expected_file)
557 mod_cached = mod_spec.cached
558 if not check_loader:
559 mod_spec.loader = None
560 else:
561 mod_spec = mod_cached = None
562
Nick Coghlan761bb112012-07-14 23:59:22 +1000563 expected_ns.update({
564 "__name__": expected_name,
565 "__file__": expected_file,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000566 "__cached__": mod_cached,
Nick Coghlan761bb112012-07-14 23:59:22 +1000567 "__package__": "",
Nick Coghlan720c7e22013-12-15 20:33:02 +1000568 "__spec__": mod_spec,
Nick Coghlan761bb112012-07-14 23:59:22 +1000569 "run_argv0": expected_argv0,
570 "run_name_in_sys_modules": True,
571 "module_in_sys_modules": True,
572 })
573 self.check_code_execution(create_ns, expected_ns)
574 # Second check makes sure run_name works in all cases
575 run_name = "prove.issue15230.is.fixed"
576 def create_ns(init_globals):
577 return run_path(script_name, init_globals, run_name)
Nick Coghlan720c7e22013-12-15 20:33:02 +1000578 if expect_spec and mod_name is None:
579 mod_spec = importlib.util.spec_from_file_location(run_name,
580 expected_file)
581 if not check_loader:
582 mod_spec.loader = None
583 expected_ns["__spec__"] = mod_spec
Nick Coghlan761bb112012-07-14 23:59:22 +1000584 expected_ns["__name__"] = run_name
585 expected_ns["__package__"] = run_name.rpartition(".")[0]
586 self.check_code_execution(create_ns, expected_ns)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000587
588 def _check_import_error(self, script_name, msg):
Nick Coghlan16eb0fb2009-11-18 11:35:25 +0000589 msg = re.escape(msg)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000590 self.assertRaisesRegex(ImportError, msg, run_path, script_name)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000591
592 def test_basic_script(self):
593 with temp_dir() as script_dir:
594 mod_name = 'script'
595 script_name = self._make_test_script(script_dir, mod_name)
596 self._check_script(script_name, "<run_path>", script_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000597 script_name, expect_spec=False)
598
599 def test_basic_script_no_suffix(self):
600 with temp_dir() as script_dir:
601 mod_name = 'script'
602 script_name = self._make_test_script(script_dir, mod_name,
603 omit_suffix=True)
604 self._check_script(script_name, "<run_path>", script_name,
605 script_name, expect_spec=False)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000606
607 def test_script_compiled(self):
608 with temp_dir() as script_dir:
609 mod_name = 'script'
610 script_name = self._make_test_script(script_dir, mod_name)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000611 compiled_name = py_compile.compile(script_name, doraise=True)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000612 os.remove(script_name)
613 self._check_script(compiled_name, "<run_path>", compiled_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000614 compiled_name, expect_spec=False)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000615
616 def test_directory(self):
617 with temp_dir() as script_dir:
618 mod_name = '__main__'
619 script_name = self._make_test_script(script_dir, mod_name)
620 self._check_script(script_dir, "<run_path>", script_name,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000621 script_dir, mod_name=mod_name)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000622
623 def test_directory_compiled(self):
624 with temp_dir() as script_dir:
625 mod_name = '__main__'
626 script_name = self._make_test_script(script_dir, mod_name)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000627 compiled_name = py_compile.compile(script_name, doraise=True)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000628 os.remove(script_name)
Ezio Melottic28f6fa2013-03-16 19:48:51 +0200629 if not sys.dont_write_bytecode:
630 legacy_pyc = make_legacy_pyc(script_name)
631 self._check_script(script_dir, "<run_path>", legacy_pyc,
Nick Coghlan720c7e22013-12-15 20:33:02 +1000632 script_dir, mod_name=mod_name)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000633
634 def test_directory_error(self):
635 with temp_dir() as script_dir:
636 mod_name = 'not_main'
637 script_name = self._make_test_script(script_dir, mod_name)
638 msg = "can't find '__main__' module in %r" % script_dir
639 self._check_import_error(script_dir, msg)
640
641 def test_zipfile(self):
642 with temp_dir() as script_dir:
643 mod_name = '__main__'
644 script_name = self._make_test_script(script_dir, mod_name)
645 zip_name, fname = make_zip_script(script_dir, 'test_zip', script_name)
Nick Coghlan720c7e22013-12-15 20:33:02 +1000646 self._check_script(zip_name, "<run_path>", fname, zip_name,
647 mod_name=mod_name, check_loader=False)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000648
649 def test_zipfile_compiled(self):
650 with temp_dir() as script_dir:
651 mod_name = '__main__'
652 script_name = self._make_test_script(script_dir, mod_name)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000653 compiled_name = py_compile.compile(script_name, doraise=True)
654 zip_name, fname = make_zip_script(script_dir, 'test_zip',
655 compiled_name)
Nick Coghlan720c7e22013-12-15 20:33:02 +1000656 self._check_script(zip_name, "<run_path>", fname, zip_name,
657 mod_name=mod_name, check_loader=False)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000658
659 def test_zipfile_error(self):
660 with temp_dir() as script_dir:
661 mod_name = 'not_main'
662 script_name = self._make_test_script(script_dir, mod_name)
663 zip_name, fname = make_zip_script(script_dir, 'test_zip', script_name)
664 msg = "can't find '__main__' module in %r" % zip_name
665 self._check_import_error(zip_name, msg)
666
Brett Cannon31f59292011-02-21 19:29:56 +0000667 @no_tracing
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000668 def test_main_recursion_error(self):
669 with temp_dir() as script_dir, temp_dir() as dummy_dir:
670 mod_name = '__main__'
671 source = ("import runpy\n"
672 "runpy.run_path(%r)\n") % dummy_dir
673 script_name = self._make_test_script(script_dir, mod_name, source)
674 zip_name, fname = make_zip_script(script_dir, 'test_zip', script_name)
675 msg = "recursion depth exceeded"
Ezio Melottied3a7d22010-12-01 02:32:32 +0000676 self.assertRaisesRegex(RuntimeError, msg, run_path, zip_name)
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000677
Victor Stinner6c471022011-07-04 01:45:39 +0200678 def test_encoding(self):
679 with temp_dir() as script_dir:
680 filename = os.path.join(script_dir, 'script.py')
681 with open(filename, 'w', encoding='latin1') as f:
682 f.write("""
683#coding:latin1
Benjamin Peterson951a9e32012-10-12 11:44:10 -0400684s = "non-ASCII: h\xe9"
Victor Stinner6c471022011-07-04 01:45:39 +0200685""")
686 result = run_path(filename)
Benjamin Peterson951a9e32012-10-12 11:44:10 -0400687 self.assertEqual(result['s'], "non-ASCII: h\xe9")
Nick Coghlan260bd3e2009-11-16 06:49:25 +0000688
689
Thomas Woutersa9773292006-04-21 09:43:23 +0000690if __name__ == "__main__":
Brett Cannon3e9a9ae2013-06-12 21:25:59 -0400691 unittest.main()