Skip to content
Browse files

bpo-33944: note about the intended use of code in .pth files (GH-10131)

  • Loading branch information...
native-api authored and miss-islington committed Sep 11, 2019
1 parent 6f55b03 commit f9b5840fb4497a9e2ba2c1f01ad0dafba04c8496
Showing with 14 additions and 0 deletions.
  1. +13 −0 Doc/library/site.rst
  2. +1 −0 Misc/NEWS.d/next/Documentation/2018-10-26-18-10-29.bpo-33944.V1YeOA.rst
@@ -61,6 +61,19 @@ directory rather than a file. No item is added to ``sys.path`` more than
once. Blank lines and lines beginning with ``#`` are skipped. Lines starting
with ``import`` (followed by space or tab) are executed.

.. note::

An executable line in a :file:`.pth` file is run at every Python startup,
regardless of whether a particular module is actually going to be used.
Its impact should thus be kept to a minimum.
The primary intended purpose of executable lines is to make the
corresponding module(s) importable
(load 3rd-party import hooks, adjust :envvar:`PATH` etc).
Any other initialization is supposed to be done upon a module's
actual import, if and when it happens.
Limiting a code chunk to a single line is a deliberate measure
to discourage putting anything more complex here.

.. index::
single: package
triple: path; configuration; file
@@ -0,0 +1 @@
Added a note about the intended use of code in .pth files.

0 comments on commit f9b5840

Please sign in to comment.
You can’t perform that action at this time.