123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290 |
- """runpy.py - locating and running Python code using the module namespace
- Provides support for locating and running Python scripts using the Python
- module namespace instead of the native filesystem.
- This allows Python code to play nicely with non-filesystem based PEP 302
- importers when locating support scripts as well as when importing modules.
- """
- import sys
- import imp
- from pkgutil import read_code
- try:
- from imp import get_loader
- except ImportError:
- from pkgutil import get_loader
- __all__ = [
- "run_module", "run_path",
- ]
- class _TempModule(object):
- """Temporarily replace a module in sys.modules with an empty namespace"""
- def __init__(self, mod_name):
- self.mod_name = mod_name
- self.module = imp.new_module(mod_name)
- self._saved_module = []
- def __enter__(self):
- mod_name = self.mod_name
- try:
- self._saved_module.append(sys.modules[mod_name])
- except KeyError:
- pass
- sys.modules[mod_name] = self.module
- return self
- def __exit__(self, *args):
- if self._saved_module:
- sys.modules[self.mod_name] = self._saved_module[0]
- else:
- del sys.modules[self.mod_name]
- self._saved_module = []
- class _ModifiedArgv0(object):
- def __init__(self, value):
- self.value = value
- self._saved_value = self._sentinel = object()
- def __enter__(self):
- if self._saved_value is not self._sentinel:
- raise RuntimeError("Already preserving saved value")
- self._saved_value = sys.argv[0]
- sys.argv[0] = self.value
- def __exit__(self, *args):
- self.value = self._sentinel
- sys.argv[0] = self._saved_value
- def _run_code(code, run_globals, init_globals=None,
- mod_name=None, mod_fname=None,
- mod_loader=None, pkg_name=None):
- """Helper to run code in nominated namespace"""
- if init_globals is not None:
- run_globals.update(init_globals)
- run_globals.update(__name__ = mod_name,
- __file__ = mod_fname,
- __loader__ = mod_loader,
- __package__ = pkg_name)
- exec code in run_globals
- return run_globals
- def _run_module_code(code, init_globals=None,
- mod_name=None, mod_fname=None,
- mod_loader=None, pkg_name=None):
- """Helper to run code in new namespace with sys modified"""
- with _TempModule(mod_name) as temp_module, _ModifiedArgv0(mod_fname):
- mod_globals = temp_module.module.__dict__
- _run_code(code, mod_globals, init_globals,
- mod_name, mod_fname, mod_loader, pkg_name)
-
-
- return mod_globals.copy()
- def _get_filename(loader, mod_name):
- for attr in ("get_filename", "_get_filename"):
- meth = getattr(loader, attr, None)
- if meth is not None:
- return meth(mod_name)
- return None
- def _get_module_details(mod_name, error=ImportError):
- try:
- loader = get_loader(mod_name)
- if loader is None:
- raise error("No module named %s" % mod_name)
- ispkg = loader.is_package(mod_name)
- except ImportError as e:
- raise error(format(e))
- if ispkg:
- if mod_name == "__main__" or mod_name.endswith(".__main__"):
- raise error("Cannot use package as __main__ module")
- __import__(mod_name)
- try:
- pkg_main_name = mod_name + ".__main__"
- return _get_module_details(pkg_main_name)
- except ImportError, e:
- raise error(("%s; %r is a package and cannot " +
- "be directly executed") %(e, mod_name))
- try:
- code = loader.get_code(mod_name)
- except ImportError as e:
- raise error(format(e))
- if code is None:
- raise error("No code object available for %s" % mod_name)
- filename = _get_filename(loader, mod_name)
- return mod_name, loader, code, filename
- def _get_main_module_details(error=ImportError):
-
-
- main_name = "__main__"
- try:
- return _get_module_details(main_name)
- except ImportError as exc:
- if main_name in str(exc):
- raise error("can't find %r module in %r" %
- (main_name, sys.path[0]))
- raise
- class _Error(Exception):
- """Error that _run_module_as_main() should report without a traceback"""
- def _run_module_as_main(mod_name, alter_argv=True):
- """Runs the designated module in the __main__ namespace
- Note that the executed module will have full access to the
- __main__ namespace. If this is not desirable, the run_module()
- function should be used to run the module code in a fresh namespace.
- At the very least, these variables in __main__ will be overwritten:
- __name__
- __file__
- __loader__
- __package__
- """
- try:
- if alter_argv or mod_name != "__main__":
- mod_name, loader, code, fname = _get_module_details(
- mod_name, _Error)
- else:
- mod_name, loader, code, fname = _get_main_module_details(_Error)
- except _Error as exc:
- msg = "%s: %s" % (sys.executable, exc)
- sys.exit(msg)
- pkg_name = mod_name.rpartition('.')[0]
- main_globals = sys.modules["__main__"].__dict__
- if alter_argv:
- sys.argv[0] = fname
- return _run_code(code, main_globals, None,
- "__main__", fname, loader, pkg_name)
- def run_module(mod_name, init_globals=None,
- run_name=None, alter_sys=False):
- """Execute a module's code without importing it
- Returns the resulting top level namespace dictionary
- """
- mod_name, loader, code, fname = _get_module_details(mod_name)
- if run_name is None:
- run_name = mod_name
- pkg_name = mod_name.rpartition('.')[0]
- if alter_sys:
- return _run_module_code(code, init_globals, run_name,
- fname, loader, pkg_name)
- else:
-
- return _run_code(code, {}, init_globals, run_name,
- fname, loader, pkg_name)
- def _get_importer(path_name):
- """Python version of PyImport_GetImporter C API function"""
- cache = sys.path_importer_cache
- try:
- importer = cache[path_name]
- except KeyError:
-
-
-
- cache[path_name] = None
- for hook in sys.path_hooks:
- try:
- importer = hook(path_name)
- break
- except ImportError:
- pass
- else:
-
-
-
-
- try:
- importer = imp.NullImporter(path_name)
- except ImportError:
- return None
- cache[path_name] = importer
- return importer
- def _get_code_from_file(fname):
-
- with open(fname, "rb") as f:
- code = read_code(f)
- if code is None:
-
- with open(fname, "rU") as f:
- code = compile(f.read(), fname, 'exec')
- return code
- def run_path(path_name, init_globals=None, run_name=None):
- """Execute code located at the specified filesystem location
- Returns the resulting top level namespace dictionary
- The file path may refer directly to a Python script (i.e.
- one that could be directly executed with execfile) or else
- it may refer to a zipfile or directory containing a top
- level __main__.py script.
- """
- if run_name is None:
- run_name = "<run_path>"
- importer = _get_importer(path_name)
- if isinstance(importer, imp.NullImporter):
-
-
- code = _get_code_from_file(path_name)
- return _run_module_code(code, init_globals, run_name, path_name)
- else:
-
-
- sys.path.insert(0, path_name)
- try:
-
-
-
-
-
-
- main_name = "__main__"
- saved_main = sys.modules[main_name]
- del sys.modules[main_name]
- try:
- mod_name, loader, code, fname = _get_main_module_details()
- finally:
- sys.modules[main_name] = saved_main
- pkg_name = ""
- with _TempModule(run_name) as temp_module, \
- _ModifiedArgv0(path_name):
- mod_globals = temp_module.module.__dict__
- return _run_code(code, mod_globals, init_globals,
- run_name, fname, loader, pkg_name).copy()
- finally:
- try:
- sys.path.remove(path_name)
- except ValueError:
- pass
- if __name__ == "__main__":
-
- if len(sys.argv) < 2:
- print >> sys.stderr, "No module specified for execution"
- else:
- del sys.argv[0]
- _run_module_as_main(sys.argv[0])
|