traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Issue #9307: document the various Py_TPFLAGS_*_SUBCLASS flags. Patch by Yury V. Zaytsev.

This commit is contained in:
Antoine Pitrou 2014-04-29 01:39:03 +02:00
parent 9681022f1e
commit f9f54a2f5f
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/c-api/typeobj.rst
View File

@ -464,6 +464,24 @@ type objects) *must* have the :attr:`ob_size` field.
:const:`Py_TPFLAGS_HAVE_VERSION_TAG`.
.. data:: Py_TPFLAGS_LONG_SUBCLASS
.. data:: Py_TPFLAGS_LIST_SUBCLASS
.. data:: Py_TPFLAGS_TUPLE_SUBCLASS
.. data:: Py_TPFLAGS_BYTES_SUBCLASS
.. data:: Py_TPFLAGS_UNICODE_SUBCLASS
.. data:: Py_TPFLAGS_DICT_SUBCLASS
.. data:: Py_TPFLAGS_BASE_EXC_SUBCLASS
.. data:: Py_TPFLAGS_TYPE_SUBCLASS
These flags are used by functions such as
:c:func:`PyLong_Check` to quickly determine if a type is a subclass
of a built-in type; such specific checks are faster than a generic
check, like :c:func:`PyObject_IsInstance`. Custom types that inherit
from built-ins should have their :c:member:`~PyTypeObject.tp_flags`
set appropriately, or the code that interacts with such types
will behave differently depending on what kind of check is used.
.. data:: Py_TPFLAGS_HAVE_FINALIZE
This bit is set when the :c:member:`~PyTypeObject.tp_finalize` slot is present in the