bpo-32699: Improves doc for .pth files in presense of a ._pth file (#5399)

This commit is contained in:
Steve Dower 2018-01-29 10:34:09 +11:00 committed by GitHub
parent f11b460d87
commit 15ea3a6a32
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -721,7 +721,7 @@ installation directory. So, if you had installed Python to
:file:`C:\\Python\\Lib\\site-packages\\`.
To completely override :data:`sys.path`, create a ``._pth`` file with the same
name as the DLL (``python36._pth``) or the executable (``python._pth``) and
name as the DLL (``python37._pth``) or the executable (``python._pth``) and
specify one line for each path to add to :data:`sys.path`. The file based on the
DLL name overrides the one based on the executable, which allows paths to be
restricted for any program loading the runtime if desired.
@ -734,7 +734,7 @@ Import statements other than to ``site`` are not permitted, and arbitrary code
cannot be specified.
Note that ``.pth`` files (without leading underscore) will be processed normally
by the :mod:`site` module.
by the :mod:`site` module when ``import site`` has been specified.
When no ``._pth`` file is found, this is how :data:`sys.path` is populated on
Windows:
@ -796,7 +796,7 @@ following advice will prevent conflicts with other installations:
environment variables, and also ignore :mod:`site` unless ``import site`` is
listed.
* If you are loading :file:`python3.dll` or :file:`python36.dll` in your own
* If you are loading :file:`python3.dll` or :file:`python37.dll` in your own
executable, explicitly call :c:func:`Py_SetPath` or (at least)
:c:func:`Py_SetProgramName` before :c:func:`Py_Initialize`.
@ -930,7 +930,7 @@ directly accessed by end-users.
When extracted, the embedded distribution is (almost) fully isolated from the
user's system, including environment variables, system registry settings, and
installed packages. The standard library is included as pre-compiled and
optimized ``.pyc`` files in a ZIP, and ``python3.dll``, ``python36.dll``,
optimized ``.pyc`` files in a ZIP, and ``python3.dll``, ``python37.dll``,
``python.exe`` and ``pythonw.exe`` are all provided. Tcl/tk (including all
dependants, such as Idle), pip and the Python documentation are not included.