changeset: 78096:4880aac5c665 branch: 3.2 parent: 78094:3b05cf877124 user: Nick Coghlan date: Sun Jul 15 00:36:39 2012 +1000 files: Doc/library/runpy.rst Misc/NEWS description: Issue #15230: Update runpy docs to clarify a couple of points that came up in this issue diff -r 3b05cf877124 -r 4880aac5c665 Doc/library/runpy.rst --- a/Doc/library/runpy.rst Sat Jul 14 23:59:22 2012 +1000 +++ b/Doc/library/runpy.rst Sun Jul 15 00:36:39 2012 +1000 @@ -14,6 +14,15 @@ 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 @@ PEP written and implemented by Nick Coghlan. :ref:`using-on-general` - CPython command line details + + The :func:`importlib.import_module` function diff -r 3b05cf877124 -r 4880aac5c665 Misc/NEWS --- a/Misc/NEWS Sat Jul 14 23:59:22 2012 +1000 +++ b/Misc/NEWS Sun Jul 15 00:36:39 2012 +1000 @@ -384,6 +384,9 @@ Documentation ------------- +- Issue #15230: Clearly document some of the limitations of the runpy + module and nudge readers towards importlib when appropriate. + - Issue #13557: Clarify effect of giving two different namespaces to exec or execfile().