diff options
author | Nick Coghlan <ncoghlan@gmail.com> | 2009-02-08 01:58:26 (GMT) |
---|---|---|
committer | Nick Coghlan <ncoghlan@gmail.com> | 2009-02-08 01:58:26 (GMT) |
commit | 3f48ae35c710c5e5101d5de6721b1e2ccb56df68 (patch) | |
tree | 971feab37df37b7ab70429c75069d36b2c8b9557 /Doc | |
parent | f72d9fb02f2ff536c64f1e65780b4a414eb3bb4d (diff) | |
download | cpython-3f48ae35c710c5e5101d5de6721b1e2ccb56df68.zip cpython-3f48ae35c710c5e5101d5de6721b1e2ccb56df68.tar.gz cpython-3f48ae35c710c5e5101d5de6721b1e2ccb56df68.tar.bz2 |
Merged revisions 69419-69420 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r69419 | nick.coghlan | 2009-02-08 11:26:34 +1000 (Sun, 08 Feb 2009) | 1 line
Issue 4195: Restore the ability to execute packages with the -m switch (but this time in a way that leaves the import machinery in a valid state). (Original patch by Andi Vajda)
........
r69420 | nick.coghlan | 2009-02-08 11:46:01 +1000 (Sun, 08 Feb 2009) | 1 line
Mention patch submitter in NEWS entry for r69419
........
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/runpy.rst | 25 | ||||
-rw-r--r-- | Doc/using/cmdline.rst | 11 |
2 files changed, 30 insertions, 6 deletions
diff --git a/Doc/library/runpy.rst b/Doc/library/runpy.rst index 2254906..6feb4b1 100644 --- a/Doc/library/runpy.rst +++ b/Doc/library/runpy.rst @@ -26,17 +26,22 @@ The :mod:`runpy` module provides a single function: mechanism (refer to PEP 302 for details) and then executed in a fresh module namespace. + If the supplied module name refers to a package rather than a normal module, + then that package is imported and the ``__main__`` submodule within that + package is then executed and the resulting module globals dictionary returned. + The optional dictionary argument *init_globals* may be used to pre-populate the globals dictionary before the code is executed. The supplied dictionary will not be modified. If any of the special global variables below are defined in the supplied dictionary, those definitions are overridden by the ``run_module`` function. - The special global variables ``__name__``, ``__file__``, ``__loader__`` and - ``__builtins__`` are set in the globals dictionary before the module code is - executed. + The special global variables ``__name__``, ``__file__``, ``__loader__``, + ``__builtins__`` and ``__package__`` are set in the globals dictionary before + the module code is executed. - ``__name__`` is set to *run_name* if this optional argument is supplied, and the + ``__name__`` is set to *run_name* if this optional argument is supplied, to + ``mod_name + '.__main__'`` if the named module is a package and to the *mod_name* argument otherwise. ``__loader__`` is set to the PEP 302 module loader used to retrieve the code for @@ -48,6 +53,9 @@ The :mod:`runpy` module provides a single function: ``__builtins__`` is automatically initialised with a reference to the top level namespace of the :mod:`builtins` module. + ``__package__`` is set to *mod_name* if the named module is a package and to + ``mod_name.rpartition('.')[0]`` otherwise. + If the argument *alter_sys* is supplied and evaluates to ``True``, then ``sys.argv[0]`` is updated with the value of ``__file__`` and ``sys.modules[__name__]`` is updated with a temporary module object for the @@ -60,8 +68,15 @@ The :mod:`runpy` module provides a single function: function from threaded code. + .. versionchanged:: 3.1 + Added ability to execute packages by looking for a ``__main__`` submodule + + .. seealso:: :pep:`338` - Executing modules as scripts - PEP written and implemented by Nick Coghlan. + PEP written and implemented by Nick Coghlan. + + :pep:`366` - Main module explicit relative imports + PEP written and implemented by Nick Coghlan. diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 3481d5b..9eecba6 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -78,6 +78,12 @@ source. the implementation may not always enforce this (e.g. it may allow you to use a name that includes a hyphen). + Package names are also permitted. When a package name is supplied instead + of a normal module, the interpreter will execute ``<pkg>.__main__`` as + the main module. This behaviour is deliberately similar to the handling + of directories and zipfiles that are passed to the interpreter as the + script argument. + .. note:: This option cannot be used with builtin modules and extension modules @@ -97,11 +103,14 @@ source. .. seealso:: :func:`runpy.run_module` - The actual implementation of this feature. + Equivalent functionality directly available to Python code :pep:`338` -- Executing modules as scripts + .. versionchanged:: 3.1 + Supply the package name to run a ``__main__`` submodule. + .. describe:: - Read commands from standard input (:data:`sys.stdin`). If standard input is |