Skip to content

gh-95245: Document Py_TPFLAGS_PREHEADER #135861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+15 −0
Open

gh-95245: Document Py_TPFLAGS_PREHEADER #135861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0eb59b3
Add comemnt for Py_TPFLAGS_PREHEADER
sergey-miryanov Jun 23, 2025
3195c33
Add Py_TPFLAGS_PREHEADER to typeobj.rst
sergey-miryanov Jun 24, 2025
6b37dcf
Add news
sergey-miryanov Jun 24, 2025
fc7fb85
Fix news entry
sergey-miryanov Jun 24, 2025
2062b3d
Update Doc/c-api/typeobj.rst
sergey-miryanov Jul 7, 2025
fd1f311
Delete news entry
sergey-miryanov Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions Doc/c-api/typeobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1287,6 +1287,18 @@ and :c:data:`PyType_Type` effectively act as defaults.)
:c:member:`~PyTypeObject.tp_weaklistoffset` field is set in a superclass.


.. c:macro:: Py_TPFLAGS_PREHEADER

A shorthand for checking if VM-managed fields are present.
Currently, this macro is equivalent to
:c:expr:`Py_TPFLAGS_MANAGED_DICT | Py_TPFLAGS_MANAGED_WEAKREF`.

This macro is intended for internal usage only; prefer using individual
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still not a big fan of documenting this as internal-only. If it's in the public headers and documentation, it should be at least usable. How about we say that its value is unstable, so we can change it later?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about this?
This macro is intended for internal usage only and may be changed without any notes

Is it OK or you prefer to completely remove the internal usage part?

flags instead.

.. versionadded:: 3.12


.. c:macro:: Py_TPFLAGS_ITEMS_AT_END

Only usable with variable-size types, i.e. ones with non-zero
Expand Down
3 changes: 3 additions & 0 deletions Include/object.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,6 +534,9 @@ given type object has a specified feature.
*/
#define Py_TPFLAGS_MANAGED_DICT (1 << 4)

/* Type has dictionary or weakref pointers that are managed by VM and has
* to allocate space to store these.
*/
#define Py_TPFLAGS_PREHEADER (Py_TPFLAGS_MANAGED_WEAKREF | Py_TPFLAGS_MANAGED_DICT)

/* Set if instances of the type object are treated as sequences for pattern matching */
Expand Down
Loading