gh-82419: Improve site docs to clarify user site-packages disabling #125083
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
merwok
changed the title
merwok
reviewed
Oct 8, 2024
Doc/library/site.rst
Outdated
| :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` |
There was a problem hiding this comment.
Let’s add some breathing space:
Suggested change
| administrator. Note that :func:`getusersitepackages` and :func:`getuserbase` | |
| administrator. | |
| Note that :func:`getusersitepackages` and :func:`getuserbase` |
merwok
reviewed
Oct 8, 2024
Doc/library/site.rst
Outdated
| administrator. | ||
| 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, |
There was a problem hiding this comment.
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)
merwok
reviewed
Oct 8, 2024
Doc/library/site.rst
Outdated
| 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, | ||
| users are encouraged to create :mod:`sitecustomize` or :mod:`usercustomize`, | ||
| rather than try to edit :file:`Lib/site.py`. Changing :file:`Lib/site.py` |
There was a problem hiding this comment.
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 🙂
There was a problem hiding this comment.
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)
merwok
reviewed
Oct 8, 2024
Doc/library/site.rst
Outdated
| users are encouraged to create :mod:`sitecustomize` or :mod:`usercustomize`, | ||
| rather than try to edit :file:`Lib/site.py`. Changing :file:`Lib/site.py` | ||
| won't work unless recompile Python, but administrators should still be able | ||
| to set :data:`ENABLE_USER_SITE` in a :mod:`sitecustomize` module. |
There was a problem hiding this comment.
I would delete that last sentence, it repeats info.
|
@merwok Thank you for your feedback, I will revise it later. |
merwok
reviewed
Oct 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on the discussion here: #82419 and advises from the @tiran and @encukou , I further clarified the relationship between ENABLE_USER_SITE and the functions
getusersitepackages()andgetuserbase()in the document. I also added a method to configure the output of these two functions.📚 Documentation preview 📚: https://cpython-previews--125083.org.readthedocs.build/