gh-47146: Soft-deprecate structmember.h, expose its contents via Python.h #99014
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
Old names are kept as aliases.
These docs were ripe for an overhaul, so I did one when touching the code.
|
Today I noticed the style guide says macros should have the |
And by the same token, |
|
And here are tests. |
encukou
added
the
bedevere-bot
removed
the
|
Thank you! I did the changes, and will merge once everything is green. |
|
Nice work! |
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.
The
structmember.hheader is deprecated, though it continues to be available and there are no plans to remove it. There are no deprecation warnings. Old code can stay unchanged (unless the extra include and non-namespaced macros bother you greatly). Specifically, no uses in CPython are updated -- that would just be unnecessary churn.The header's contents are now available just by including
Python.h, with aPY_prefix added if it was missing:PyMemberDef,PyMember_GetOne,PyMember_SetOnePY_T_INT,PY_T_DOUBLE, etc. (previouslyT_INT,T_DOUBLE, etc.)PY_READONLY(previouslyREADONLY) andPY_AUDIT_READ(name unchanged)Several items are not exposed from
Python.h:T_OBJECT(usePY_T_OBJECT_EX)T_NONE(previously undocumented, and pretty quirky)WRITE_RESTRICTEDwhich does nothing.RESTRICTEDandREAD_RESTRICTED, equivalents ofPY_AUDIT_READ.<stddef.h>is not included fromPython.h.It should be included manually when using
offsetof().The
PY_T_*,PY_READONLYandPY_AUDIT_READmacros are added to the stable API manifest. This is just a clerical change, really -- Stable ABI extensions in the wild usestructmember.h, andPyMemberDef&Py_tp_membersare already listed.There is discussion on the issue to rename
T_PYSSIZETtoPY_T_SSIZEor similar. I chose not to do that -- users will probably copy/paste that with any spelling, and not renaming it makes migration docs simpler.Co-Authored-By: Alexander Belopolsky abalkin@users.noreply.github.com
Co-Authored-By: Matthias Braun MatzeB@users.noreply.github.com