Skip to content

[3.9] bpo-41376: Fix the documentation of site.getusersitepackages() (GH-21602) #22591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miss-islington merged 1 commit into from
Oct 8, 2020
+3 −1
Merged

[3.9] bpo-41376: Fix the documentation of site.getusersitepackages() (GH-21602) #22591

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
bpo-41376: Fix the documentation of site.getusersitepackages() (GH-… 
…21602)

`site.getusersitepackages()` returns the location of the user-specific site-packages directory
even when the user-specific site-packages is disabled.

```
$ python -s -m site
sys.path = [
    '/home/user/conda/lib/python37.zip',
    '/home/user/conda/lib/python3.7',
    '/home/user/conda/lib/python3.7/lib-dynload',
    '/home/user/conda/lib/python3.7/site-packages',
]
USER_BASE: '/home/user/.local' (exists)
USER_SITE: '/home/user/.local/lib/python3.7/site-packages' (doesn't exist)
ENABLE_USER_SITE: False
```

It was not practical to prevent the function from returning None if user-specific site-packages are disabled, since there are other uses of the function which are relying on this behaviour (e.g. `python -m site`).
(cherry picked from commit 35f041d)

Co-authored-by: Phil Elson <pelson.pub@gmail.com>
  • Loading branch information
@pelson @miss-islington
pelson authored and miss-islington committed Oct 8, 2020
commit fec3078bc7f72bedc6ee776aaa5a36983731118c
4 changes: 3 additions & 1 deletion Doc/library/site.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,9 @@ Module contents

Return the path of the user-specific site-packages directory,
:data:`USER_SITE`. If it is not initialized yet, this function will also set
it, respecting :envvar:`PYTHONNOUSERSITE` and :data:`USER_BASE`.
it, respecting :data:`USER_BASE`. To determine if the user-specific
site-packages was added to ``sys.path`` :data:`ENABLE_USER_SITE` should be
used.

.. versionadded:: 3.2

Expand Down