diff options
| author | Éric Araujo <merwok@netwok.org> | 2011-03-23 01:06:24 (GMT) |
|---|---|---|
| committer | Éric Araujo <merwok@netwok.org> | 2011-03-23 01:06:24 (GMT) |
| commit | c09fca67e7babfda22964143c74dcd313470850a (patch) | |
| tree | 050cead4915139132014dfda4a07c2d0872d314a /Doc | |
| parent | f59c7b2bddbeb552dac8a1fc8c800c7789c81331 (diff) | |
| download | cpython-c09fca67e7babfda22964143c74dcd313470850a.zip cpython-c09fca67e7babfda22964143c74dcd313470850a.tar.gz cpython-c09fca67e7babfda22964143c74dcd313470850a.tar.bz2 | |
Do not touch sys.path when site is imported and python was started with -S.
Original patch by Carl Meyer, review by Brett Cannon, small doc editions by
yours truly. Fixes #11591.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/site.rst | 13 | ||||
| -rw-r--r-- | Doc/using/cmdline.rst | 4 | ||||
| -rw-r--r-- | Doc/whatsnew/3.3.rst | 5 |
3 files changed, 20 insertions, 2 deletions
diff --git a/Doc/library/site.rst b/Doc/library/site.rst index b77f3cf..4b7a234 100644 --- a/Doc/library/site.rst +++ b/Doc/library/site.rst @@ -13,7 +13,11 @@ import can be suppressed using the interpreter's :option:`-S` option. .. index:: triple: module; search; path -Importing this module will append site-specific paths to the module search path. +Importing this module will append site-specific paths to the module search +path, unless :option:`-S` was used. In that case, this module can be safely +imported with no automatic modifications to the module search path. To +explicitly trigger the usual site-specific additions, call the +:func:`site.main` function. .. index:: pair: site-python; directory @@ -114,6 +118,13 @@ empty, and the path manipulations are skipped; however the import of .. envvar:: PYTHONUSERBASE +.. function:: main() + + Adds all the standard site-specific directories to the module search + path. This function is called automatically when this module is imported, + unless the :program:`python` interpreter was started with the :option:`-S` + flag. + .. function:: addsitedir(sitedir, known_paths=None) Adds a directory to sys.path and processes its pth files. diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index d1f47eb..b5a9b32 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -239,7 +239,9 @@ Miscellaneous options .. cmdoption:: -S Disable the import of the module :mod:`site` and the site-dependent - manipulations of :data:`sys.path` that it entails. + manipulations of :data:`sys.path` that it entails. Also disable these + manipulations if :mod:`site` is explicitly imported later (call + :func:`site.main` if you want them to be triggered). .. cmdoption:: -u diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst index d86826c..7f05a84 100644 --- a/Doc/whatsnew/3.3.rst +++ b/Doc/whatsnew/3.3.rst @@ -128,3 +128,8 @@ that may require changes to your code: * Stub + +.. Issue #11591: When :program:`python` was started with :option:`-S`, + ``import site`` will not add site-specific paths to the module search + paths. In previous versions, it did. See changeset for doc changes in + various files. Contributed by Carl Meyer with editions by Éric Araujo. |