FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-141004: Document missing type flags by ZeroIntensity · Pull Request #145127 · python/cpython · GitHub

/ cpython Public
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .rst  (1) .txt  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
46 changes: 46 additions & 0 deletions Doc/c-api/typeobj.rst
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
Original file line number Diff line number Diff line change
Expand Up @@ -1499,6 +1499,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
Expand Down
3 changes: 0 additions & 3 deletions Tools/check-c-api-docs/ignored_c_api.txt
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
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@ PyABIInfo_FREETHREADING_AGNOSTIC
PyModuleDef_Type
# 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
Expand Down
Loading

Back | FazBrowse Home | New Git URL