Docs: Clarify generator.close() behavior regarding GeneratorExit #135819
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. |
|
I have opened PR #135819 that clarifies the documentation. Kindly review. Thanks! |
|
Hi, thanks for contributing! There's already an open PR for this issue: #135152. That's already been approved, so I think this probably won't land. |
|
Closing as a duplicate then. In the future, look at the end of the issue to see if a PR already exists. TiA. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
gh-135110: Clarify that generator.close() does not externally raise GeneratorExit
Where: gh-135110 refers to the GitHub issue number being fixed.
This change addresses a documentation inconsistency where it was previously implied that
generator.close()raises aGeneratorExitexternally. However, this exception is raised inside the generator at the suspension point, and if not handled, it fails silently without propagating.This change helps new users clearly understand how
close()behaves when called on a generator.Closes: gh-135110
-->
📚 Documentation preview 📚: https://cpython-previews--135819.org.readthedocs.build/