Doc/library/runpy.rst

   1 :mod:`runpy` --- Locating and executing Python modules
   2 ======================================================
   3
   4 .. module:: runpy
   5    :synopsis: Locate and run Python modules without importing them first.
   6 .. moduleauthor:: Nick Coghlan <ncoghlan@gmail.com>
   7
   8
   9 .. versionadded:: 2.5
  10
  11 The :mod:`runpy` module is used to locate and run Python modules without
  12 importing them first. Its main use is to implement the :option:`-m` command line
  13 switch that allows scripts to be located using the Python module namespace
  14 rather than the filesystem.
  15
  16 When executed as a script, the module effectively operates as follows::
  17
  18    del sys.argv[0]  # Remove the runpy module from the arguments
  19    run_module(sys.argv[0], run_name="__main__", alter_sys=True)
  20
  21 The :mod:`runpy` module provides a single function:
  22
  23
  24 .. function:: run_module(mod_name[, init_globals] [, run_name][, alter_sys])
  25
  26    Execute the code of the specified module and return the resulting module globals
  27    dictionary. The module's code is first located using the standard import
  28    mechanism (refer to PEP 302 for details) and then executed in a fresh module
  29    namespace.
  30
  31    If the supplied module name refers to a package rather than a normal module,
  32    then that package is imported and the ``__main__`` submodule within that
  33    package is then executed and the resulting module globals dictionary returned.
  34
  35    The optional dictionary argument *init_globals* may be used to pre-populate the
  36    globals dictionary before the code is executed. The supplied dictionary will not
  37    be modified. If any of the special global variables below are defined in the
  38    supplied dictionary, those definitions are overridden by the ``run_module``
  39    function.
  40
  41    The special global variables ``__name__``, ``__file__``, ``__loader__``,
  42    ``__builtins__`` and ``__package__`` are set in the globals dictionary before
  43    the module code is executed.
  44
  45    ``__name__`` is set to *run_name* if this optional argument is supplied, to
  46    ``mod_name + '.__main__'`` if the named module is a package and to the
  47    *mod_name* argument otherwise.
  48
  49    ``__loader__`` is set to the PEP 302 module loader used to retrieve the code for
  50    the module (This loader may be a wrapper around the standard import mechanism).
  51
  52    ``__file__`` is set to the name provided by the module loader. If the loader
  53    does not make filename information available, this variable is set to ``None``.
  54
  55    ``__builtins__`` is automatically initialised with a reference to the top level
  56    namespace of the :mod:`__builtin__` module.
  57
  58    ``__package__`` is set to *mod_name* if the named module is a package and to
  59    ``mod_name.rpartition('.')[0]`` otherwise.
  60
  61    If the argument *alter_sys* is supplied and evaluates to ``True``, then
  62    ``sys.argv[0]`` is updated with the value of ``__file__`` and
  63    ``sys.modules[__name__]`` is updated with a temporary module object for the
  64    module being executed. Both ``sys.argv[0]`` and ``sys.modules[__name__]``
  65    are restored to their original values before the function returns.
  66
  67    Note that this manipulation of :mod:`sys` is not thread-safe. Other threads may
  68    see the partially initialised module, as well as the altered list of arguments.
  69    It is recommended that the :mod:`sys` module be left alone when invoking this
  70    function from threaded code.
  71
  72
  73    .. versionchanged:: 2.7
  74          Added ability to execute packages by looking for a ``__main__`` submodule
  75
  76
  77 .. seealso::
  78
  79    :pep:`338` - Executing modules as scripts
  80       PEP written and implemented by Nick Coghlan.
  81
  82    :pep:`366` - Main module explicit relative imports
  83       PEP written and implemented by Nick Coghlan.
  84