]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
bpo-41376: Fix the documentation of `site.getusersitepackages()` (GH-21602)
authorMiss Skeleton (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 8 Oct 2020 07:00:28 +0000 (00:00 -0700)
committerGitHub <noreply@github.com>
Thu, 8 Oct 2020 07:00:28 +0000 (00:00 -0700)
commit5b1fdcacfc36dfe36693f4c350c958df6600de14
treed00e3e77a2680b2d13e07c0043042d816b3ee28f
parentb664a1df4ee71d3760ab937653b10997081b1794
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 35f041dd0171f575fc3adce1709b31fdf45a5ff6)

Co-authored-by: Phil Elson <pelson.pub@gmail.com>
Doc/library/site.rst