Reword atexit docs - #156086
Open
encukou wants to merge 1 commit into
Open
Conversation
For the `atexit` module: - Move common info from `register` to the module level (a lot of this was duplicated -- less maintainable and harder to read) - Use *interpreter shutdown* consistently, introducing it as a more general term for the old docs' "program termination". - Use consistent terminology (exit handlers) - Move warning for a mitigated footgun to a change entry - Add a new warning about keeping things usable Similarly clarify docs for the `atexit` attribute in `weakref`.
Documentation build overview
|
Comment on lines
38
to
39
| **Note:** The effect of registering or unregistering functions from within | ||
| a cleanup function is undefined. |
Member
There was a problem hiding this comment.
This is defined starting in 3.15; Python will run any handlers that have been added.
| Attempts to start a new thread or :func:`os.fork` a new process | ||
| in an exit handler now leads to :exc:`RuntimeError`. | ||
| Previously, this could cause race conditions between the main Python | ||
| runtime thread freeing thread states while internal :mod:`threading` |
Member
There was a problem hiding this comment.
Link to the term here?
Suggested change
| runtime thread freeing thread states while internal :mod:`threading` | |
| runtime thread freeing :term:`thread states <thread state>` while internal :mod:`threading` |
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
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.
For the
atexitmodule:registerto the module level (a lot of this was duplicated -- less maintainable and harder to read)Similarly clarify docs for the
atexitattribute inweakref.