-
-
Notifications
You must be signed in to change notification settings - Fork 32k
gh-85133: Add that getenv uses os.environ #91874
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.
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
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -292,7 +292,10 @@ process and user. | |
.. function:: getenv(key, default=None) | ||
|
||
Return the value of the environment variable *key* if it exists, or | ||
*default* if it doesn't. *key*, *default* and the result are str. | ||
*default* if it doesn't. *key*, *default* and the result are str. Note that | ||
since :func:`getenv` uses :data:`os.environ`, the mapping of :func:`getenv` is | ||
similarly also captured on import, and the function may not reflect | ||
future environment changes. | ||
|
||
On Unix, keys and values are decoded with :func:`sys.getfilesystemencoding` | ||
and ``'surrogateescape'`` error handler. Use :func:`os.getenvb` if you | ||
|
@@ -304,7 +307,11 @@ process and user. | |
.. function:: getenvb(key, default=None) | ||
|
||
Return the value of the environment variable *key* if it exists, or | ||
*default* if it doesn't. *key*, *default* and the result are bytes. | ||
*default* if it doesn't. *key*, *default* and the result are bytes. Note that | ||
since :func:`getenvb` uses :data:`os.environb`, the mapping of :func:`getenvb` is | ||
similarly also captured on import, and the function may not reflect | ||
future environment changes. | ||
|
||
|
||
:func:`getenvb` is only available if :data:`supports_bytes_environ` | ||
is ``True``. | ||
|
@@ -514,7 +521,8 @@ process and user. | |
Assignments to items in ``os.environ`` are automatically translated into | ||
corresponding calls to :func:`putenv`; however, calls to :func:`putenv` | ||
don't update ``os.environ``, so it is actually preferable to assign to items | ||
of ``os.environ``. | ||
of ``os.environ``. This also applies to :func:`getenv` and :func:`getenvb`, which | ||
respectively use ``os.environ`` and ``os.environb`` in their implementations. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Alternative wording can be something like 'This also applies to getenv, which uses os.environ in its implementation (and likewise for getenvb and environb).' |
||
|
||
.. note:: | ||
|
||
|
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.
Uh oh!
There was an error while loading. Please reload this page.