gh-142518: Document thread-safety guarantees of dict operations #144184
+140
−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
picnixz
reviewed
Jan 24, 2026
| .. versionchanged:: 3.8 | ||
| Dictionaries are now reversible. | ||
|
|
||
| .. admonition:: Thread safety |
Member
There was a problem hiding this comment.
I
Suggested change
| .. admonition:: Thread safety | |
| .. _thread-safety-dict: | |
| .. rubric:: Thread safety for dict objects |
Admonition will create a big box which will not be good considering the size of the text. A rubric is like a title but without being it in the sidebar and a label allows us to link it.
Alternatively we can have a real section.
| across threads. See :ref:`freethreading-python-howto` for more information. | ||
|
|
||
|
|
||
| .. seealso:: |
Member
There was a problem hiding this comment.
I would suggest having this before the thread safety.
| These operations may compare keys using :meth:`~object.__eq__`, which can | ||
| execute arbitrary Python code. During such comparisons, the dictionary may | ||
| be modified by another thread. For built-in types like :class:`str`, |
Member
There was a problem hiding this comment.
IIRC devguide recommenda avoiding double spaces after periods for new documentation but I am not entirely sure.
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.
📚 Documentation preview 📚: https://cpython-previews--144184.org.readthedocs.build/