diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-09-11 06:36:50 -0700 |
|---|---|---|
| committer | Stéphane Wirtel <stephane@wirtel.be> | 2019-09-11 15:36:50 +0200 |
| commit | d1d968d45df1a900b0600c4d296b180aa978336d (patch) | |
| tree | 11e77c1346c76e08ae6a673e5235db7523d6a079 | |
| parent | da38ec1d4862ffb58faec41ed367719e81801766 (diff) | |
| download | cpython-git-d1d968d45df1a900b0600c4d296b180aa978336d.tar.gz | |
bpo-33944: note about the intended use of code in .pth files (GH-10131) (GH-15942)
https://bugs.python.org/issue33944
(cherry picked from commit f9b5840fb4497a9e2ba2c1f01ad0dafba04c8496)
Co-authored-by: native-api <ivan_pozdeev@mail.ru>
| -rw-r--r-- | Doc/library/site.rst | 13 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2018-10-26-18-10-29.bpo-33944.V1YeOA.rst | 1 |
2 files changed, 14 insertions, 0 deletions
diff --git a/Doc/library/site.rst b/Doc/library/site.rst index 9e4d402c1f..e1ca160c10 100644 --- a/Doc/library/site.rst +++ b/Doc/library/site.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 diff --git a/Misc/NEWS.d/next/Documentation/2018-10-26-18-10-29.bpo-33944.V1YeOA.rst b/Misc/NEWS.d/next/Documentation/2018-10-26-18-10-29.bpo-33944.V1YeOA.rst new file mode 100644 index 0000000000..29bec88c96 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2018-10-26-18-10-29.bpo-33944.V1YeOA.rst @@ -0,0 +1 @@ +Added a note about the intended use of code in .pth files. |