gh-132331: Add tp_versions_used to PyTypeObject docs
#132335
Open
+13
−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
bedevere-app
bot
added
awaiting review
docs
sobolevn
reviewed
Apr 10, 2025
Co-authored-by: sobolevn <[email protected]>
|
All commit authors signed the Contributor License Agreement. |
| @@ -2229,6 +2231,17 @@ and :c:data:`PyType_Type` effectively act as defaults.) | |||
| .. versionadded:: 3.12 | |||
|
|
|||
|
|
|||
| .. c:member:: uint16_t PyTypeObject.tp_versions_used | |||
|
|
|||
| Internal. Do not use. | |||
There was a problem hiding this comment.
Why should we document something, just to tell people not to use it?
There was a problem hiding this comment.
This field is exposed to the user who may use local PyTypeObject instances that are statically initialized (the LinuxCNC project implements that use case several places). If you do not initialize this field, then you get a warning missing initializer for member '_typeobject::tp_versions_used'.
Therefore, it should be documented (and it needs to be set to zero when statically initialized).
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.
Fixes #132331. Add
tp_versions_usedto the tp slots section, as well as a description of the field itself. I've read through #113462 and its corresponding PR to understand how this field came about, but please let me know if there are any inaccuracies, thanks!tp_versions_usedwas added toPyTypeObjectbut is not documented #132331📚 Documentation preview 📚: https://cpython-previews--132335.org.readthedocs.build/