[3.13] gh-141004: Document missing type flags (GH-145127) (GH-145317)

gh-141004: Document missing type flags (GH-145127)
(cherry picked from commit dc1b56aa03)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
This commit is contained in:
Miss Islington (bot) 2026-02-27 16:17:22 +01:00 committed by GitHub
parent cd3e9b3fd2
commit cb3aba3a89
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 46 additions and 3 deletions

View file

@ -1414,6 +1414,52 @@ and :c:data:`PyType_Type` effectively act as defaults.)
It will be removed in a future version of CPython
.. c:macro:: Py_TPFLAGS_HAVE_VERSION_TAG
This is a :term:`soft deprecated` macro that does nothing.
Historically, this would indicate that the
:c:member:`~PyTypeObject.tp_version_tag` field was available and
initialized.
.. c:macro:: Py_TPFLAGS_INLINE_VALUES
This bit indicates that instances of this type will have an "inline values"
array (containing the object's attributes) placed directly after the end
of the object.
This requires that :c:macro:`Py_TPFLAGS_HAVE_GC` is set.
**Inheritance:**
This flag is not inherited.
.. versionadded:: 3.13
.. c:macro:: Py_TPFLAGS_IS_ABSTRACT
This bit indicates that this is an abstract type and therefore cannot
be instantiated.
**Inheritance:**
This flag is not inherited.
.. seealso::
:mod:`abc`
.. c:macro:: Py_TPFLAGS_HAVE_STACKLESS_EXTENSION
Internal. Do not set or unset this flag.
Historically, this was a reserved flag for use in Stackless Python.
.. warning::
This flag is present in header files, but is not be used.
This may be removed in a future version of CPython.
.. c:member:: const char* PyTypeObject.tp_doc
.. corresponding-type-slot:: Py_tp_doc

View file

@ -22,9 +22,6 @@ Py_HASH_EXTERNAL
PyABIInfo_FREETHREADING_AGNOSTIC
# object.h
Py_INVALID_SIZE
Py_TPFLAGS_HAVE_VERSION_TAG
Py_TPFLAGS_INLINE_VALUES
Py_TPFLAGS_IS_ABSTRACT
# pyexpat.h
PyExpat_CAPI_MAGIC
PyExpat_CAPSULE_NAME