traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make site documentation more clear (#5461) 

Mention only ImportError caused by importing sitecustomize.py/usercustomize.py
themselves will be silently ignored.
This commit is contained in:
Xiang Zhang 2018-01-31 23:50:50 +08:00 committed by Ned Deily
parent 86fdad093b
commit f3da70f8ab
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Doc/library/site.rst
View File

@ -97,12 +97,12 @@ not mentioned in either path configuration file.
After these path manipulations, an attempt is made to import a module named After these path manipulations, an attempt is made to import a module named
:mod:`sitecustomize`, which can perform arbitrary site-specific customizations. :mod:`sitecustomize`, which can perform arbitrary site-specific customizations.
It is typically created by a system administrator in the site-packages It is typically created by a system administrator in the site-packages
directory. If this import fails with an :exc:`ImportError` exception, it is directory. If this import fails with an :exc:`ImportError` or its subclass
silently ignored. If Python is started without output streams available, as exception, and the exception's :attr:`name` attribute equals to ``'sitecustomize'``,
it is silently ignored. If Python is started without output streams available, as
with :file:`pythonw.exe` on Windows (which is used by default to start IDLE), with :file:`pythonw.exe` on Windows (which is used by default to start IDLE),
attempted output from :mod:`sitecustomize` is ignored. Any exception other attempted output from :mod:`sitecustomize` is ignored. Any other exception
than :exc:`ImportError` causes a silent and perhaps mysterious failure of the causes a silent and perhaps mysterious failure of the process.
process.
.. index:: module: usercustomize .. index:: module: usercustomize
@ -110,7 +110,9 @@ After this, an attempt is made to import a module named :mod:`usercustomize`,
which can perform arbitrary user-specific customizations, if which can perform arbitrary user-specific customizations, if
:data:`ENABLE_USER_SITE` is true. This file is intended to be created in the :data:`ENABLE_USER_SITE` is true. This file is intended to be created in the
user site-packages directory (see below), which is part of ``sys.path`` unless user site-packages directory (see below), which is part of ``sys.path`` unless
disabled by :option:`-s`. An :exc:`ImportError` will be silently ignored. disabled by :option:`-s`. If this import fails with an :exc:`ImportError` or
its subclass exception, and the exception's :attr:`name` attribute equals to
``'usercustomize'``, it is silently ignored.
Note that for some non-Unix systems, ``sys.prefix`` and ``sys.exec_prefix`` are Note that for some non-Unix systems, ``sys.prefix`` and ``sys.exec_prefix`` are
empty, and the path manipulations are skipped; however the import of empty, and the path manipulations are skipped; however the import of