gh-131117: Update tp_finalize example to use PyErr_GetRaisedException #131118
+2
−4
Conversation
This file contains 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
The tp_finalize C API doc used PyErr_Fetch and PyErr_Restore in its example code. That API was deprecated in 3.12. Update to point to the suggested replacement function PyErr_GetRaisedException which has a sample usage.
bedevere-app
bot
added
docs
cmaloney
changed the title
vstinner
reviewed
Mar 13, 2025
vstinner
reviewed
Mar 14, 2025
Doc/c-api/typeobj.rst
Outdated
| :c:member:`~PyTypeObject.tp_finalize` should not mutate the current exception status; | ||
| therefore, a recommended way to write a non-trivial finalizer is:: | ||
| :c:member:`~PyTypeObject.tp_finalize` should not mutate the current exception | ||
| status. Non-trivial finalizers should use :c:func:`PyErr_GetRaisedException`, |
There was a problem hiding this comment.
"non-trivial" is not accurate. You can have a lot of code which doesn't raise exceptions, and short code which raises exceptions. I prefer to keep the previous sentence.
|
CI / Github Actions workflow seems to have failed due to some restructuring (https://github.com/python/cpython/actions/runs/13864492893), looks like needs an update branch, should I do that? |
|
I clicked on Update Branch. Let's see if it helps. |
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.
The
tp_finalizeC API doc currently uses the older PyErr_Fetch + PyErr_Restore API to stash the current exception in its sample implementation. That API was deprecated in 3.12.Update to point to the suggested replacement function PyErr_GetRaisedException which has a sample usage.
📚 Documentation preview 📚: https://cpython-previews--131118.org.readthedocs.build/