diff options
author | Nick Coghlan <ncoghlan@gmail.com> | 2012-07-14 14:38:43 (GMT) |
---|---|---|
committer | Nick Coghlan <ncoghlan@gmail.com> | 2012-07-14 14:38:43 (GMT) |
commit | 24711c4facef4c004d452ea554210c88545cf9fa (patch) | |
tree | e9f54512f5698b1a6d9efb9c10b6c923e4a02098 /Doc/library | |
parent | 2f54b98c8c40ab2190db59ae66d23f795b92daa2 (diff) | |
parent | a3d1cac4b21ffbd8deed0c28f08bed4afa5e7b83 (diff) | |
download | cpython-24711c4facef4c004d452ea554210c88545cf9fa.zip cpython-24711c4facef4c004d452ea554210c88545cf9fa.tar.gz cpython-24711c4facef4c004d452ea554210c88545cf9fa.tar.bz2 |
Merge #15230 doc updates from 3.2
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/runpy.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/Doc/library/runpy.rst b/Doc/library/runpy.rst index 4df622c..6919bc0 100644 --- a/Doc/library/runpy.rst +++ b/Doc/library/runpy.rst @@ -14,6 +14,15 @@ importing them first. Its main use is to implement the :option:`-m` command line switch that allows scripts to be located using the Python module namespace rather than the filesystem. +Note that this is *not* a sandbox module - all code is executed in the +current process, and any side effects (such as cached imports of other +modules) will remain in place after the functions have returned. + +Furthermore, any functions and classes defined by the executed code are not +guaranteed to work correctly after a :mod:`runpy` function has returned. +If that limitation is not acceptable for a given use case, :mod:`importlib` +is likely to be a more suitable choice than this module. + The :mod:`runpy` module provides two functions: @@ -141,3 +150,5 @@ The :mod:`runpy` module provides two functions: PEP written and implemented by Nick Coghlan. :ref:`using-on-general` - CPython command line details + + The :func:`importlib.import_module` function |