gh-138098: Clarify strong references in PyDict_Next docs for free-threaded build #138106
+8
−0
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
…ee-threaded build
| @@ -258,6 +258,14 @@ Dictionary Objects | |||
| value represents offsets within the internal dictionary structure, and | |||
| since the structure is sparse, the offsets are not consecutive. | |||
| .. note:: | |||
| In the free-threaded build, this function can be used safely inside | |||
There was a problem hiding this comment.
Suggested change
| In the free-threaded build, this function can be used safely inside | |
| On the :term:`free threaded <free threading>` build, this function can be used safely inside |
| In the free-threaded build, this function can be used safely inside | ||
| a critical section. However, the references returned for *pkey* and | ||
| *pvalue* are borrowed and only valid while the critical section is |
There was a problem hiding this comment.
Suggested change
| *pvalue* are borrowed and only valid while the critical section is | |
| *pvalue* are :term:`borrowed <borrowed reference>` and only valid while the critical section is |
| a critical section. However, the references returned for *pkey* and | ||
| *pvalue* are borrowed and only valid while the critical section is | ||
| held. If you need to use these objects outside the critical section, | ||
| create strong references (for example, with :c:func:`Py_NewRef`). |
There was a problem hiding this comment.
Suggested change
| create strong references (for example, with :c:func:`Py_NewRef`). | |
| create :term:`strong references <strong reference>` (for example, with :c:func:`Py_NewRef`). |
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.
This PR updates the documentation of :c:func:
PyDict_Nextto clarify thehandling of references in the free-threaded build.
Currently, the docs mention that
PyDict_Nextis not safe in the free-threadedbuild and suggest using a critical section. However, the returned
pkeyandpvalueare borrowed references, which are only valid while the criticalsection is held. If they need to be accessed outside of that critical section,
strong references must be created.
This PR adds a
.. note::block explaining this behavior explicitly, andsuggests using :c:func:
Py_NewRefto obtain strong references.Rationale
build.
Example of new docs rendering
Thanks!
📚 Documentation preview 📚: https://cpython-previews--138106.org.readthedocs.build/