Skip to content

gh-82419: Improve site docs to clarify user site-packages disabling #125083

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

gh-82419: Improve site docs to clarify user site-packages disabling #125083

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
afd431d
gh-82419 Refactor site.rst to clarify user site-packages disabling
pppppkun Oct 8, 2024
99a15eb
gh-82419 Revised the site docs about user site-packages disabling
pppppkun Oct 9, 2024
ef8b8cf
gh-82419 Revise the format of docs
pppppkun Oct 9, 2024
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
8 changes: 7 additions & 1 deletion Doc/library/site.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,13 @@ Module contents
was disabled by user request (with :option:`-s` or
:envvar:`PYTHONNOUSERSITE`). ``None`` means it was disabled for security
reasons (mismatch between user or group id and effective id) or by an
administrator.
administrator. Note that :func:`getusersitepackages` and :func:`getuserbase`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let’s add some breathing space:

Suggested change
administrator. Note that :func:`getusersitepackages` and :func:`getuserbase`
administrator.
Note that :func:`getusersitepackages` and :func:`getuserbase`

don't take this variable into account. The check for :data:`ENABLE_USER_SITE` and
modification of ``sys.path`` occurs later. To disable user site-packages,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
modification of ``sys.path`` occurs later. To disable user site-packages,
modification of ``sys.path`` occur later. To disable user site-packages,

(two things occur)

users are encouraged to create :mod:`sitecustomize` or :mod:`usercustomize`,
rather than try to edit :file:`Lib/site.py`. Changing :file:`Lib/site.py`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should refer to the site module, not to the Lib/site.py file that only exists with that name in cpython repo, not after installation 🙂

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or maybe something like: rather than try to edit site.py to make it clear we’re talking about the file, not the module (which is something living in the memory of a python interpreter)

won't work unless recompile Python, but administrators should still be able
to set :data:`ENABLE_USER_SITE` in a :mod:`sitecustomize` module.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would delete that last sentence, it repeats info.



.. data:: USER_SITE
Expand Down
Loading