GH-95245: Document use of MANAGED flags instead of offsets.
#96044
Conversation
markshannon
commented
Aug 17, 2022
•
markshannon
commented
- Issue: Reduce the size of plain Python objects from 8 to 6 machine words. #95245
| {NULL} /* Sentinel */ | ||
| }; | ||
|
|
||
| The legacy offsets :c:member:`~PyTypeObject.tp_dictoffset` and | ||
| :c:member:`~PyTypeObject.tp_weaklistoffset` are still supported, but extensions are | ||
| strongly encouraged to use ``Py_TPFLAGS_MANAGED_DICT`` and |
There was a problem hiding this comment.
Can Py_TPFLAGS_MANAGED_DICT and Py_TPFLAGS_MANAGED_WEAKREF link to their definition in typeobj.rst below?
There was a problem hiding this comment.
:c:member:~PyTypeObject.tp_dictoffset` converts to a link to
https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_dictoffset
I don't think I can link into the table.
| @@ -96,7 +96,7 @@ Quick Reference | |||
| | | | __gt__, | | | | | | |||
| | | | __ge__ | | | | | | |||
| +------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+ | |||
| | :c:member:`~PyTypeObject.tp_weaklistoffset` | :c:type:`Py_ssize_t` | | | X | | ? | | |||
| | (:c:member:`~PyTypeObject.tp_weaklistoffset`) | :c:type:`Py_ssize_t` | | | X | | ? | | |||
There was a problem hiding this comment.
The parentheses indicate deprecation? Should we maybe say "(Deprecated in Python 3.12)" instead?
There was a problem hiding this comment.
The docs are always relevant to the current version, so it is implicit that this applies to 3.12.
This isn't a formal deprecation, more of a hint not to use these fields.
| @@ -117,7 +117,7 @@ Quick Reference | |||
| | :c:member:`~PyTypeObject.tp_descr_set` | :c:type:`descrsetfunc` | __set__, | | | | X | | |||
| | | | __delete__ | | | | | | |||
| +------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+ | |||
| | :c:member:`~PyTypeObject.tp_dictoffset` | :c:type:`Py_ssize_t` | | | X | | ? | | |||
| | (:c:member:`~PyTypeObject.tp_dictoffset`) | :c:type:`Py_ssize_t` | | | X | | ? | | |||
There was a problem hiding this comment.
Same as above regarding deprecation.
