Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 23:21:29 +00:00
Code Issues Projects Releases Packages Wiki Activity
cpython/Doc/c-api/typeobj.rst

2836 lines
130 KiB
ReStructuredText
Raw Normal View History

Doc: Replace the deprecated highlightlang directive by highlight. (#13377) highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845
2019-05-17 11:55:34 +02:00
.. highlight:: c
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
.. _type-structs:
Type Objects
============
Perhaps one of the most important structures of the Python object system is the
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
structure that defines a new type: the :c:type:`PyTypeObject` structure. Type
gh-93738: Documentation C syntax (Function glob patterns -> literal markup) (#97774)
2022-10-05 16:22:28 +01:00
objects can be handled using any of the ``PyObject_*`` or
``PyType_*`` functions, but do not offer much that's interesting to most
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Python applications. These objects are fundamental to how objects behave, so
they are very important to the interpreter itself and to any extension module
that implements new types.
Type objects are fairly large compared to most of the standard types. The reason
for the size is that each type object stores a large number of values, mostly C
function pointers, each of which implements a small part of the type's
functionality. The fields of the type object are examined in detail in this
section. The fields will be described in the order in which they occur in the
structure.
bpo-38103: fix conflicting labels in the docs. (GH-15906)
2019-09-11 11:57:59 +01:00
In addition to the following quick reference, the :ref:`typedef-examples`
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
section provides at-a-glance insight into the meaning and use of
:c:type:`PyTypeObject`.
Quick Reference
---------------
.. _tp-slots-table:
"tp slots"
^^^^^^^^^^
.. table::
:widths: 18,18,18,1,1,1,1
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
+------------------------------------------------+-----------------------------------+-------------------+---------------+
| PyTypeObject Slot [#slots]_ | :ref:`Type <slot-typedefs-table>` | special | Info [#cols]_ |
| | | methods/attrs +---+---+---+---+
| | | | O | T | D | I |
+================================================+===================================+===================+===+===+===+===+
| <R> :c:member:`~PyTypeObject.tp_name` | const char * | __name__ | X | X | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
Document Py_ssize_t. (GH-92512) It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But there's 8182 errors left. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-05-13 14:10:16 +02:00
| :c:member:`~PyTypeObject.tp_basicsize` | :c:type:`Py_ssize_t` | | X | X | | X |
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
Document Py_ssize_t. (GH-92512) It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But there's 8182 errors left. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-05-13 14:10:16 +02:00
| :c:member:`~PyTypeObject.tp_itemsize` | :c:type:`Py_ssize_t` | | | X | | X |
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_dealloc` | :c:type:`destructor` | | X | X | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
Document Py_ssize_t. (GH-92512) It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But there's 8182 errors left. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-05-13 14:10:16 +02:00
| :c:member:`~PyTypeObject.tp_vectorcall_offset` | :c:type:`Py_ssize_t` | | | X | | X |
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| (:c:member:`~PyTypeObject.tp_getattr`) | :c:type:`getattrfunc` | __getattribute__, | | | | G |
| | | __getattr__ | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| (:c:member:`~PyTypeObject.tp_setattr`) | :c:type:`setattrfunc` | __setattr__, | | | | G |
| | | __delattr__ | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_as_async` | :c:type:`PyAsyncMethods` * | :ref:`sub-slots` | | | | % |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_repr` | :c:type:`reprfunc` | __repr__ | X | X | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_as_number` | :c:type:`PyNumberMethods` * | :ref:`sub-slots` | | | | % |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_as_sequence` | :c:type:`PySequenceMethods` * | :ref:`sub-slots` | | | | % |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_as_mapping` | :c:type:`PyMappingMethods` * | :ref:`sub-slots` | | | | % |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_hash` | :c:type:`hashfunc` | __hash__ | X | | | G |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_call` | :c:type:`ternaryfunc` | __call__ | | X | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_str` | :c:type:`reprfunc` | __str__ | X | | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_getattro` | :c:type:`getattrofunc` | __getattribute__, | X | X | | G |
| | | __getattr__ | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_setattro` | :c:type:`setattrofunc` | __setattr__, | X | X | | G |
| | | __delattr__ | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_as_buffer` | :c:type:`PyBufferProcs` * | | | | | % |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_flags` | unsigned long | | X | X | | ? |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_doc` | const char * | __doc__ | X | X | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_traverse` | :c:type:`traverseproc` | | | X | | G |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_clear` | :c:type:`inquiry` | | | X | | G |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_richcompare` | :c:type:`richcmpfunc` | __lt__, | X | | | G |
| | | __le__, | | | | |
| | | __eq__, | | | | |
| | | __ne__, | | | | |
| | | __gt__, | | | | |
| | | __ge__ | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
| (:c:member:`~PyTypeObject.tp_weaklistoffset`) | :c:type:`Py_ssize_t` | | | X | | ? |
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_iter` | :c:type:`getiterfunc` | __iter__ | | | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_iternext` | :c:type:`iternextfunc` | __next__ | | | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_methods` | :c:type:`PyMethodDef` [] | | X | X | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_members` | :c:type:`PyMemberDef` [] | | | X | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_getset` | :c:type:`PyGetSetDef` [] | | X | X | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_base` | :c:type:`PyTypeObject` * | __base__ | | | X | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_dict` | :c:type:`PyObject` * | __dict__ | | | ? | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_descr_get` | :c:type:`descrgetfunc` | __get__ | | | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_descr_set` | :c:type:`descrsetfunc` | __set__, | | | | X |
| | | __delete__ | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
| (:c:member:`~PyTypeObject.tp_dictoffset`) | :c:type:`Py_ssize_t` | | | X | | ? |
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_init` | :c:type:`initproc` | __init__ | X | X | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_alloc` | :c:type:`allocfunc` | | X | | ? | ? |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_new` | :c:type:`newfunc` | __new__ | X | X | ? | ? |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_free` | :c:type:`freefunc` | | X | X | ? | ? |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_is_gc` | :c:type:`inquiry` | | | X | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| <:c:member:`~PyTypeObject.tp_bases`> | :c:type:`PyObject` * | __bases__ | | | ~ | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| <:c:member:`~PyTypeObject.tp_mro`> | :c:type:`PyObject` * | __mro__ | | | ~ | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| [:c:member:`~PyTypeObject.tp_cache`] | :c:type:`PyObject` * | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
gh-94673: Add Per-Interpreter tp_subclasses for Static Builtin Types (gh-95301)
2022-08-04 19:26:59 -06:00
| [:c:member:`~PyTypeObject.tp_subclasses`] | void * | __subclasses__ | | | |
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| [:c:member:`~PyTypeObject.tp_weaklist`] | :c:type:`PyObject` * | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| (:c:member:`~PyTypeObject.tp_del`) | :c:type:`destructor` | | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| [:c:member:`~PyTypeObject.tp_version_tag`] | unsigned int | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_finalize` | :c:type:`destructor` | __del__ | | | | X |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
| :c:member:`~PyTypeObject.tp_vectorcall` | :c:type:`vectorcallfunc` | | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
gh-91051: fix segfault when using all 8 type watchers (#107853)
2023-08-11 12:42:26 -06:00
| [:c:member:`~PyTypeObject.tp_watched`] | unsigned char | | | | | |
GH-99767: update PyTypeObject docs for type watchers (GH-99928)
2022-12-15 04:26:08 -07:00
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. [#slots]
gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342) These slots are marked "should be treated as read-only" in the table at the start of the document. That doesn't say anything about setting them in the static struct. `tp_bases` docs did say that it should be ``NULL`` (TIL!). If you ignore that, seemingly nothing bad happens. However, some slots may not be inherited, depending on which sub-slot structs are present. (FWIW, NumPy sets tp_bases and is affected by the quirk -- though to be fair, its DUAL_INHERIT code probably predates tp_bases docs, and also the result happens to be benign.) This patch makes things explicit. It also makes the summary table legend easier to scan. Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-11-28 09:22:08 +01:00
**()**: A slot name in parentheses indicates it is (effectively) deprecated.
**<>**: Names in angle brackets should be initially set to ``NULL`` and
treated as read-only.
**[]**: Names in square brackets are for internal use only.
**<R>** (as a prefix) means the field is required (must be non-``NULL``).
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. [#cols] Columns:
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
**"O"**: set on :c:data:`PyBaseObject_Type`
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
**"T"**: set on :c:data:`PyType_Type`
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
**"D"**: default (if slot is set to ``NULL``)
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. code-block:: none
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
X - PyType_Ready sets this value if it is NULL
~ - PyType_Ready always sets this value (it should be NULL)
? - PyType_Ready may set this value depending on other slots
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Also see the inheritance column ("I").
**"I"**: inheritance
.. code-block:: none
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
X - type slot is inherited via *PyType_Ready* if defined with a *NULL* value
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
% - the slots of the sub-struct are inherited individually
G - inherited, but only in combination with other slots; see the slot's description
? - it's complicated; see the slot's description
Note that some slots are effectively inherited through the normal
attribute lookup chain.
.. _sub-slots:
sub-slots
^^^^^^^^^
.. table::
:widths: 26,17,12
docs: correct references to __isub__ etc (GH-28297)
2021-09-16 09:33:41 +01:00
+---------------------------------------------------------+-----------------------------------+---------------+
| Slot | :ref:`Type <slot-typedefs-table>` | special |
| | | methods |
+=========================================================+===================================+===============+
| :c:member:`~PyAsyncMethods.am_await` | :c:type:`unaryfunc` | __await__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyAsyncMethods.am_aiter` | :c:type:`unaryfunc` | __aiter__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyAsyncMethods.am_anext` | :c:type:`unaryfunc` | __anext__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyAsyncMethods.am_send` | :c:type:`sendfunc` | |
+---------------------------------------------------------+-----------------------------------+---------------+
| |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_add` | :c:type:`binaryfunc` | __add__ |
| | | __radd__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_add` | :c:type:`binaryfunc` | __iadd__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_subtract` | :c:type:`binaryfunc` | __sub__ |
| | | __rsub__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_subtract` | :c:type:`binaryfunc` | __isub__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_multiply` | :c:type:`binaryfunc` | __mul__ |
| | | __rmul__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_multiply` | :c:type:`binaryfunc` | __imul__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_remainder` | :c:type:`binaryfunc` | __mod__ |
| | | __rmod__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_remainder` | :c:type:`binaryfunc` | __imod__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_divmod` | :c:type:`binaryfunc` | __divmod__ |
| | | __rdivmod__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_power` | :c:type:`ternaryfunc` | __pow__ |
| | | __rpow__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_power` | :c:type:`ternaryfunc` | __ipow__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_negative` | :c:type:`unaryfunc` | __neg__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_positive` | :c:type:`unaryfunc` | __pos__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_absolute` | :c:type:`unaryfunc` | __abs__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_bool` | :c:type:`inquiry` | __bool__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_invert` | :c:type:`unaryfunc` | __invert__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_lshift` | :c:type:`binaryfunc` | __lshift__ |
| | | __rlshift__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_lshift` | :c:type:`binaryfunc` | __ilshift__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_rshift` | :c:type:`binaryfunc` | __rshift__ |
| | | __rrshift__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_rshift` | :c:type:`binaryfunc` | __irshift__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_and` | :c:type:`binaryfunc` | __and__ |
| | | __rand__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_and` | :c:type:`binaryfunc` | __iand__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_xor` | :c:type:`binaryfunc` | __xor__ |
| | | __rxor__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_xor` | :c:type:`binaryfunc` | __ixor__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_or` | :c:type:`binaryfunc` | __or__ |
| | | __ror__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_or` | :c:type:`binaryfunc` | __ior__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_int` | :c:type:`unaryfunc` | __int__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_reserved` | void * | |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_float` | :c:type:`unaryfunc` | __float__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_floor_divide` | :c:type:`binaryfunc` | __floordiv__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_floor_divide` | :c:type:`binaryfunc` | __ifloordiv__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_true_divide` | :c:type:`binaryfunc` | __truediv__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_true_divide` | :c:type:`binaryfunc` | __itruediv__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_index` | :c:type:`unaryfunc` | __index__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_matrix_multiply` | :c:type:`binaryfunc` | __matmul__ |
| | | __rmatmul__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_matrix_multiply` | :c:type:`binaryfunc` | __imatmul__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyMappingMethods.mp_length` | :c:type:`lenfunc` | __len__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyMappingMethods.mp_subscript` | :c:type:`binaryfunc` | __getitem__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyMappingMethods.mp_ass_subscript` | :c:type:`objobjargproc` | __setitem__, |
| | | __delitem__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_length` | :c:type:`lenfunc` | __len__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_concat` | :c:type:`binaryfunc` | __add__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_repeat` | :c:type:`ssizeargfunc` | __mul__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_item` | :c:type:`ssizeargfunc` | __getitem__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_ass_item` | :c:type:`ssizeobjargproc` | __setitem__ |
| | | __delitem__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_contains` | :c:type:`objobjproc` | __contains__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_inplace_concat` | :c:type:`binaryfunc` | __iadd__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_inplace_repeat` | :c:type:`ssizeargfunc` | __imul__ |
+---------------------------------------------------------+-----------------------------------+---------------+
| |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyBufferProcs.bf_getbuffer` | :c:func:`getbufferproc` | |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyBufferProcs.bf_releasebuffer` | :c:func:`releasebufferproc` | |
+---------------------------------------------------------+-----------------------------------+---------------+
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. _slot-typedefs-table:
slot typedefs
^^^^^^^^^^^^^
+-----------------------------+-----------------------------+----------------------+
| typedef | Parameter Types | Return Type |
+=============================+=============================+======================+
| :c:type:`allocfunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyTypeObject` * | |
Document Py_ssize_t. (GH-92512) It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But there's 8182 errors left. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-05-13 14:10:16 +02:00
| | :c:type:`Py_ssize_t` | |
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
+-----------------------------+-----------------------------+----------------------+
gh-111178: Docs: fix `traverseproc`, `inquiry`, and `destructor` parameters in slot typedefs table (GH-112742) In the slot typedefs table, the parameter of `destructor` and the first parameter of `traverseproc` should both be `PyObject *` rather than `void *`. Same for `inquiry`.
2023-12-06 03:44:41 -06:00
| :c:type:`destructor` | :c:type:`PyObject` * | void |
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
+-----------------------------+-----------------------------+----------------------+
| :c:type:`freefunc` | void * | void |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`traverseproc` | .. line-block:: | int |
| | | |
gh-111178: Docs: fix `traverseproc`, `inquiry`, and `destructor` parameters in slot typedefs table (GH-112742) In the slot typedefs table, the parameter of `destructor` and the first parameter of `traverseproc` should both be `PyObject *` rather than `void *`. Same for `inquiry`.
2023-12-06 03:44:41 -06:00
| | :c:type:`PyObject` * | |
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
| | :c:type:`visitproc` | |
| | void * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`newfunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`initproc` | .. line-block:: | int |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`reprfunc` | :c:type:`PyObject` * | :c:type:`PyObject` * |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`getattrfunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyObject` * | |
| | const char * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`setattrfunc` | .. line-block:: | int |
| | | |
| | :c:type:`PyObject` * | |
| | const char * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`getattrofunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`setattrofunc` | .. line-block:: | int |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`descrgetfunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`descrsetfunc` | .. line-block:: | int |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`hashfunc` | :c:type:`PyObject` * | Py_hash_t |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`richcmpfunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
| | int | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`getiterfunc` | :c:type:`PyObject` * | :c:type:`PyObject` * |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`iternextfunc` | :c:type:`PyObject` * | :c:type:`PyObject` * |
+-----------------------------+-----------------------------+----------------------+
Document Py_ssize_t. (GH-92512) It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But there's 8182 errors left. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-05-13 14:10:16 +02:00
| :c:type:`lenfunc` | :c:type:`PyObject` * | :c:type:`Py_ssize_t` |
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
+-----------------------------+-----------------------------+----------------------+
| :c:type:`getbufferproc` | .. line-block:: | int |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`Py_buffer` * | |
| | int | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`releasebufferproc` | .. line-block:: | void |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`Py_buffer` * | |
+-----------------------------+-----------------------------+----------------------+
gh-111178: Docs: fix `traverseproc`, `inquiry`, and `destructor` parameters in slot typedefs table (GH-112742) In the slot typedefs table, the parameter of `destructor` and the first parameter of `traverseproc` should both be `PyObject *` rather than `void *`. Same for `inquiry`.
2023-12-06 03:44:41 -06:00
| :c:type:`inquiry` | :c:type:`PyObject` * | int |
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
+-----------------------------+-----------------------------+----------------------+
| :c:type:`unaryfunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`binaryfunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`ternaryfunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`ssizeargfunc` | .. line-block:: | :c:type:`PyObject` * |
| | | |
| | :c:type:`PyObject` * | |
Document Py_ssize_t. (GH-92512) It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But there's 8182 errors left. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-05-13 14:10:16 +02:00
| | :c:type:`Py_ssize_t` | |
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
+-----------------------------+-----------------------------+----------------------+
| :c:type:`ssizeobjargproc` | .. line-block:: | int |
| | | |
| | :c:type:`PyObject` * | |
Document Py_ssize_t. (GH-92512) It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But there's 8182 errors left. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-05-13 14:10:16 +02:00
| | :c:type:`Py_ssize_t` | |
docs: fix `ssizeobjargproc` parameters (#100736)
2023-01-04 02:17:42 -06:00
| | :c:type:`PyObject` * | |
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
+-----------------------------+-----------------------------+----------------------+
| :c:type:`objobjproc` | .. line-block:: | int |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
| :c:type:`objobjargproc` | .. line-block:: | int |
| | | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
| | :c:type:`PyObject` * | |
+-----------------------------+-----------------------------+----------------------+
See :ref:`slot-typedefs` below for more detail.
PyTypeObject Definition
-----------------------
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
The structure definition for :c:type:`PyTypeObject` can be found in
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
:file:`Include/object.h`. For convenience of reference, this repeats the
definition found there:
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. XXX Drop this?
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
.. literalinclude:: ../includes/typestruct.h
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
PyObject Slots
--------------
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
The type object structure extends the :c:type:`PyVarObject` structure. The
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
:c:member:`~PyVarObject.ob_size` field is used for dynamic types (created by :c:func:`!type_new`,
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
usually called from a class statement). Note that :c:data:`PyType_Type` (the
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
metatype) initializes :c:member:`~PyTypeObject.tp_itemsize`, which means that its instances (i.e.
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
type objects) *must* have the :c:member:`~PyVarObject.ob_size` field.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: Py_ssize_t PyObject.ob_refcnt
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This is the type object's reference count, initialized to ``1`` by the
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
``PyObject_HEAD_INIT`` macro. Note that for :ref:`statically allocated type
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
objects <static-types>`, the type's instances (objects whose :c:member:`~PyObject.ob_type`
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
points back to the type) do *not* count as references. But for
:ref:`dynamically allocated type objects <heap-types>`, the instances *do*
count as references.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is not inherited by subtypes.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: PyTypeObject* PyObject.ob_type
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This is the type's type, in other words its metatype. It is initialized by the
argument to the ``PyObject_HEAD_INIT`` macro, and its value should normally be
``&PyType_Type``. However, for dynamically loadable extension modules that must
be usable on Windows (at least), the compiler complains that this is not a valid
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
initializer. Therefore, the convention is to pass ``NULL`` to the
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
``PyObject_HEAD_INIT`` macro and to initialize this field explicitly at the
start of the module's initialization function, before doing anything else. This
is typically done like this::
Foo_Type.ob_type = &PyType_Type;
This should be done before any instances of the type are created.
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
:c:func:`PyType_Ready` checks if :c:member:`~PyObject.ob_type` is ``NULL``, and if so,
initializes it to the :c:member:`~PyObject.ob_type` field of the base class.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:func:`PyType_Ready` will not change this field if it is non-zero.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Remove many "versionchanged" items that didn't use the official markup, but just some text embedded in the docs. Also remove paragraph about implicit relative imports from tutorial.
2008-05-12 18:05:20 +00:00
This field is inherited by subtypes.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
PyVarObject Slots
-----------------
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: Py_ssize_t PyVarObject.ob_size
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
For :ref:`statically allocated type objects <static-types>`, this should be
initialized to zero. For :ref:`dynamically allocated type objects
<heap-types>`, this field has a special internal meaning.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is not inherited by subtypes.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
PyTypeObject Slots
------------------
Each slot has a section describing inheritance. If :c:func:`PyType_Ready`
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
may set a value when the field is set to ``NULL`` then there will also be
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
a "Default" section. (Note that many fields set on :c:data:`PyBaseObject_Type`
and :c:data:`PyType_Type` effectively act as defaults.)
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Issue #24808: Update the documentation of some PyTypeObject fields Patch by Joseph Weston.
2015-08-25 05:06:39 +00:00
.. c:member:: const char* PyTypeObject.tp_name
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Pointer to a NUL-terminated string containing the name of the type. For types
that are accessible as module globals, the string should be the full module
name, followed by a dot, followed by the type name; for built-in types, it
should be just the type name. If the module is a submodule of a package, the
full package name is part of the full module name. For example, a type named
gh-107298: Fix more Sphinx warnings in the C API doc (#107329) Declare the following functions as macros, since they are actually macros. It avoids a warning on "TYPE" or "macro" argument. * PyMem_New() * PyMem_Resize() * PyModule_AddIntMacro() * PyModule_AddStringMacro() * PyObject_GC_New() * PyObject_GC_NewVar() * PyObject_New() * PyObject_NewVar() Add C standard C types to nitpick_ignore in Doc/conf.py: * int64_t * uint64_t * uintptr_t No longer ignore non existing "__int" type in nitpick_ignore. Update Doc/tools/.nitignore
2023-07-27 02:52:40 +02:00
:class:`!T` defined in module :mod:`!M` in subpackage :mod:`!Q` in package :mod:`!P`
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
should have the :c:member:`~PyTypeObject.tp_name` initializer ``"P.Q.M.T"``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
For :ref:`dynamically allocated type objects <heap-types>`,
this should just be the type name, and
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
the module name explicitly stored in the type dict as the value for key
``'__module__'``.
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
For :ref:`statically allocated type objects <static-types>`,
the *tp_name* field should contain a dot.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Everything before the last dot is made accessible as the :attr:`__module__`
attribute, and everything after the last dot is made accessible as the
Issue #24314: Fix doc links for general attributes like __name__, __dict__
2016-06-18 03:57:31 +00:00
:attr:`~definition.__name__` attribute.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
If no dot is present, the entire :c:member:`~PyTypeObject.tp_name` field is made accessible as the
Issue #24314: Fix doc links for general attributes like __name__, __dict__
2016-06-18 03:57:31 +00:00
:attr:`~definition.__name__` attribute, and the :attr:`__module__` attribute is undefined
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
(unless explicitly set in the dictionary, as explained above). This means your
Issue #18287: PyType_Ready() now checks that tp_name is not NULL. Original patch by Niklas Koep.
2016-10-07 23:24:35 +03:00
type will be impossible to pickle. Additionally, it will not be listed in
module documentations created with pydoc.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
This field must not be ``NULL``. It is the only required field
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
in :c:func:`PyTypeObject` (other than potentially
:c:member:`~PyTypeObject.tp_itemsize`).
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is not inherited by subtypes.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: Py_ssize_t PyTypeObject.tp_basicsize
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Py_ssize_t PyTypeObject.tp_itemsize
These fields allow calculating the size in bytes of instances of the type.
There are two kinds of types: types with fixed-length instances have a zero
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_itemsize` field, types with variable-length instances have a non-zero
:c:member:`~PyTypeObject.tp_itemsize` field. For a type with fixed-length instances, all
instances have the same size, given in :c:member:`~PyTypeObject.tp_basicsize`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
For a type with variable-length instances, the instances must have an
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
:c:member:`~PyVarObject.ob_size` field, and the instance size is :c:member:`~PyTypeObject.tp_basicsize` plus N
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
times :c:member:`~PyTypeObject.tp_itemsize`, where N is the "length" of the object. The value of
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
N is typically stored in the instance's :c:member:`~PyVarObject.ob_size` field. There are
exceptions: for example, ints use a negative :c:member:`~PyVarObject.ob_size` to indicate a
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
negative number, and N is ``abs(ob_size)`` there. Also, the presence of an
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
:c:member:`~PyVarObject.ob_size` field in the instance layout doesn't mean that the instance
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
structure is variable-length (for example, the structure for the list type has
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
fixed-length instances, yet those instances have a meaningful :c:member:`~PyVarObject.ob_size`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
field).
The basic size includes the fields in the instance declared by the macro
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:macro:`PyObject_HEAD` or :c:macro:`PyObject_VAR_HEAD` (whichever is used to
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
declare the instance struct) and this in turn includes the :c:member:`~PyObject._ob_prev` and
:c:member:`~PyObject._ob_next` fields if they are present. This means that the only correct
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
way to get an initializer for the :c:member:`~PyTypeObject.tp_basicsize` is to use the
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
``sizeof`` operator on the struct used to declare the instance layout.
Remove many "versionchanged" items that didn't use the official markup, but just some text embedded in the docs. Also remove paragraph about implicit relative imports from tutorial.
2008-05-12 18:05:20 +00:00
The basic size does not include the GC header size.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
A note about alignment: if the variable items require a particular alignment,
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
this should be taken care of by the value of :c:member:`~PyTypeObject.tp_basicsize`. Example:
suppose a type implements an array of ``double``. :c:member:`~PyTypeObject.tp_itemsize` is
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
``sizeof(double)``. It is the programmer's responsibility that
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_basicsize` is a multiple of ``sizeof(double)`` (assuming this is the
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
alignment requirement for ``double``).
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
For any type with variable-length instances, this field must not be ``NULL``.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
These fields are inherited separately by subtypes. If the base type has a
non-zero :c:member:`~PyTypeObject.tp_itemsize`, it is generally not safe to set
:c:member:`~PyTypeObject.tp_itemsize` to a different non-zero value in a subtype (though this
depends on the implementation of the base type).
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: destructor PyTypeObject.tp_dealloc
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
A pointer to the instance destructor function. This function must be defined
unless the type guarantees that its instances will never be deallocated (as is
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
the case for the singletons ``None`` and ``Ellipsis``). The function signature is::
void tp_dealloc(PyObject *self);
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
The destructor function is called by the :c:func:`Py_DECREF` and
:c:func:`Py_XDECREF` macros when the new reference count is zero. At this point,
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
the instance is still in existence, but there are no references to it. The
destructor function should free all references which the instance owns, free all
memory buffers owned by the instance (using the freeing function corresponding
bpo-38206: Clarify tp_dealloc requirements for heap allocated types. (GH-16248) As mentioned in the bpo ticket, this mistake came up on two reviews: - https://github.com/python/cpython/pull/16127#pullrequestreview-288312751 - https://github.com/python/cpython/pull/16071#pullrequestreview-287819525 Would be nice to have it documented in a more permanent place than 3.8's whatsnew entry. https://bugs.python.org/issue38206 Automerge-Triggered-By: @encukou
2019-09-27 07:11:27 -04:00
to the allocation function used to allocate the buffer), and call the type's
:c:member:`~PyTypeObject.tp_free` function. If the type is not subtypable
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
(doesn't have the :c:macro:`Py_TPFLAGS_BASETYPE` flag bit set), it is
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
permissible to call the object deallocator directly instead of via
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_free`. The object deallocator should be the one used to allocate the
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
instance; this is normally :c:func:`PyObject_Del` if the instance was allocated
gh-107298: Fix more Sphinx warnings in the C API doc (#107329) Declare the following functions as macros, since they are actually macros. It avoids a warning on "TYPE" or "macro" argument. * PyMem_New() * PyMem_Resize() * PyModule_AddIntMacro() * PyModule_AddStringMacro() * PyObject_GC_New() * PyObject_GC_NewVar() * PyObject_New() * PyObject_NewVar() Add C standard C types to nitpick_ignore in Doc/conf.py: * int64_t * uint64_t * uintptr_t No longer ignore non existing "__int" type in nitpick_ignore. Update Doc/tools/.nitignore
2023-07-27 02:52:40 +02:00
using :c:macro:`PyObject_New` or :c:macro:`PyObject_NewVar`, or
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:func:`PyObject_GC_Del` if the instance was allocated using
gh-107298: Fix more Sphinx warnings in the C API doc (#107329) Declare the following functions as macros, since they are actually macros. It avoids a warning on "TYPE" or "macro" argument. * PyMem_New() * PyMem_Resize() * PyModule_AddIntMacro() * PyModule_AddStringMacro() * PyObject_GC_New() * PyObject_GC_NewVar() * PyObject_New() * PyObject_NewVar() Add C standard C types to nitpick_ignore in Doc/conf.py: * int64_t * uint64_t * uintptr_t No longer ignore non existing "__int" type in nitpick_ignore. Update Doc/tools/.nitignore
2023-07-27 02:52:40 +02:00
:c:macro:`PyObject_GC_New` or :c:macro:`PyObject_GC_NewVar`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
If the type supports garbage collection (has the :c:macro:`Py_TPFLAGS_HAVE_GC`
bpo-28737: Document when tp_dealloc should call PyObject_GC_UnTrack() (GH-29246) Objects that support garbage collection ("container" objects) should call PyObject_GC_UnTrack() from their destructors before clearing any fields which may point to other "container" objects.
2021-10-27 15:15:13 -04:00
flag bit set), the destructor should call :c:func:`PyObject_GC_UnTrack`
before clearing any member fields.
.. code-block:: c
static void foo_dealloc(foo_object *self) {
PyObject_GC_UnTrack(self);
Py_CLEAR(self->ref);
Py_TYPE(self)->tp_free((PyObject *)self);
}
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
Finally, if the type is heap allocated (:c:macro:`Py_TPFLAGS_HEAPTYPE`), the
gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has. This change updates the documentation to reflect that perspective. It also updates the docs relative to immortal objects in a handful of places.
2023-08-07 15:40:59 -06:00
deallocator should release the owned reference to its type object
(via :c:func:`Py_DECREF`) after
bpo-38206: Clarify tp_dealloc requirements for heap allocated types. (GH-16248) As mentioned in the bpo ticket, this mistake came up on two reviews: - https://github.com/python/cpython/pull/16127#pullrequestreview-288312751 - https://github.com/python/cpython/pull/16071#pullrequestreview-287819525 Would be nice to have it documented in a more permanent place than 3.8's whatsnew entry. https://bugs.python.org/issue38206 Automerge-Triggered-By: @encukou
2019-09-27 07:11:27 -04:00
calling the type deallocator. In order to avoid dangling pointers, the
recommended way to achieve this is:
.. code-block:: c
static void foo_dealloc(foo_object *self) {
PyTypeObject *tp = Py_TYPE(self);
// free references and buffers here
tp->tp_free(self);
Py_DECREF(tp);
}
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is inherited by subtypes.
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
.. c:member:: Py_ssize_t PyTypeObject.tp_vectorcall_offset
An optional offset to a per-instance function that implements calling
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
the object using the :ref:`vectorcall protocol <vectorcall>`,
a more efficient alternative
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
of the simpler :c:member:`~PyTypeObject.tp_call`.
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
This field is only used if the flag :c:macro:`Py_TPFLAGS_HAVE_VECTORCALL`
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
is set. If so, this must be a positive integer containing the offset in the
instance of a :c:type:`vectorcallfunc` pointer.
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
The *vectorcallfunc* pointer may be ``NULL``, in which case the instance behaves
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
as if :c:macro:`Py_TPFLAGS_HAVE_VECTORCALL` was not set: calling the instance
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
falls back to :c:member:`~PyTypeObject.tp_call`.
bpo-39245: Make Vectorcall C API public (GH-17893) * Add backcompat defines and move non-limited API declaration to cpython/ This partially reverts commit 2ff58a24e8a1c7e290d025d69ebaea0bbead3b8c which added PyObject_CallNoArgs to the 3.9+ stable ABI. This should not be done; there are enough other call APIs in the stable ABI to choose from. * Adjust documentation Mark all newly public functions as added in 3.9. Add a note about the 3.8 provisional names. Add notes on public API. * Put PyObject_CallNoArgs back in the limited API * Rename PyObject_FastCallDict to PyObject_VectorcallDict
2020-02-06 15:48:27 +01:00
Any class that sets ``Py_TPFLAGS_HAVE_VECTORCALL`` must also set
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
:c:member:`~PyTypeObject.tp_call` and make sure its behaviour is consistent
with the *vectorcallfunc* function.
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
This can be done by setting *tp_call* to :c:func:`PyVectorcall_Call`.
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
.. versionchanged:: 3.8
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
Before version 3.8, this slot was named ``tp_print``.
In Python 2.x, it was used for printing to a file.
In Python 3.0 to 3.7, it was unused.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-93274: Make vectorcall safe on mutable classes & inherit it by default (#95437)
2022-08-04 17:19:29 +02:00
.. versionchanged:: 3.12
Before version 3.12, it was not recommended for
:ref:`mutable heap types <heap-types>` to implement the vectorcall
protocol.
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
When a user sets :attr:`~object.__call__` in Python code, only *tp_call* is
gh-93274: Make vectorcall safe on mutable classes & inherit it by default (#95437)
2022-08-04 17:19:29 +02:00
updated, likely making it inconsistent with the vectorcall function.
Since 3.12, setting ``__call__`` will disable vectorcall optimization
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
by clearing the :c:macro:`Py_TPFLAGS_HAVE_VECTORCALL` flag.
gh-93274: Make vectorcall safe on mutable classes & inherit it by default (#95437)
2022-08-04 17:19:29 +02:00
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
**Inheritance:**
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
This field is always inherited.
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
However, the :c:macro:`Py_TPFLAGS_HAVE_VECTORCALL` flag is not
gh-93274: Make vectorcall safe on mutable classes & inherit it by default (#95437)
2022-08-04 17:19:29 +02:00
always inherited. If it's not set, then the subclass won't use
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
:ref:`vectorcall <vectorcall>`, except when
:c:func:`PyVectorcall_Call` is explicitly called.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: getattrfunc PyTypeObject.tp_getattr
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to the get-attribute-string function.
This field is deprecated. When it is defined, it should point to a function
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
that acts the same as the :c:member:`~PyTypeObject.tp_getattro` function, but taking a C string
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
instead of a Python string object to give the attribute name.
**Inheritance:**
Issue #28771: Update tp_get/setattr signature documentation
2016-12-10 05:56:13 +00:00
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Group: :c:member:`~PyTypeObject.tp_getattr`, :c:member:`~PyTypeObject.tp_getattro`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_getattro`: a subtype
inherits both :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject.tp_getattro` from its base type when
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
the subtype's :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject.tp_getattro` are both ``NULL``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: setattrfunc PyTypeObject.tp_setattr
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #25701: Document C API functions that both set and delete objects Also document that the separate functions that delete objects are preferred; using PyObject_SetAttr(), _SetAttrString(), and PySequence_SetItem() to delete is deprecated.
2015-12-08 00:03:20 +00:00
An optional pointer to the function for setting and deleting attributes.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is deprecated. When it is defined, it should point to a function
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
that acts the same as the :c:member:`~PyTypeObject.tp_setattro` function, but taking a C string
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
instead of a Python string object to give the attribute name.
Issue #28771: Update tp_get/setattr signature documentation
2016-12-10 05:56:13 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Group: :c:member:`~PyTypeObject.tp_setattr`, :c:member:`~PyTypeObject.tp_setattro`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_setattro`: a subtype
inherits both :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject.tp_setattro` from its base type when
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
the subtype's :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject.tp_setattro` are both ``NULL``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:member:: PyAsyncMethods* PyTypeObject.tp_as_async
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
Pointer to an additional structure that contains fields relevant only to
objects which implement :term:`awaitable` and :term:`asynchronous iterator`
protocols at the C-level. See :ref:`async-structs` for details.
.. versionadded:: 3.5
Issue 24180: Fixes by Berker Peksag.
2015-05-21 17:02:31 -04:00
Formerly known as ``tp_compare`` and ``tp_reserved``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
The :c:member:`~PyTypeObject.tp_as_async` field is not inherited,
but the contained fields are inherited individually.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: reprfunc PyTypeObject.tp_repr
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
GH-97950: Use new-style index directive ('builtin') (#104164) * Uncomment builtin removal in pairindextypes * Use new-style index directive ('builtin') - C API * Use new-style index directive ('builtin') - Extending * Use new-style index directive ('builtin') - Library * Use new-style index directive ('builtin') - Reference * Use new-style index directive ('builtin') - Tutorial
2023-05-06 04:54:08 +01:00
.. index:: pair: built-in function; repr
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a function that implements the built-in function
:func:`repr`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The signature is the same as for :c:func:`PyObject_Repr`::
PyObject *tp_repr(PyObject *self);
The function must return a string or a Unicode object. Ideally,
this function should return a string that, when passed to
:func:`eval`, given a suitable environment, returns an object with the
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
same value. If this is not feasible, it should return a string starting with
``'<'`` and ending with ``'>'`` from which both the type and the value of the
object can be deduced.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
This field is inherited by subtypes.
**Default:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
When this field is not set, a string of the form ``<%s object at %p>`` is
returned, where ``%s`` is replaced by the type name, and ``%p`` by the object's
memory address.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:member:: PyNumberMethods* PyTypeObject.tp_as_number
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Pointer to an additional structure that contains fields relevant only to
objects which implement the number protocol. These fields are documented in
:ref:`number-structs`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
The :c:member:`~PyTypeObject.tp_as_number` field is not inherited, but the contained fields are
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
inherited individually.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:member:: PySequenceMethods* PyTypeObject.tp_as_sequence
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Pointer to an additional structure that contains fields relevant only to
objects which implement the sequence protocol. These fields are documented
in :ref:`sequence-structs`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
The :c:member:`~PyTypeObject.tp_as_sequence` field is not inherited, but the contained fields
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
are inherited individually.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:member:: PyMappingMethods* PyTypeObject.tp_as_mapping
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Pointer to an additional structure that contains fields relevant only to
objects which implement the mapping protocol. These fields are documented in
:ref:`mapping-structs`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
The :c:member:`~PyTypeObject.tp_as_mapping` field is not inherited, but the contained fields
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
are inherited individually.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: hashfunc PyTypeObject.tp_hash
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
GH-97950: Use new-style index directive ('builtin') (#104164) * Uncomment builtin removal in pairindextypes * Use new-style index directive ('builtin') - C API * Use new-style index directive ('builtin') - Extending * Use new-style index directive ('builtin') - Library * Use new-style index directive ('builtin') - Reference * Use new-style index directive ('builtin') - Tutorial
2023-05-06 04:54:08 +01:00
.. index:: pair: built-in function; hash
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a function that implements the built-in function
:func:`hash`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The signature is the same as for :c:func:`PyObject_Hash`::
Py_hash_t tp_hash(PyObject *);
The value ``-1`` should not be returned as a
make hashes always the size of pointers; introduce Py_hash_t #9778
2010-10-17 20:54:53 +00:00
normal return value; when an error occurs during the computation of the hash
value, the function should set an exception and return ``-1``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
When this field is not set (*and* :c:member:`~PyTypeObject.tp_richcompare` is not set),
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
an attempt to take the hash of the object raises :exc:`TypeError`.
This is the same as setting it to :c:func:`PyObject_HashNotImplemented`.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This field can be set explicitly to :c:func:`PyObject_HashNotImplemented` to
Merged revisions 65810 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r65810 | nick.coghlan | 2008-08-18 23:14:22 +1000 (Mon, 18 Aug 2008) | 1 line Issue 2235: document PyObject_HashNotImplemented ........
2008-08-18 13:18:16 +00:00
block inheritance of the hash method from a parent type. This is interpreted
as the equivalent of ``__hash__ = None`` at the Python level, causing
``isinstance(o, collections.Hashable)`` to correctly return ``False``. Note
that the converse is also true - setting ``__hash__ = None`` on a class at
the Python level will result in the ``tp_hash`` slot being set to
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:func:`PyObject_HashNotImplemented`.
Merged revisions 65810 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r65810 | nick.coghlan | 2008-08-18 23:14:22 +1000 (Mon, 18 Aug 2008) | 1 line Issue 2235: document PyObject_HashNotImplemented ........
2008-08-18 13:18:16 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Group: :c:member:`~PyTypeObject.tp_hash`, :c:member:`~PyTypeObject.tp_richcompare`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #1717, continued: Doc fixes and other cleanup related to renaming of tp_compare.
2009-02-02 21:29:40 +00:00
This field is inherited by subtypes together with
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_richcompare`: a subtype inherits both of
:c:member:`~PyTypeObject.tp_richcompare` and :c:member:`~PyTypeObject.tp_hash`, when the subtype's
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
:c:member:`~PyTypeObject.tp_richcompare` and :c:member:`~PyTypeObject.tp_hash` are both ``NULL``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: ternaryfunc PyTypeObject.tp_call
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a function that implements calling the object. This
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
should be ``NULL`` if the object is not callable. The signature is the same as
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
for :c:func:`PyObject_Call`::
PyObject *tp_call(PyObject *self, PyObject *args, PyObject *kwargs);
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is inherited by subtypes.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: reprfunc PyTypeObject.tp_str
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a function that implements the built-in operation
:func:`str`. (Note that :class:`str` is a type now, and :func:`str` calls the
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
constructor for that type. This constructor calls :c:func:`PyObject_Str` to do
the actual work, and :c:func:`PyObject_Str` will call this handler.)
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The signature is the same as for :c:func:`PyObject_Str`::
PyObject *tp_str(PyObject *self);
The function must return a string or a Unicode object. It should be a "friendly" string
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
representation of the object, as this is the representation that will be used,
among other things, by the :func:`print` function.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is inherited by subtypes.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Default:**
When this field is not set, :c:func:`PyObject_Repr` is called to return a string
representation.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: getattrofunc PyTypeObject.tp_getattro
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to the get-attribute function.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The signature is the same as for :c:func:`PyObject_GetAttr`::
PyObject *tp_getattro(PyObject *self, PyObject *attr);
It is usually convenient to set this field to :c:func:`PyObject_GenericGetAttr`,
which implements the normal way of looking for object attributes.
**Inheritance:**
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Group: :c:member:`~PyTypeObject.tp_getattr`, :c:member:`~PyTypeObject.tp_getattro`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_getattr`: a subtype
inherits both :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject.tp_getattro` from its base type when
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
the subtype's :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject.tp_getattro` are both ``NULL``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Default:**
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
:c:data:`PyBaseObject_Type` uses :c:func:`PyObject_GenericGetAttr`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: setattrofunc PyTypeObject.tp_setattro
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #25701: Document C API functions that both set and delete objects Also document that the separate functions that delete objects are preferred; using PyObject_SetAttr(), _SetAttrString(), and PySequence_SetItem() to delete is deprecated.
2015-12-08 00:03:20 +00:00
An optional pointer to the function for setting and deleting attributes.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The signature is the same as for :c:func:`PyObject_SetAttr`::
Fix quoted signature of setattrofunc (GH-17251) setattrofunc returns `int`, not `PyObject *`.
2019-11-22 07:48:14 -06:00
int tp_setattro(PyObject *self, PyObject *attr, PyObject *value);
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
In addition, setting *value* to ``NULL`` to delete an attribute must be
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
supported. It is usually convenient to set this field to
:c:func:`PyObject_GenericSetAttr`, which implements the normal
way of setting object attributes.
**Inheritance:**
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Group: :c:member:`~PyTypeObject.tp_setattr`, :c:member:`~PyTypeObject.tp_setattro`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_setattr`: a subtype
inherits both :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject.tp_setattro` from its base type when
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
the subtype's :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject.tp_setattro` are both ``NULL``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Default:**
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
:c:data:`PyBaseObject_Type` uses :c:func:`PyObject_GenericSetAttr`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: PyBufferProcs* PyTypeObject.tp_as_buffer
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Pointer to an additional structure that contains fields relevant only to objects
which implement the buffer interface. These fields are documented in
:ref:`buffer-structs`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
The :c:member:`~PyTypeObject.tp_as_buffer` field is not inherited,
but the contained fields are inherited individually.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #24808: Update the documentation of some PyTypeObject fields Patch by Joseph Weston.
2015-08-25 05:06:39 +00:00
.. c:member:: unsigned long PyTypeObject.tp_flags
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is a bit mask of various flags. Some flags indicate variant
semantics for certain situations; others are used to indicate that certain
fields in the type object (or in the extension structures referenced via
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_as_number`, :c:member:`~PyTypeObject.tp_as_sequence`, :c:member:`~PyTypeObject.tp_as_mapping`, and
:c:member:`~PyTypeObject.tp_as_buffer`) that were historically not always present are valid; if
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
such a flag bit is clear, the type fields it guards must not be accessed and
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
must be considered to have a zero or ``NULL`` value instead.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Inheritance of this field is complicated. Most flag bits are inherited
individually, i.e. if the base type has a flag bit set, the subtype inherits
this flag bit. The flag bits that pertain to extension structures are strictly
inherited if the extension structure is inherited, i.e. the base type's value of
the flag bit is copied into the subtype together with a pointer to the extension
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
structure. The :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is inherited together with
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
the :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` fields, i.e. if the
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is clear in the subtype and the
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` fields in the subtype exist and have
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
``NULL`` values.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. XXX are most flag bits *really* inherited individually?
**Default:**
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
:c:data:`PyBaseObject_Type` uses
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
``Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE``.
**Bit Masks:**
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:namespace:: NULL
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
The following bit masks are currently defined; these can be ORed together using
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
the ``|`` operator to form the value of the :c:member:`~PyTypeObject.tp_flags` field. The macro
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:func:`PyType_HasFeature` takes a type and a flags value, *tp* and *f*, and
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
checks whether ``tp->tp_flags & f`` is non-zero.
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_HEAPTYPE
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-38206: Clarify tp_dealloc requirements for heap allocated types. (GH-16248) As mentioned in the bpo ticket, this mistake came up on two reviews: - https://github.com/python/cpython/pull/16127#pullrequestreview-288312751 - https://github.com/python/cpython/pull/16071#pullrequestreview-287819525 Would be nice to have it documented in a more permanent place than 3.8's whatsnew entry. https://bugs.python.org/issue38206 Automerge-Triggered-By: @encukou
2019-09-27 07:11:27 -04:00
This bit is set when the type object itself is allocated on the heap, for
example, types created dynamically using :c:func:`PyType_FromSpec`. In this
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
case, the :c:member:`~PyObject.ob_type` field of its instances is considered a reference to
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
the type, and the type object is INCREF'ed when a new instance is created, and
DECREF'ed when an instance is destroyed (this does not apply to instances of
subtypes; only the type referenced by the instance's ob_type gets INCREF'ed or
DECREF'ed).
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
???
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_BASETYPE
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This bit is set when the type can be used as the base type of another type. If
this bit is clear, the type cannot be subtyped (similar to a "final" class in
Java).
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
???
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_READY
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This bit is set when the type object has been fully initialized by
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:func:`PyType_Ready`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
???
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_READYING
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This bit is set while :c:func:`PyType_Ready` is in the process of initializing
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
the type object.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
???
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_HAVE_GC
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This bit is set when the object supports garbage collection. If this bit
gh-107298: Fix more Sphinx warnings in the C API doc (#107329) Declare the following functions as macros, since they are actually macros. It avoids a warning on "TYPE" or "macro" argument. * PyMem_New() * PyMem_Resize() * PyModule_AddIntMacro() * PyModule_AddStringMacro() * PyObject_GC_New() * PyObject_GC_NewVar() * PyObject_New() * PyObject_NewVar() Add C standard C types to nitpick_ignore in Doc/conf.py: * int64_t * uint64_t * uintptr_t No longer ignore non existing "__int" type in nitpick_ignore. Update Doc/tools/.nitignore
2023-07-27 02:52:40 +02:00
is set, instances must be created using :c:macro:`PyObject_GC_New` and
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
destroyed using :c:func:`PyObject_GC_Del`. More information in section
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
:ref:`supporting-cycle-detection`. This bit also implies that the
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
GC-related fields :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` are present in
Remove many "versionchanged" items that didn't use the official markup, but just some text embedded in the docs. Also remove paragraph about implicit relative imports from tutorial.
2008-05-12 18:05:20 +00:00
the type object.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Group: :c:macro:`Py_TPFLAGS_HAVE_GC`, :c:member:`~PyTypeObject.tp_traverse`, :c:member:`~PyTypeObject.tp_clear`
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
The :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is inherited
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
together with the :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear`
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
fields, i.e. if the :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
clear in the subtype and the :c:member:`~PyTypeObject.tp_traverse` and
:c:member:`~PyTypeObject.tp_clear` fields in the subtype exist and have ``NULL``
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
values.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_DEFAULT
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This is a bitmask of all the bits that pertain to the existence of certain
fields in the type object and its extension structures. Currently, it includes
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
the following bits: :c:macro:`Py_TPFLAGS_HAVE_STACKLESS_EXTENSION`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
???
bpo-36922: implement PEP-590 Py_TPFLAGS_METHOD_DESCRIPTOR (GH-13338) Co-authored-by: Mark Shannon <mark@hotpy.org>
2019-05-28 14:42:53 +02:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_METHOD_DESCRIPTOR
bpo-36922: implement PEP-590 Py_TPFLAGS_METHOD_DESCRIPTOR (GH-13338) Co-authored-by: Mark Shannon <mark@hotpy.org>
2019-05-28 14:42:53 +02:00
This bit indicates that objects behave like unbound methods.
If this flag is set for ``type(meth)``, then:
- ``meth.__get__(obj, cls)(*args, **kwds)`` (with ``obj`` not None)
must be equivalent to ``meth(obj, *args, **kwds)``.
- ``meth.__get__(None, cls)(*args, **kwds)``
must be equivalent to ``meth(*args, **kwds)``.
This flag enables an optimization for typical method calls like
``obj.meth()``: it avoids creating a temporary "bound method" object for
``obj.meth``.
.. versionadded:: 3.8
**Inheritance:**
bpo-43908: Immutable types inherit vectorcall (GH-27001) Heap types with the Py_TPFLAGS_IMMUTABLETYPE flag can now inherit the PEP 590 vectorcall protocol. Previously, this was only possible for static types. Co-authored-by: Victor Stinner <vstinner@python.org>
2021-07-08 12:48:01 +02:00
This flag is never inherited by types without the
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_IMMUTABLETYPE` flag set. For extension types, it is
bpo-43908: Immutable types inherit vectorcall (GH-27001) Heap types with the Py_TPFLAGS_IMMUTABLETYPE flag can now inherit the PEP 590 vectorcall protocol. Previously, this was only possible for static types. Co-authored-by: Victor Stinner <vstinner@python.org>
2021-07-08 12:48:01 +02:00
inherited whenever :c:member:`~PyTypeObject.tp_descr_get` is inherited.
bpo-36922: implement PEP-590 Py_TPFLAGS_METHOD_DESCRIPTOR (GH-13338) Co-authored-by: Mark Shannon <mark@hotpy.org>
2019-05-28 14:42:53 +02:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_MANAGED_DICT
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
tp_flags docs: fix indentation (#106420)
2023-07-04 22:08:25 -07:00
This bit indicates that instances of the class have a ``__dict__``
attribute, and that the space for the dictionary is managed by the VM.
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
If this flag is set, :c:macro:`Py_TPFLAGS_HAVE_GC` should also be set.
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
gh-107073: Make PyObject_VisitManagedDict() public (#108763) Make PyObject_VisitManagedDict() and PyObject_ClearManagedDict() functions public in Python 3.13 C API. * Rename _PyObject_VisitManagedDict() to PyObject_VisitManagedDict(). * Rename _PyObject_ClearManagedDict() to PyObject_ClearManagedDict(). * Document these functions.
2023-10-02 19:24:08 +02:00
The type traverse function must call :c:func:`PyObject_VisitManagedDict`
and its clear function must call :c:func:`PyObject_ClearManagedDict`.
tp_flags docs: fix indentation (#106420)
2023-07-04 22:08:25 -07:00
.. versionadded:: 3.12
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
**Inheritance:**
This flag is inherited unless the
:c:member:`~PyTypeObject.tp_dictoffset` field is set in a superclass.
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_MANAGED_WEAKREF
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
tp_flags docs: fix indentation (#106420)
2023-07-04 22:08:25 -07:00
This bit indicates that instances of the class should be weakly
referenceable.
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
tp_flags docs: fix indentation (#106420)
2023-07-04 22:08:25 -07:00
.. versionadded:: 3.12
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
**Inheritance:**
This flag is inherited unless the
:c:member:`~PyTypeObject.tp_weaklistoffset` field is set in a superclass.
bpo-36922: implement PEP-590 Py_TPFLAGS_METHOD_DESCRIPTOR (GH-13338) Co-authored-by: Mark Shannon <mark@hotpy.org>
2019-05-28 14:42:53 +02:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_ITEMS_AT_END
gh-103509: PEP 697 -- Limited C API for Extending Opaque Types (GH-103511) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-05-04 09:56:53 +02:00
Only usable with variable-size types, i.e. ones with non-zero
gh-107091: Fix some uses of :c:member: role (GH-107129)
2023-07-26 22:16:06 +03:00
:c:member:`~PyTypeObject.tp_itemsize`.
gh-103509: PEP 697 -- Limited C API for Extending Opaque Types (GH-103511) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-05-04 09:56:53 +02:00
Indicates that the variable-sized portion of an instance of this type is
at the end of the instance's memory area, at an offset of
gh-107298: Fix more Sphinx warnings in the C API doc (#107329) Declare the following functions as macros, since they are actually macros. It avoids a warning on "TYPE" or "macro" argument. * PyMem_New() * PyMem_Resize() * PyModule_AddIntMacro() * PyModule_AddStringMacro() * PyObject_GC_New() * PyObject_GC_NewVar() * PyObject_New() * PyObject_NewVar() Add C standard C types to nitpick_ignore in Doc/conf.py: * int64_t * uint64_t * uintptr_t No longer ignore non existing "__int" type in nitpick_ignore. Update Doc/tools/.nitignore
2023-07-27 02:52:40 +02:00
``Py_TYPE(obj)->tp_basicsize`` (which may be different in each
gh-103509: PEP 697 -- Limited C API for Extending Opaque Types (GH-103511) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-05-04 09:56:53 +02:00
subclass).
When setting this flag, be sure that all superclasses either
use this memory layout, or are not variable-sized.
Python does not check this.
.. versionadded:: 3.12
**Inheritance:**
This flag is inherited.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. XXX Document more flags here?
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_LONG_SUBCLASS
.. c:macro:: Py_TPFLAGS_LIST_SUBCLASS
.. c:macro:: Py_TPFLAGS_TUPLE_SUBCLASS
.. c:macro:: Py_TPFLAGS_BYTES_SUBCLASS
.. c:macro:: Py_TPFLAGS_UNICODE_SUBCLASS
.. c:macro:: Py_TPFLAGS_DICT_SUBCLASS
.. c:macro:: Py_TPFLAGS_BASE_EXC_SUBCLASS
.. c:macro:: Py_TPFLAGS_TYPE_SUBCLASS
Issue #9307: document the various Py_TPFLAGS_*_SUBCLASS flags. Patch by Yury V. Zaytsev.
2014-04-29 01:39:03 +02:00
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.
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_HAVE_FINALIZE
Issue #18112: PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:14:43 +02:00
This bit is set when the :c:member:`~PyTypeObject.tp_finalize` slot is present in the
Issue #18112: PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
type structure.
.. versionadded:: 3.4
bpo-32388: Remove cross-version binary compatibility requirement in tp_flags (GH-4944) It is now allowed to add new fields at the end of the PyTypeObject struct without having to allocate a dedicated compatibility flag in tp_flags. This will reduce the risk of running out of bits in the 32-bit tp_flags value.
2019-05-29 22:12:38 +02:00
.. deprecated:: 3.8
This flag isn't necessary anymore, as the interpreter assumes the
:c:member:`~PyTypeObject.tp_finalize` slot is always present in the
type structure.
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_HAVE_VECTORCALL
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
This bit is set when the class implements
the :ref:`vectorcall protocol <vectorcall>`.
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
See :c:member:`~PyTypeObject.tp_vectorcall_offset` for details.
**Inheritance:**
gh-93274: Make vectorcall safe on mutable classes & inherit it by default (#95437)
2022-08-04 17:19:29 +02:00
This bit is inherited if :c:member:`~PyTypeObject.tp_call` is also
inherited.
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
bpo-39245: Make Vectorcall C API public (GH-17893) * Add backcompat defines and move non-limited API declaration to cpython/ This partially reverts commit 2ff58a24e8a1c7e290d025d69ebaea0bbead3b8c which added PyObject_CallNoArgs to the 3.9+ stable ABI. This should not be done; there are enough other call APIs in the stable ABI to choose from. * Adjust documentation Mark all newly public functions as added in 3.9. Add a note about the 3.8 provisional names. Add notes on public API. * Put PyObject_CallNoArgs back in the limited API * Rename PyObject_FastCallDict to PyObject_VectorcallDict
2020-02-06 15:48:27 +01:00
.. versionadded:: 3.9
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
gh-93274: Make vectorcall safe on mutable classes & inherit it by default (#95437)
2022-08-04 17:19:29 +02:00
.. versionchanged:: 3.12
This flag is now removed from a class when the class's
:py:meth:`~object.__call__` method is reassigned.
This flag can now be inherited by mutable classes.
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_IMMUTABLETYPE
bpo-43908: Add Py_TPFLAGS_IMMUTABLETYPE flag (GH-25520) Introduce Py_TPFLAGS_IMMUTABLETYPE flag for immutable type objects, and modify PyType_Ready() to set it for static types. Co-authored-by: Victor Stinner <vstinner@python.org>
2021-04-28 19:02:42 +02:00
This bit is set for type objects that are immutable: type attributes cannot be set nor deleted.
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
:c:func:`PyType_Ready` automatically applies this flag to
:ref:`static types <static-types>`.
bpo-43908: Add Py_TPFLAGS_IMMUTABLETYPE flag (GH-25520) Introduce Py_TPFLAGS_IMMUTABLETYPE flag for immutable type objects, and modify PyType_Ready() to set it for static types. Co-authored-by: Victor Stinner <vstinner@python.org>
2021-04-28 19:02:42 +02:00
**Inheritance:**
This flag is not inherited.
.. versionadded:: 3.10
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_DISALLOW_INSTANTIATION
bpo-43916: Add Py_TPFLAGS_DISALLOW_INSTANTIATION type flag (GH-25721) Add a new Py_TPFLAGS_DISALLOW_INSTANTIATION type flag to disallow creating type instances: set tp_new to NULL and don't create the "__new__" key in the type dictionary. The flag is set automatically on static types if tp_base is NULL or &PyBaseObject_Type and tp_new is NULL. Use the flag on the following types: * _curses.ncurses_version type * _curses_panel.panel * _tkinter.Tcl_Obj * _tkinter.tkapp * _tkinter.tktimertoken * _xxsubinterpretersmodule.ChannelID * sys.flags type * sys.getwindowsversion() type * sys.version_info type Update MyStr example in the C API documentation to use Py_TPFLAGS_DISALLOW_INSTANTIATION. Add _PyStructSequence_InitType() function to create a structseq type with the Py_TPFLAGS_DISALLOW_INSTANTIATION flag set. type_new() calls _PyType_CheckConsistency() at exit.
2021-04-30 12:46:15 +02:00
Disallow creating instances of the type: set
:c:member:`~PyTypeObject.tp_new` to NULL and don't create the ``__new__``
key in the type dictionary.
The flag must be set before creating the type, not after. For example, it
must be set before :c:func:`PyType_Ready` is called on the type.
The flag is set automatically on :ref:`static types <static-types>` if
:c:member:`~PyTypeObject.tp_base` is NULL or ``&PyBaseObject_Type`` and
:c:member:`~PyTypeObject.tp_new` is NULL.
**Inheritance:**
This flag is not inherited.
gh-96746: Docs: Clear up Py_TPFLAGS_DISALLOW_INSTANTIATION inheritance (GH-99002) The flag is not inherited, but its effect -- a NULL tp_new -- is. Drop hints for people who come here wanting to “disallow instantiation”.
2022-11-07 19:45:50 +01:00
However, subclasses will not be instantiable unless they provide a
non-NULL :c:member:`~PyTypeObject.tp_new` (which is only possible
via the C API).
.. note::
To disallow instantiating a class directly but allow instantiating
its subclasses (e.g. for an :term:`abstract base class`),
do not use this flag.
Instead, make :c:member:`~PyTypeObject.tp_new` only succeed for
subclasses.
bpo-43916: Add Py_TPFLAGS_DISALLOW_INSTANTIATION type flag (GH-25721) Add a new Py_TPFLAGS_DISALLOW_INSTANTIATION type flag to disallow creating type instances: set tp_new to NULL and don't create the "__new__" key in the type dictionary. The flag is set automatically on static types if tp_base is NULL or &PyBaseObject_Type and tp_new is NULL. Use the flag on the following types: * _curses.ncurses_version type * _curses_panel.panel * _tkinter.Tcl_Obj * _tkinter.tkapp * _tkinter.tktimertoken * _xxsubinterpretersmodule.ChannelID * sys.flags type * sys.getwindowsversion() type * sys.version_info type Update MyStr example in the C API documentation to use Py_TPFLAGS_DISALLOW_INSTANTIATION. Add _PyStructSequence_InitType() function to create a structseq type with the Py_TPFLAGS_DISALLOW_INSTANTIATION flag set. type_new() calls _PyType_CheckConsistency() at exit.
2021-04-30 12:46:15 +02:00
.. versionadded:: 3.10
bpo-42085: Add documentation for Py_TPFLAGS_HAVE_AM_SEND (GH-23374) Updated docs to include `Py_TPFLAGS_HAVE_AM_SEND`. News section should not be necessary. Automerge-Triggered-By: GH:asvetlov
2020-11-18 10:58:38 -08:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_MAPPING
bpo-43977: Document the new pattern matching type flags (GH-25734)
2021-05-02 15:35:00 -07:00
This bit indicates that instances of the class may match mapping patterns
when used as the subject of a :keyword:`match` block. It is automatically
set when registering or subclassing :class:`collections.abc.Mapping`, and
unset when registering :class:`collections.abc.Sequence`.
.. note::
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_MAPPING` and :c:macro:`Py_TPFLAGS_SEQUENCE` are
Add missing "to" to two tp_flags notes (GH-31624)
2022-02-28 17:20:14 -08:00
mutually exclusive; it is an error to enable both flags simultaneously.
bpo-43977: Document the new pattern matching type flags (GH-25734)
2021-05-02 15:35:00 -07:00
**Inheritance:**
This flag is inherited by types that do not already set
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_SEQUENCE`.
bpo-43977: Document the new pattern matching type flags (GH-25734)
2021-05-02 15:35:00 -07:00
.. seealso:: :pep:`634` -- Structural Pattern Matching: Specification
.. versionadded:: 3.10
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_SEQUENCE
bpo-43977: Document the new pattern matching type flags (GH-25734)
2021-05-02 15:35:00 -07:00
This bit indicates that instances of the class may match sequence patterns
when used as the subject of a :keyword:`match` block. It is automatically
set when registering or subclassing :class:`collections.abc.Sequence`, and
unset when registering :class:`collections.abc.Mapping`.
.. note::
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_MAPPING` and :c:macro:`Py_TPFLAGS_SEQUENCE` are
Add missing "to" to two tp_flags notes (GH-31624)
2022-02-28 17:20:14 -08:00
mutually exclusive; it is an error to enable both flags simultaneously.
bpo-43977: Document the new pattern matching type flags (GH-25734)
2021-05-02 15:35:00 -07:00
**Inheritance:**
This flag is inherited by types that do not already set
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_MAPPING`.
bpo-43977: Document the new pattern matching type flags (GH-25734)
2021-05-02 15:35:00 -07:00
.. seealso:: :pep:`634` -- Structural Pattern Matching: Specification
.. versionadded:: 3.10
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
.. c:macro:: Py_TPFLAGS_VALID_VERSION_TAG
GH-99293: Document that `Py_TPFLAGS_VALID_VERSION_TAG` shouldn't be used. (#GH-101736) Document that Py_TPFLAGS_VALID_VERSION_TAG shouldn't be used.
2023-02-09 13:05:53 +00:00
Internal. Do not set or unset this flag.
To indicate that a class has changed call :c:func:`PyType_Modified`
.. warning::
This flag is present in header files, but is an internal feature and should
not be used. It will be removed in a future version of CPython
Issue #24808: Update the documentation of some PyTypeObject fields Patch by Joseph Weston.
2015-08-25 05:06:39 +00:00
.. c:member:: const char* PyTypeObject.tp_doc
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a NUL-terminated C string giving the docstring for this
type object. This is exposed as the :attr:`__doc__` attribute on the type and
instances of the type.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is *not* inherited by subtypes.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: traverseproc PyTypeObject.tp_traverse
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a traversal function for the garbage collector. This is
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
only used if the :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is set. The signature is::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
int tp_traverse(PyObject *self, visitproc visit, void *arg);
More information about Python's garbage collection scheme can be found
in section :ref:`supporting-cycle-detection`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
The :c:member:`~PyTypeObject.tp_traverse` pointer is used by the garbage collector to detect
reference cycles. A typical implementation of a :c:member:`~PyTypeObject.tp_traverse` function
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
simply calls :c:func:`Py_VISIT` on each of the instance's members that are Python
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
objects that the instance owns. For example, this is function :c:func:`!local_traverse` from the
:mod:`!_thread` extension module::
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
static int
local_traverse(localobject *self, visitproc visit, void *arg)
{
Py_VISIT(self->args);
Py_VISIT(self->kw);
Py_VISIT(self->dict);
return 0;
}
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
Note that :c:func:`Py_VISIT` is called only on those members that can participate
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
in reference cycles. Although there is also a ``self->key`` member, it can only
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
be ``NULL`` or a Python string and therefore cannot be part of a reference cycle.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
On the other hand, even if you know a member can never be part of a cycle, as a
debugging aid you may want to visit it anyway just so the :mod:`gc` module's
Issue 19195: Improved cross-references in C API documentation.
2013-10-09 13:26:17 +03:00
:func:`~gc.get_referents` function will include it.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-107073: Make PyObject_VisitManagedDict() public (#108763) Make PyObject_VisitManagedDict() and PyObject_ClearManagedDict() functions public in Python 3.13 C API. * Rename _PyObject_VisitManagedDict() to PyObject_VisitManagedDict(). * Rename _PyObject_ClearManagedDict() to PyObject_ClearManagedDict(). * Document these functions.
2023-10-02 19:24:08 +02:00
Heap types (:c:macro:`Py_TPFLAGS_HEAPTYPE`) must visit their type with::
Py_VISIT(Py_TYPE(self));
It is only needed since Python 3.9. To support Python 3.8 and older, this
line must be conditionnal::
#if PY_VERSION_HEX >= 0x03090000
Py_VISIT(Py_TYPE(self));
#endif
If the :c:macro:`Py_TPFLAGS_MANAGED_DICT` bit is set in the
:c:member:`~PyTypeObject.tp_flags` field, the traverse function must call
:c:func:`PyObject_VisitManagedDict` like this::
PyObject_VisitManagedDict((PyObject*)self, visit, arg);
bpo-39778: Add clarification about tp_traverse and ownership (GH-18754) Automerge-Triggered-By: @pablogsal
2020-03-03 02:50:40 +00:00
.. warning::
bpo-42294: Add borrowed/strong reference to doc glossary (GH-23206) Add "borrowed reference" and "strong reference" to the documentation glossary. Enhance also Py_INCREF() and Py_NewRef() documentation.
2020-11-09 13:40:47 +01:00
When implementing :c:member:`~PyTypeObject.tp_traverse`, only the
members that the instance *owns* (by having :term:`strong references
<strong reference>` to them) must be
bpo-39778: Add clarification about tp_traverse and ownership (GH-18754) Automerge-Triggered-By: @pablogsal
2020-03-03 02:50:40 +00:00
visited. For instance, if an object supports weak references via the
:c:member:`~PyTypeObject.tp_weaklist` slot, the pointer supporting
the linked list (what *tp_weaklist* points to) must **not** be
visited as the instance does not directly own the weak references to itself
(the weakreference list is there to support the weak reference machinery,
but the instance has no strong reference to the elements inside it, as they
are allowed to be removed even if the instance is still alive).
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
Note that :c:func:`Py_VISIT` requires the *visit* and *arg* parameters to
gh-107298: Fix a few more refs in the C API docs (GH-108361) gh-107298: Fix few more refs in the C API docs
2023-08-23 20:12:42 +03:00
:c:func:`!local_traverse` to have these specific names; don't name them just
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
anything.
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
Instances of :ref:`heap-allocated types <heap-types>` hold a reference to
their type. Their traversal function must therefore either visit
bpo-40217: Ensure Py_VISIT(Py_TYPE(self)) is always called for PyType_FromSpec types (reverts GH-19414) (GH-20264) Heap types now always visit the type in tp_traverse. See added docs for details. This reverts commit 0169d3003be3d072751dd14a5c84748ab63a249f. Automerge-Triggered-By: @encukou
2020-05-27 10:03:38 +01:00
:c:func:`Py_TYPE(self) <Py_TYPE>`, or delegate this responsibility by
calling ``tp_traverse`` of another heap-allocated type (such as a
heap-allocated superclass).
If they do not, the type object may not be garbage-collected.
.. versionchanged:: 3.9
Heap-allocated types are expected to visit ``Py_TYPE(self)`` in
``tp_traverse``. In earlier versions of Python, due to
`bug 40217 <https://bugs.python.org/issue40217>`_, doing this
may lead to crashes in subclasses.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Group: :c:macro:`Py_TPFLAGS_HAVE_GC`, :c:member:`~PyTypeObject.tp_traverse`, :c:member:`~PyTypeObject.tp_clear`
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_clear` and the
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_HAVE_GC` flag bit: the flag bit, :c:member:`~PyTypeObject.tp_traverse`, and
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_clear` are all inherited from the base type if they are all zero in
Remove many "versionchanged" items that didn't use the official markup, but just some text embedded in the docs. Also remove paragraph about implicit relative imports from tutorial.
2008-05-12 18:05:20 +00:00
the subtype.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: inquiry PyTypeObject.tp_clear
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a clear function for the garbage collector. This is only
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
used if the :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is set. The signature is::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
int tp_clear(PyObject *);
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
The :c:member:`~PyTypeObject.tp_clear` member function is used to break reference cycles in cyclic
garbage detected by the garbage collector. Taken together, all :c:member:`~PyTypeObject.tp_clear`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
functions in the system must combine to break all reference cycles. This is
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
subtle, and if in any doubt supply a :c:member:`~PyTypeObject.tp_clear` function. For example,
the tuple type does not implement a :c:member:`~PyTypeObject.tp_clear` function, because it's
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
possible to prove that no reference cycle can be composed entirely of tuples.
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
Therefore the :c:member:`~PyTypeObject.tp_clear` functions of other types must be sufficient to
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
break any cycle containing a tuple. This isn't immediately obvious, and there's
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
rarely a good reason to avoid implementing :c:member:`~PyTypeObject.tp_clear`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
Implementations of :c:member:`~PyTypeObject.tp_clear` should drop the instance's references to
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
those of its members that may be Python objects, and set its pointers to those
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
members to ``NULL``, as in the following example::
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
static int
local_clear(localobject *self)
{
Py_CLEAR(self->key);
Py_CLEAR(self->args);
Py_CLEAR(self->kw);
Py_CLEAR(self->dict);
return 0;
}
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
The :c:func:`Py_CLEAR` macro should be used, because clearing references is
gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has. This change updates the documentation to reflect that perspective. It also updates the docs relative to immortal objects in a handful of places.
2023-08-07 15:40:59 -06:00
delicate: the reference to the contained object must not be released
(via :c:func:`Py_DECREF`) until
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
after the pointer to the contained object is set to ``NULL``. This is because
gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has. This change updates the documentation to reflect that perspective. It also updates the docs relative to immortal objects in a handful of places.
2023-08-07 15:40:59 -06:00
releasing the reference may cause the contained object to become trash,
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
triggering a chain of reclamation activity that may include invoking arbitrary
Python code (due to finalizers, or weakref callbacks, associated with the
contained object). If it's possible for such code to reference *self* again,
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
it's important that the pointer to the contained object be ``NULL`` at that time,
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
so that *self* knows the contained object can no longer be used. The
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:func:`Py_CLEAR` macro performs the operations in a safe order.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-107073: Make PyObject_VisitManagedDict() public (#108763) Make PyObject_VisitManagedDict() and PyObject_ClearManagedDict() functions public in Python 3.13 C API. * Rename _PyObject_VisitManagedDict() to PyObject_VisitManagedDict(). * Rename _PyObject_ClearManagedDict() to PyObject_ClearManagedDict(). * Document these functions.
2023-10-02 19:24:08 +02:00
If the :c:macro:`Py_TPFLAGS_MANAGED_DICT` bit is set in the
:c:member:`~PyTypeObject.tp_flags` field, the traverse function must call
:c:func:`PyObject_ClearManagedDict` like this::
PyObject_ClearManagedDict((PyObject*)self);
Note that tp_clear and m_clear are not always called (GH-27581)
2021-08-04 20:01:31 +02:00
Note that :c:member:`~PyTypeObject.tp_clear` is not *always* called
before an instance is deallocated. For example, when reference counting
is enough to determine that an object is no longer used, the cyclic garbage
collector is not involved and :c:member:`~PyTypeObject.tp_dealloc` is
called directly.
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
Because the goal of :c:member:`~PyTypeObject.tp_clear` functions is to break reference cycles,
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
it's not necessary to clear contained objects like Python strings or Python
integers, which can't participate in reference cycles. On the other hand, it may
be convenient to clear all contained Python objects, and write the type's
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_dealloc` function to invoke :c:member:`~PyTypeObject.tp_clear`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
More information about Python's garbage collection scheme can be found in
section :ref:`supporting-cycle-detection`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Group: :c:macro:`Py_TPFLAGS_HAVE_GC`, :c:member:`~PyTypeObject.tp_traverse`, :c:member:`~PyTypeObject.tp_clear`
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_traverse` and the
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_HAVE_GC` flag bit: the flag bit, :c:member:`~PyTypeObject.tp_traverse`, and
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_clear` are all inherited from the base type if they are all zero in
Remove many "versionchanged" items that didn't use the official markup, but just some text embedded in the docs. Also remove paragraph about implicit relative imports from tutorial.
2008-05-12 18:05:20 +00:00
the subtype.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: richcmpfunc PyTypeObject.tp_richcompare
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
An optional pointer to the rich comparison function, whose signature is::
PyObject *tp_richcompare(PyObject *self, PyObject *other, int op);
The first parameter is guaranteed to be an instance of the type
that is defined by :c:type:`PyTypeObject`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Merged revisions 60143-60149 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r60143 | georg.brandl | 2008-01-20 15:50:05 +0100 (Sun, 20 Jan 2008) | 3 lines Switch mmap from old Py_FindMethod to new PyObject_GenericGetAttr attribute access. Fixes #1087735. ........ r60145 | georg.brandl | 2008-01-20 20:40:58 +0100 (Sun, 20 Jan 2008) | 2 lines Add blurb about executable scripts on Windows. #760657. ........ r60146 | georg.brandl | 2008-01-20 20:48:40 +0100 (Sun, 20 Jan 2008) | 2 lines #1219903: fix tp_richcompare docs. ........ r60147 | georg.brandl | 2008-01-20 22:10:08 +0100 (Sun, 20 Jan 2008) | 2 lines Fix markup. ........ r60148 | gregory.p.smith | 2008-01-21 08:11:11 +0100 (Mon, 21 Jan 2008) | 14 lines Provide a sanity check during PyThreadState_DeleteCurrent() and PyThreadState_Delete() to avoid an infinite loop when the tstate list is messed up and has somehow becomes circular and does not contain the current thread. I don't know how this happens but it does, *very* rarely. On more than one hardware platform. I have not been able to reproduce it manually. Attaching to a process where its happening: it has always been in an infinite loop over a single element tstate list that is not the tstate we're looking to delete. It has been in t_bootstrap()'s call to PyThreadState_DeleteCurrent() as a pthread is exiting. ........ r60149 | georg.brandl | 2008-01-21 11:24:59 +0100 (Mon, 21 Jan 2008) | 2 lines #1269: fix a bug in pstats.add_callers() and add a unit test file for pstats. ........
2008-01-21 11:20:28 +00:00
The function should return the result of the comparison (usually ``Py_True``
or ``Py_False``). If the comparison is undefined, it must return
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
``Py_NotImplemented``, if another error occurred it must return ``NULL`` and
Merged revisions 60143-60149 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r60143 | georg.brandl | 2008-01-20 15:50:05 +0100 (Sun, 20 Jan 2008) | 3 lines Switch mmap from old Py_FindMethod to new PyObject_GenericGetAttr attribute access. Fixes #1087735. ........ r60145 | georg.brandl | 2008-01-20 20:40:58 +0100 (Sun, 20 Jan 2008) | 2 lines Add blurb about executable scripts on Windows. #760657. ........ r60146 | georg.brandl | 2008-01-20 20:48:40 +0100 (Sun, 20 Jan 2008) | 2 lines #1219903: fix tp_richcompare docs. ........ r60147 | georg.brandl | 2008-01-20 22:10:08 +0100 (Sun, 20 Jan 2008) | 2 lines Fix markup. ........ r60148 | gregory.p.smith | 2008-01-21 08:11:11 +0100 (Mon, 21 Jan 2008) | 14 lines Provide a sanity check during PyThreadState_DeleteCurrent() and PyThreadState_Delete() to avoid an infinite loop when the tstate list is messed up and has somehow becomes circular and does not contain the current thread. I don't know how this happens but it does, *very* rarely. On more than one hardware platform. I have not been able to reproduce it manually. Attaching to a process where its happening: it has always been in an infinite loop over a single element tstate list that is not the tstate we're looking to delete. It has been in t_bootstrap()'s call to PyThreadState_DeleteCurrent() as a pthread is exiting. ........ r60149 | georg.brandl | 2008-01-21 11:24:59 +0100 (Mon, 21 Jan 2008) | 2 lines #1269: fix a bug in pstats.add_callers() and add a unit test file for pstats. ........
2008-01-21 11:20:28 +00:00
set an exception condition.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
The following constants are defined to be used as the third argument for
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_richcompare` and for :c:func:`PyObject_RichCompare`:
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-107298: Docs: add targets for some :c:member: and :c:macro: references (GH-107316) Add targets for PyStructSequence_Desc and PyStructSequence_Field members and macros like Py_EQ. Fix target for Py_RETURN_RICHCOMPARE.
2023-07-27 09:04:02 +03:00
.. c:namespace:: NULL
+--------------------+------------+
| Constant | Comparison |
+====================+============+
| .. c:macro:: Py_LT | ``<`` |
+--------------------+------------+
| .. c:macro:: Py_LE | ``<=`` |
+--------------------+------------+
| .. c:macro:: Py_EQ | ``==`` |
+--------------------+------------+
| .. c:macro:: Py_NE | ``!=`` |
+--------------------+------------+
| .. c:macro:: Py_GT | ``>`` |
+--------------------+------------+
| .. c:macro:: Py_GE | ``>=`` |
+--------------------+------------+
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-23699: Use a macro to reduce boilerplate code in rich comparison functions (GH-793)
2017-11-02 11:32:54 +01:00
The following macro is defined to ease writing rich comparison functions:
bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3.
2020-08-13 22:11:50 +02:00
.. c:macro:: Py_RETURN_RICHCOMPARE(VAL_A, VAL_B, op)
bpo-23699: Use a macro to reduce boilerplate code in rich comparison functions (GH-793)
2017-11-02 11:32:54 +01:00
Return ``Py_True`` or ``Py_False`` from the function, depending on the
result of a comparison.
VAL_A and VAL_B must be orderable by C comparison operators (for example,
they may be C ints or floats). The third argument specifies the requested
operation, as for :c:func:`PyObject_RichCompare`.
gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has. This change updates the documentation to reflect that perspective. It also updates the docs relative to immortal objects in a handful of places.
2023-08-07 15:40:59 -06:00
The returned value is a new :term:`strong reference`.
bpo-23699: Use a macro to reduce boilerplate code in rich comparison functions (GH-793)
2017-11-02 11:32:54 +01:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
On error, sets an exception and returns ``NULL`` from the function.
bpo-23699: Use a macro to reduce boilerplate code in rich comparison functions (GH-793)
2017-11-02 11:32:54 +01:00
.. versionadded:: 3.7
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Group: :c:member:`~PyTypeObject.tp_hash`, :c:member:`~PyTypeObject.tp_richcompare`
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_hash`:
a subtype inherits :c:member:`~PyTypeObject.tp_richcompare` and :c:member:`~PyTypeObject.tp_hash` when
the subtype's :c:member:`~PyTypeObject.tp_richcompare` and :c:member:`~PyTypeObject.tp_hash` are both
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
``NULL``.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Default:**
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
:c:data:`PyBaseObject_Type` provides a :c:member:`~PyTypeObject.tp_richcompare`
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
implementation, which may be inherited. However, if only
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
:c:member:`~PyTypeObject.tp_hash` is defined, not even the inherited function is used
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
and instances of the type will not be able to participate in any
comparisons.
Merged revisions 60143-60149 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r60143 | georg.brandl | 2008-01-20 15:50:05 +0100 (Sun, 20 Jan 2008) | 3 lines Switch mmap from old Py_FindMethod to new PyObject_GenericGetAttr attribute access. Fixes #1087735. ........ r60145 | georg.brandl | 2008-01-20 20:40:58 +0100 (Sun, 20 Jan 2008) | 2 lines Add blurb about executable scripts on Windows. #760657. ........ r60146 | georg.brandl | 2008-01-20 20:48:40 +0100 (Sun, 20 Jan 2008) | 2 lines #1219903: fix tp_richcompare docs. ........ r60147 | georg.brandl | 2008-01-20 22:10:08 +0100 (Sun, 20 Jan 2008) | 2 lines Fix markup. ........ r60148 | gregory.p.smith | 2008-01-21 08:11:11 +0100 (Mon, 21 Jan 2008) | 14 lines Provide a sanity check during PyThreadState_DeleteCurrent() and PyThreadState_Delete() to avoid an infinite loop when the tstate list is messed up and has somehow becomes circular and does not contain the current thread. I don't know how this happens but it does, *very* rarely. On more than one hardware platform. I have not been able to reproduce it manually. Attaching to a process where its happening: it has always been in an infinite loop over a single element tstate list that is not the tstate we're looking to delete. It has been in t_bootstrap()'s call to PyThreadState_DeleteCurrent() as a pthread is exiting. ........ r60149 | georg.brandl | 2008-01-21 11:24:59 +0100 (Mon, 21 Jan 2008) | 2 lines #1269: fix a bug in pstats.add_callers() and add a unit test file for pstats. ........
2008-01-21 11:20:28 +00:00
Issue #24808: Update the documentation of some PyTypeObject fields Patch by Joseph Weston.
2015-08-25 05:06:39 +00:00
.. c:member:: Py_ssize_t PyTypeObject.tp_weaklistoffset
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
While this field is still supported, :c:macro:`Py_TPFLAGS_MANAGED_WEAKREF`
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
should be used instead, if at all possible.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
If the instances of this type are weakly referenceable, this field is greater
than zero and contains the offset in the instance structure of the weak
reference list head (ignoring the GC header, if present); this offset is used by
gh-93738: Documentation C syntax (Function glob patterns -> literal markup) (#97774)
2022-10-05 16:22:28 +01:00
:c:func:`PyObject_ClearWeakRefs` and the ``PyWeakref_*`` functions. The
gh-93738: Documentation C syntax (:c:type:`PyObject` -> :c:expr:`PyObject`) (#97776) :c:type:`PyObject` -> :c:expr:`PyObject`
2022-10-05 00:13:03 +01:00
instance structure needs to include a field of type :c:expr:`PyObject*` which is
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
initialized to ``NULL``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
Do not confuse this field with :c:member:`~PyTypeObject.tp_weaklist`; that is the list head for
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
weak references to the type object itself.
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
It is an error to set both the :c:macro:`Py_TPFLAGS_MANAGED_WEAKREF` bit and
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
:c:member:`~PyTypeObject.tp_weaklist`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is inherited by subtypes, but see the rules listed below. A subtype
may override this offset; this means that the subtype uses a different weak
reference list head than the base type. Since the list head is always found via
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_weaklistoffset`, this should not be a problem.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
**Default:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
If the :c:macro:`Py_TPFLAGS_MANAGED_WEAKREF` bit is set in the
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
:c:member:`~PyTypeObject.tp_dict` field, then
:c:member:`~PyTypeObject.tp_weaklistoffset` will be set to a negative value,
to indicate that it is unsafe to use this field.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: getiterfunc PyTypeObject.tp_iter
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-45250: fix docs regarding `__iter__` and iterators being inconsistently required by CPython (GH-29170) It is now considered a historical accident that e.g. `for` loops and the `iter()` built-in function do not require the iterators they work with to define `__iter__`, only `__next__`.
2021-11-19 16:40:34 -08:00
An optional pointer to a function that returns an :term:`iterator` for the
object. Its presence normally signals that the instances of this type are
:term:`iterable` (although sequences may be iterable without this function).
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
This function has the same signature as :c:func:`PyObject_GetIter`::
PyObject *tp_iter(PyObject *self);
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is inherited by subtypes.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: iternextfunc PyTypeObject.tp_iternext
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-45250: fix docs regarding `__iter__` and iterators being inconsistently required by CPython (GH-29170) It is now considered a historical accident that e.g. `for` loops and the `iter()` built-in function do not require the iterators they work with to define `__iter__`, only `__next__`.
2021-11-19 16:40:34 -08:00
An optional pointer to a function that returns the next item in an
:term:`iterator`. The signature is::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
PyObject *tp_iternext(PyObject *self);
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
When the iterator is exhausted, it must return ``NULL``; a :exc:`StopIteration`
Merged revisions 62602 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r62602 | georg.brandl | 2008-04-30 22:02:37 +0200 (Wed, 30 Apr 2008) | 2 lines #2727: clarify tp_iternext docs. ........
2008-04-30 20:06:53 +00:00
exception may or may not be set. When another error occurs, it must return
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
``NULL`` too. Its presence signals that the instances of this type are
Merged revisions 62602 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r62602 | georg.brandl | 2008-04-30 22:02:37 +0200 (Wed, 30 Apr 2008) | 2 lines #2727: clarify tp_iternext docs. ........
2008-04-30 20:06:53 +00:00
iterators.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
Iterator types should also define the :c:member:`~PyTypeObject.tp_iter` function, and that
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
function should return the iterator instance itself (not a new iterator
instance).
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This function has the same signature as :c:func:`PyIter_Next`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is inherited by subtypes.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: struct PyMethodDef* PyTypeObject.tp_methods
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
An optional pointer to a static ``NULL``-terminated array of :c:type:`PyMethodDef`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
structures, declaring regular methods of this type.
For each entry in the array, an entry is added to the type's dictionary (see
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_dict` below) containing a method descriptor.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is not inherited by subtypes (methods are inherited through a
different mechanism).
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: struct PyMemberDef* PyTypeObject.tp_members
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
An optional pointer to a static ``NULL``-terminated array of :c:type:`PyMemberDef`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
structures, declaring regular data members (fields or slots) of instances of
this type.
For each entry in the array, an entry is added to the type's dictionary (see
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_dict` below) containing a member descriptor.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is not inherited by subtypes (members are inherited through a
different mechanism).
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: struct PyGetSetDef* PyTypeObject.tp_getset
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
An optional pointer to a static ``NULL``-terminated array of :c:type:`PyGetSetDef`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
structures, declaring computed attributes of instances of this type.
For each entry in the array, an entry is added to the type's dictionary (see
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_dict` below) containing a getset descriptor.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is not inherited by subtypes (computed attributes are inherited
through a different mechanism).
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: PyTypeObject* PyTypeObject.tp_base
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a base type from which type properties are inherited. At
this level, only single inheritance is supported; multiple inheritance require
dynamically creating a type object by calling the metatype.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. note::
.. from Modules/xxmodule.c
Slot initialization is subject to the rules of initializing globals.
C99 requires the initializers to be "address constants". Function
designators like :c:func:`PyType_GenericNew`, with implicit conversion
to a pointer, are valid C99 address constants.
However, the unary '&' operator applied to a non-static variable
gh-107298: Fix some references in the C API documentation (GH-108072)
2023-08-17 11:16:00 +03:00
like :c:data:`PyBaseObject_Type` is not required to produce an address
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
constant. Compilers may support this (gcc does), MSVC does not.
Both compilers are strictly standard conforming in this particular
behavior.
Consequently, :c:member:`~PyTypeObject.tp_base` should be set in
the extension module's init function.
**Inheritance:**
This field is not inherited by subtypes (obviously).
**Default:**
This field defaults to ``&PyBaseObject_Type`` (which to Python
programmers is known as the type :class:`object`).
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: PyObject* PyTypeObject.tp_dict
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
The type's dictionary is stored here by :c:func:`PyType_Ready`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
This field should normally be initialized to ``NULL`` before PyType_Ready is
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
called; it may also be initialized to a dictionary containing initial attributes
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
for the type. Once :c:func:`PyType_Ready` has initialized the type, extra
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
attributes for the type may be added to this dictionary only if they don't
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
correspond to overloaded operations (like :meth:`~object.__add__`). Once
gh-105227: Add PyType_GetDict() (GH-105747) This compensates for static builtin types having `tp_dict` set to `NULL`. Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-07-10 10:41:02 -06:00
initialization for the type has finished, this field should be
treated as read-only.
Some types may not store their dictionary in this slot.
Fix misc doc typos (#108592)
2023-08-29 08:14:21 +08:00
Use :c:func:`PyType_GetDict` to retrieve the dictionary for an arbitrary
gh-105227: Add PyType_GetDict() (GH-105747) This compensates for static builtin types having `tp_dict` set to `NULL`. Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-07-10 10:41:02 -06:00
type.
.. versionchanged:: 3.12
Internals detail: For static builtin types, this is always ``NULL``.
Instead, the dict for such types is stored on ``PyInterpreterState``.
Use :c:func:`PyType_GetDict` to get the dict for an arbitrary type.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is not inherited by subtypes (though the attributes defined in here
are inherited through a different mechanism).
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Default:**
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
If this field is ``NULL``, :c:func:`PyType_Ready` will assign a new
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
dictionary to it.
note mutating tp_dict is bad (closes #12719)
2011-08-09 16:07:01 -05:00
.. warning::
It is not safe to use :c:func:`PyDict_SetItem` on or otherwise modify
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_dict` with the dictionary C-API.
note mutating tp_dict is bad (closes #12719)
2011-08-09 16:07:01 -05:00
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: descrgetfunc PyTypeObject.tp_descr_get
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a "descriptor get" function.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The function signature is::
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. XXX explain more?
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is inherited by subtypes.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: descrsetfunc PyTypeObject.tp_descr_set
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #25701: Document C API functions that both set and delete objects Also document that the separate functions that delete objects are preferred; using PyObject_SetAttr(), _SetAttrString(), and PySequence_SetItem() to delete is deprecated.
2015-12-08 00:03:20 +00:00
An optional pointer to a function for setting and deleting
a descriptor's value.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The function signature is::
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value);
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
The *value* argument is set to ``NULL`` to delete the value.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. XXX explain more?
**Inheritance:**
This field is inherited by subtypes.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #24808: Update the documentation of some PyTypeObject fields Patch by Joseph Weston.
2015-08-25 05:06:39 +00:00
.. c:member:: Py_ssize_t PyTypeObject.tp_dictoffset
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
While this field is still supported, :c:macro:`Py_TPFLAGS_MANAGED_DICT` should be
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
used instead, if at all possible.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
If the instances of this type have a dictionary containing instance variables,
this field is non-zero and contains the offset in the instances of the type of
the instance variable dictionary; this offset is used by
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:func:`PyObject_GenericGetAttr`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
Do not confuse this field with :c:member:`~PyTypeObject.tp_dict`; that is the dictionary for
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
attributes of the type object itself.
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
The value specifies the offset of the dictionary from the start of the instance structure.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
GH-92678: Document that you shouldn't be doing your own dictionary offset calculations. (GH-95598) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-08-09 14:26:37 +01:00
The :c:member:`~PyTypeObject.tp_dictoffset` should be regarded as write-only.
To get the pointer to the dictionary call :c:func:`PyObject_GenericGetDict`.
Calling :c:func:`PyObject_GenericGetDict` may need to allocate memory for the
dictionary, so it is may be more efficient to call :c:func:`PyObject_GetAttr`
when accessing an attribute on the object.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
It is an error to set both the :c:macro:`Py_TPFLAGS_MANAGED_WEAKREF` bit and
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
:c:member:`~PyTypeObject.tp_dictoffset`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
This field is inherited by subtypes. A subtype should not override this offset;
doing so could be unsafe, if C code tries to access the dictionary at the
previous offset.
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
To properly support inheritance, use :c:macro:`Py_TPFLAGS_MANAGED_DICT`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Default:**
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
This slot has no default. For :ref:`static types <static-types>`, if the
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
field is ``NULL`` then no :attr:`~object.__dict__` gets created for instances.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
If the :c:macro:`Py_TPFLAGS_MANAGED_DICT` bit is set in the
gh-107073: Make PyObject_VisitManagedDict() public (#108763) Make PyObject_VisitManagedDict() and PyObject_ClearManagedDict() functions public in Python 3.13 C API. * Rename _PyObject_VisitManagedDict() to PyObject_VisitManagedDict(). * Rename _PyObject_ClearManagedDict() to PyObject_ClearManagedDict(). * Document these functions.
2023-10-02 19:24:08 +02:00
:c:member:`~PyTypeObject.tp_flags` field, then
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
:c:member:`~PyTypeObject.tp_dictoffset` will be set to ``-1``, to indicate
that it is unsafe to use this field.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: initproc PyTypeObject.tp_init
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to an instance initialization function.
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
This function corresponds to the :meth:`~object.__init__` method of classes. Like
:meth:`!__init__`, it is possible to create an instance without calling
:meth:`!__init__`, and it is possible to reinitialize an instance by calling its
:meth:`!__init__` method again.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The function signature is::
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
int tp_init(PyObject *self, PyObject *args, PyObject *kwds);
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
The self argument is the instance to be initialized; the *args* and *kwds*
arguments represent positional and keyword arguments of the call to
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
:meth:`~object.__init__`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
The :c:member:`~PyTypeObject.tp_init` function, if not ``NULL``, is called when an instance is
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
created normally by calling its type, after the type's :c:member:`~PyTypeObject.tp_new` function
has returned an instance of the type. If the :c:member:`~PyTypeObject.tp_new` function returns an
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
instance of some other type that is not a subtype of the original type, no
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
:c:member:`~PyTypeObject.tp_init` function is called; if :c:member:`~PyTypeObject.tp_new` returns an instance of a
subtype of the original type, the subtype's :c:member:`~PyTypeObject.tp_init` is called.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Add the meaning of the returned value of PyTypeObject.tp_init (GH-12325)
2019-03-15 16:18:36 +00:00
Returns ``0`` on success, ``-1`` and sets an exception on error.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is inherited by subtypes.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Default:**
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
For :ref:`static types <static-types>` this field does not have a default.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: allocfunc PyTypeObject.tp_alloc
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to an instance allocation function.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The function signature is::
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems);
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
This field is inherited by static subtypes, but not by dynamic
subtypes (subtypes created by a class statement).
**Default:**
For dynamic subtypes, this field is always set to
:c:func:`PyType_GenericAlloc`, to force a standard heap
allocation strategy.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
For static subtypes, :c:data:`PyBaseObject_Type` uses
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
:c:func:`PyType_GenericAlloc`. That is the recommended value
for all statically defined types.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: newfunc PyTypeObject.tp_new
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to an instance creation function.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
The function signature is::
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds);
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
The *subtype* argument is the type of the object being created; the *args* and
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
*kwds* arguments represent positional and keyword arguments of the call to the
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
type. Note that *subtype* doesn't have to equal the type whose :c:member:`~PyTypeObject.tp_new`
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
function is called; it may be a subtype of that type (but not an unrelated
type).
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
The :c:member:`~PyTypeObject.tp_new` function should call ``subtype->tp_alloc(subtype, nitems)``
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
to allocate space for the object, and then do only as much further
initialization as is absolutely necessary. Initialization that can safely be
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
ignored or repeated should be placed in the :c:member:`~PyTypeObject.tp_init` handler. A good
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
rule of thumb is that for immutable types, all initialization should take place
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
in :c:member:`~PyTypeObject.tp_new`, while for mutable types, most initialization should be
deferred to :c:member:`~PyTypeObject.tp_init`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
Set the :c:macro:`Py_TPFLAGS_DISALLOW_INSTANTIATION` flag to disallow creating
bpo-43916: Add Py_TPFLAGS_DISALLOW_INSTANTIATION type flag (GH-25721) Add a new Py_TPFLAGS_DISALLOW_INSTANTIATION type flag to disallow creating type instances: set tp_new to NULL and don't create the "__new__" key in the type dictionary. The flag is set automatically on static types if tp_base is NULL or &PyBaseObject_Type and tp_new is NULL. Use the flag on the following types: * _curses.ncurses_version type * _curses_panel.panel * _tkinter.Tcl_Obj * _tkinter.tkapp * _tkinter.tktimertoken * _xxsubinterpretersmodule.ChannelID * sys.flags type * sys.getwindowsversion() type * sys.version_info type Update MyStr example in the C API documentation to use Py_TPFLAGS_DISALLOW_INSTANTIATION. Add _PyStructSequence_InitType() function to create a structseq type with the Py_TPFLAGS_DISALLOW_INSTANTIATION flag set. type_new() calls _PyType_CheckConsistency() at exit.
2021-04-30 12:46:15 +02:00
instances of the type in Python.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
This field is inherited by subtypes, except it is not inherited by
:ref:`static types <static-types>` whose :c:member:`~PyTypeObject.tp_base`
is ``NULL`` or ``&PyBaseObject_Type``.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Default:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
For :ref:`static types <static-types>` this field has no default.
This means if the slot is defined as ``NULL``, the type cannot be called
to create new instances; presumably there is some other way to create
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
instances, like a factory function.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:member:: freefunc PyTypeObject.tp_free
An optional pointer to an instance deallocation function. Its signature is::
void tp_free(void *self);
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
An initializer that is compatible with this signature is :c:func:`PyObject_Free`.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
This field is inherited by static subtypes, but not by dynamic
subtypes (subtypes created by a class statement)
**Default:**
In dynamic subtypes, this field is set to a deallocator suitable to
match :c:func:`PyType_GenericAlloc` and the value of the
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_HAVE_GC` flag bit.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
For static subtypes, :c:data:`PyBaseObject_Type` uses :c:func:`PyObject_Del`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: inquiry PyTypeObject.tp_is_gc
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
An optional pointer to a function called by the garbage collector.
The garbage collector needs to know whether a particular object is collectible
or not. Normally, it is sufficient to look at the object's type's
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:member:`~PyTypeObject.tp_flags` field, and check the :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit. But
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
some types have a mixture of statically and dynamically allocated instances, and
the statically allocated instances are not collectible. Such types should
define this function; it should return ``1`` for a collectible instance, and
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
``0`` for a non-collectible instance. The signature is::
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
int tp_is_gc(PyObject *self);
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
(The only example of this are types themselves. The metatype,
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:data:`PyType_Type`, defines this function to distinguish between statically
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
and :ref:`dynamically allocated types <heap-types>`.)
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Remove many "versionchanged" items that didn't use the official markup, but just some text embedded in the docs. Also remove paragraph about implicit relative imports from tutorial.
2008-05-12 18:05:20 +00:00
This field is inherited by subtypes.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Default:**
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
This slot has no default. If this field is ``NULL``,
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_HAVE_GC` is used as the functional equivalent.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: PyObject* PyTypeObject.tp_bases
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Tuple of base types.
gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342) These slots are marked "should be treated as read-only" in the table at the start of the document. That doesn't say anything about setting them in the static struct. `tp_bases` docs did say that it should be ``NULL`` (TIL!). If you ignore that, seemingly nothing bad happens. However, some slots may not be inherited, depending on which sub-slot structs are present. (FWIW, NumPy sets tp_bases and is affected by the quirk -- though to be fair, its DUAL_INHERIT code probably predates tp_bases docs, and also the result happens to be benign.) This patch makes things explicit. It also makes the summary table legend easier to scan. Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-11-28 09:22:08 +01:00
This field should be set to ``NULL`` and treated as read-only.
Python will fill it in when the type is :c:func:`initialized <PyType_Ready>`.
For dynamically created classes, the ``Py_tp_bases``
:c:type:`slot <PyType_Slot>` can be used instead of the *bases* argument
of :c:func:`PyType_FromSpecWithBases`.
The argument form is preferred.
.. warning::
Multiple inheritance does not work well for statically defined types.
If you set ``tp_bases`` to a tuple, Python will not raise an error,
but some slots will only be inherited from the first base.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This field is not inherited.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: PyObject* PyTypeObject.tp_mro
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Tuple containing the expanded set of base types, starting with the type itself
and ending with :class:`object`, in Method Resolution Order.
gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342) These slots are marked "should be treated as read-only" in the table at the start of the document. That doesn't say anything about setting them in the static struct. `tp_bases` docs did say that it should be ``NULL`` (TIL!). If you ignore that, seemingly nothing bad happens. However, some slots may not be inherited, depending on which sub-slot structs are present. (FWIW, NumPy sets tp_bases and is affected by the quirk -- though to be fair, its DUAL_INHERIT code probably predates tp_bases docs, and also the result happens to be benign.) This patch makes things explicit. It also makes the summary table legend easier to scan. Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-11-28 09:22:08 +01:00
This field should be set to ``NULL`` and treated as read-only.
Python will fill it in when the type is :c:func:`initialized <PyType_Ready>`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
This field is not inherited; it is calculated fresh by
:c:func:`PyType_Ready`.
.. c:member:: PyObject* PyTypeObject.tp_cache
Unused. Internal use only.
**Inheritance:**
This field is not inherited.
gh-94673: Add Per-Interpreter tp_subclasses for Static Builtin Types (gh-95301)
2022-08-04 19:26:59 -06:00
.. c:member:: void* PyTypeObject.tp_subclasses
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
gh-94673: Add Per-Interpreter tp_subclasses for Static Builtin Types (gh-95301)
2022-08-04 19:26:59 -06:00
A collection of subclasses. Internal use only. May be an invalid pointer.
To get a list of subclasses, call the Python method
:py:meth:`~class.__subclasses__`.
.. versionchanged:: 3.12
For some types, this field does not hold a valid :c:expr:`PyObject*`.
The type was changed to :c:expr:`void*` to indicate this.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
This field is not inherited.
.. c:member:: PyObject* PyTypeObject.tp_weaklist
Weak reference list head, for weak references to this type object. Not
inherited. Internal use only.
gh-94673: Add Per-Interpreter tp_weaklist for Static Builtin Types (#95302) * Store tp_weaklist on the interpreter state for static builtin types. * Factor out _PyStaticType_GET_WEAKREFS_LISTPTR(). * Add _PyStaticType_ClearWeakRefs(). * Add a comment about how _PyStaticType_ClearWeakRefs() loops. * Document the change. * Update Doc/whatsnew/3.12.rst * Fix a typo.
2022-07-28 19:23:47 -06:00
.. versionchanged:: 3.12
Internals detail: For the static builtin types this is always ``NULL``,
even if weakrefs are added. Instead, the weakrefs for each are stored
on ``PyInterpreterState``. Use the public C-API or the internal
``_PyObject_GET_WEAKREFS_LISTPTR()`` macro to avoid the distinction.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
This field is not inherited.
.. c:member:: destructor PyTypeObject.tp_del
This field is deprecated. Use :c:member:`~PyTypeObject.tp_finalize` instead.
.. c:member:: unsigned int PyTypeObject.tp_version_tag
Used to index into the method cache. Internal use only.
**Inheritance:**
This field is not inherited.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #18112: PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
.. c:member:: destructor PyTypeObject.tp_finalize
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
An optional pointer to an instance finalization function. Its signature is::
Issue #18112: PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
void tp_finalize(PyObject *self);
Issue #18112: PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:14:43 +02:00
If :c:member:`~PyTypeObject.tp_finalize` is set, the interpreter calls it once when
Issue #18112: PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
finalizing an instance. It is called either from the garbage
collector (if the instance is part of an isolated reference cycle) or
just before the object is deallocated. Either way, it is guaranteed
to be called before attempting to break reference cycles, ensuring
that it finds the object in a sane state.
Issue #18589: fix hyperlinking of type slots (tp_*)
2013-08-01 21:14:43 +02:00
:c:member:`~PyTypeObject.tp_finalize` should not mutate the current exception status;
Issue #18112: PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
therefore, a recommended way to write a non-trivial finalizer is::
static void
local_finalize(PyObject *self)
{
PyObject *error_type, *error_value, *error_traceback;
/* Save the current exception, if any. */
PyErr_Fetch(&error_type, &error_value, &error_traceback);
/* ... */
/* Restore the saved exception. */
PyErr_Restore(error_type, error_value, error_traceback);
}
Minor fixes to C API docs (GH-31501) * C API docs: move PyErr_SetImportErrorSubclass docs It was in the section about warnings, but it makes more sense to put it with PyErr_SetImportError. * C API docs: document closeit argument to PyRun_AnyFileExFlags It was already documented for PyRun_SimpleFileExFlags. * textual fixes to unicode docs * Move paragraph about tp_dealloc into tp_dealloc section * __aiter__ returns an async iterator, not an awaitable
2022-02-22 20:34:17 -08:00
Also, note that, in a garbage collected Python,
:c:member:`~PyTypeObject.tp_dealloc` may be called from
any Python thread, not just the thread which created the object (if the object
becomes part of a refcount cycle, that cycle might be collected by a garbage
collection on any thread). This is not a problem for Python API calls, since
the thread on which tp_dealloc is called will own the Global Interpreter Lock
(GIL). However, if the object being destroyed in turn destroys objects from some
other C or C++ library, care should be taken to ensure that destroying those
objects on the thread which called tp_dealloc will not violate any assumptions
of the library.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
**Inheritance:**
Issue #18112: PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
This field is inherited by subtypes.
.. versionadded:: 3.4
Doc: Update Py_TPFLAGS_HAVE_FINALIZE in docs (GH-96273) It is now deprecated and the docs should reflect that.
2022-08-30 09:31:14 +01:00
.. versionchanged:: 3.8
Before version 3.8 it was necessary to set the
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_HAVE_FINALIZE` flags bit in order for this field to be
Doc: Update Py_TPFLAGS_HAVE_FINALIZE in docs (GH-96273) It is now deprecated and the docs should reflect that.
2022-08-30 09:31:14 +01:00
used. This is no longer required.
Issue #18112: PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
.. seealso:: "Safe object finalization" (:pep:`442`)
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
.. c:member:: vectorcallfunc PyTypeObject.tp_vectorcall
Vectorcall function to use for calls of this type object.
In other words, it is used to implement
:ref:`vectorcall <vectorcall>` for ``type.__call__``.
If ``tp_vectorcall`` is ``NULL``, the default call implementation
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
using :meth:`~object.__new__` and :meth:`~object.__init__` is used.
bpo-36974: expand call protocol documentation (GH-13844) CC @encukou I'm also adding Petr Viktorin as contributor for vectorcall in the "what's new" section. https://bugs.python.org/issue36974 Automerge-Triggered-By: @encukou Automerge-Triggered-By: @encukou
2019-11-12 14:08:00 +01:00
**Inheritance:**
This field is never inherited.
.. versionadded:: 3.9 (the field exists since 3.8 but it's only used since 3.9)
gh-91051: fix segfault when using all 8 type watchers (#107853)
2023-08-11 12:42:26 -06:00
.. c:member:: unsigned char PyTypeObject.tp_watched
GH-99767: update PyTypeObject docs for type watchers (GH-99928)
2022-12-15 04:26:08 -07:00
Internal. Do not use.
.. versionadded:: 3.12
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
.. _static-types:
bpo-34626: Document creating heap types from the C-API (GH-9154) bpo-34626: Document creating heap types from the C-API Add missing descriptions of PEP384's PyType_Spec and PyType_Slot, along with some introductory prose.
2019-05-24 11:19:42 +02:00
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
Static Types
------------
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
bpo-34626: Document creating heap types from the C-API (GH-9154) bpo-34626: Document creating heap types from the C-API Add missing descriptions of PEP384's PyType_Spec and PyType_Slot, along with some introductory prose.
2019-05-24 11:19:42 +02:00
Traditionally, types defined in C code are *static*, that is,
a static :c:type:`PyTypeObject` structure is defined directly in code
and initialized using :c:func:`PyType_Ready`.
This results in types that are limited relative to types defined in Python:
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
bpo-34626: Document creating heap types from the C-API (GH-9154) bpo-34626: Document creating heap types from the C-API Add missing descriptions of PEP384's PyType_Spec and PyType_Slot, along with some introductory prose.
2019-05-24 11:19:42 +02:00
* Static types are limited to one base, i.e. they cannot use multiple
inheritance.
* Static type objects (but not necessarily their instances) are immutable.
It is not possible to add or modify the type object's attributes from Python.
* Static type objects are shared across
:ref:`sub-interpreters <sub-interpreter-support>`, so they should not
include any subinterpreter-specific state.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Clarify API stability of PyTypeObject in relation to static types. (GH-96217) Fixes: https://github.com/python/cpython/issues/95300 Related: https://github.com/python/cpython/issues/91271
2022-08-25 09:32:12 -04:00
Also, since :c:type:`PyTypeObject` is only part of the :ref:`Limited API
gh-102304: doc: Add links to Stable ABI and Limited C API (#105345) * Add "limited-c-api" and "stable-api" references. * Rename "stable-abi-list" reference to "limited-api-list". * Makefile: Document files regenerated by "make regen-limited-abi" * Remove first empty line in generated files: - Lib/test/test_stable_abi_ctypes.py - PC/python3dll.c
2023-06-06 10:40:32 +02:00
<limited-c-api>` as an opaque struct, any extension modules using static types must be
Clarify API stability of PyTypeObject in relation to static types. (GH-96217) Fixes: https://github.com/python/cpython/issues/95300 Related: https://github.com/python/cpython/issues/91271
2022-08-25 09:32:12 -04:00
compiled for a specific Python minor version.
bpo-34626: Document creating heap types from the C-API (GH-9154) bpo-34626: Document creating heap types from the C-API Add missing descriptions of PEP384's PyType_Spec and PyType_Slot, along with some introductory prose.
2019-05-24 11:19:42 +02:00
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
.. _heap-types:
Heap Types
----------
An alternative to :ref:`static types <static-types>` is *heap-allocated types*,
or *heap types* for short, which correspond closely to classes created by
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
Python's ``class`` statement. Heap types have the :c:macro:`Py_TPFLAGS_HEAPTYPE`
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
flag set.
bpo-34626: Document creating heap types from the C-API (GH-9154) bpo-34626: Document creating heap types from the C-API Add missing descriptions of PEP384's PyType_Spec and PyType_Slot, along with some introductory prose.
2019-05-24 11:19:42 +02:00
This is done by filling a :c:type:`PyType_Spec` structure and calling
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
:c:func:`PyType_FromSpec`, :c:func:`PyType_FromSpecWithBases`,
gh-60074: add new stable API function PyType_FromMetaclass (GH-93012) Added a new stable API function ``PyType_FromMetaclass``, which mirrors the behavior of ``PyType_FromModuleAndSpec`` except that it takes an additional metaclass argument. This is, e.g., useful for language binding tools that need to store additional information in the type object.
2022-05-27 10:27:39 +02:00
:c:func:`PyType_FromModuleAndSpec`, or :c:func:`PyType_FromMetaclass`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
.. _number-structs:
Number Object Structures
========================
.. sectionauthor:: Amaury Forgeot d'Arc
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:type:: PyNumberMethods
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This structure holds pointers to the functions which an object uses to
implement the number protocol. Each function is used by the function of
similar name documented in the :ref:`number` section.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. XXX Drop the definition?
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Here is the structure definition::
typedef struct {
binaryfunc nb_add;
binaryfunc nb_subtract;
binaryfunc nb_multiply;
binaryfunc nb_remainder;
binaryfunc nb_divmod;
ternaryfunc nb_power;
unaryfunc nb_negative;
unaryfunc nb_positive;
unaryfunc nb_absolute;
inquiry nb_bool;
unaryfunc nb_invert;
binaryfunc nb_lshift;
binaryfunc nb_rshift;
binaryfunc nb_and;
binaryfunc nb_xor;
binaryfunc nb_or;
unaryfunc nb_int;
Issue #4910, patch 3/3: rename nb_long to nb_reserved
2009-01-17 10:04:45 +00:00
void *nb_reserved;
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
unaryfunc nb_float;
binaryfunc nb_inplace_add;
binaryfunc nb_inplace_subtract;
binaryfunc nb_inplace_multiply;
binaryfunc nb_inplace_remainder;
ternaryfunc nb_inplace_power;
binaryfunc nb_inplace_lshift;
binaryfunc nb_inplace_rshift;
binaryfunc nb_inplace_and;
binaryfunc nb_inplace_xor;
binaryfunc nb_inplace_or;
binaryfunc nb_floor_divide;
binaryfunc nb_true_divide;
binaryfunc nb_inplace_floor_divide;
binaryfunc nb_inplace_true_divide;
unaryfunc nb_index;
PEP 465: a dedicated infix operator for matrix multiplication (closes #21176)
2014-04-09 23:55:56 -04:00
binaryfunc nb_matrix_multiply;
binaryfunc nb_inplace_matrix_multiply;
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
} PyNumberMethods;
.. note::
Binary and ternary functions must check the type of all their operands,
and implement the necessary conversions (at least one of the operands is
an instance of the defined type). If the operation is not defined for the
given operands, binary and ternary functions must return
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
``Py_NotImplemented``, if another error occurred they must return ``NULL``
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
and set an exception.
Issue #4910, patch 3/3: rename nb_long to nb_reserved
2009-01-17 10:04:45 +00:00
.. note::
gh-107091: Fix the use of some C domain roles (#107092)
2023-07-23 13:27:05 +03:00
The :c:member:`~PyNumberMethods.nb_reserved` field should always be ``NULL``. It
was previously called :c:member:`!nb_long`, and was renamed in
Issue #4910, patch 3/3: rename nb_long to nb_reserved
2009-01-17 10:04:45 +00:00
Python 3.0.1.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:member:: binaryfunc PyNumberMethods.nb_add
.. c:member:: binaryfunc PyNumberMethods.nb_subtract
.. c:member:: binaryfunc PyNumberMethods.nb_multiply
.. c:member:: binaryfunc PyNumberMethods.nb_remainder
.. c:member:: binaryfunc PyNumberMethods.nb_divmod
.. c:member:: ternaryfunc PyNumberMethods.nb_power
.. c:member:: unaryfunc PyNumberMethods.nb_negative
.. c:member:: unaryfunc PyNumberMethods.nb_positive
.. c:member:: unaryfunc PyNumberMethods.nb_absolute
.. c:member:: inquiry PyNumberMethods.nb_bool
.. c:member:: unaryfunc PyNumberMethods.nb_invert
.. c:member:: binaryfunc PyNumberMethods.nb_lshift
.. c:member:: binaryfunc PyNumberMethods.nb_rshift
.. c:member:: binaryfunc PyNumberMethods.nb_and
.. c:member:: binaryfunc PyNumberMethods.nb_xor
.. c:member:: binaryfunc PyNumberMethods.nb_or
.. c:member:: unaryfunc PyNumberMethods.nb_int
.. c:member:: void *PyNumberMethods.nb_reserved
.. c:member:: unaryfunc PyNumberMethods.nb_float
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_add
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_subtract
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_multiply
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_remainder
.. c:member:: ternaryfunc PyNumberMethods.nb_inplace_power
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_lshift
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_rshift
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_and
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_xor
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_or
.. c:member:: binaryfunc PyNumberMethods.nb_floor_divide
.. c:member:: binaryfunc PyNumberMethods.nb_true_divide
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_floor_divide
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_true_divide
.. c:member:: unaryfunc PyNumberMethods.nb_index
.. c:member:: binaryfunc PyNumberMethods.nb_matrix_multiply
.. c:member:: binaryfunc PyNumberMethods.nb_inplace_matrix_multiply
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
.. _mapping-structs:
Mapping Object Structures
=========================
.. sectionauthor:: Amaury Forgeot d'Arc
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:type:: PyMappingMethods
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This structure holds pointers to the functions which an object uses to
implement the mapping protocol. It has three members:
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: lenfunc PyMappingMethods.mp_length
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
This function is used by :c:func:`PyMapping_Size` and
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
:c:func:`PyObject_Size`, and has the same signature. This slot may be set to
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
``NULL`` if the object has no defined length.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: binaryfunc PyMappingMethods.mp_subscript
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
This function is used by :c:func:`PyObject_GetItem` and
:c:func:`PySequence_GetSlice`, and has the same signature as
:c:func:`!PyObject_GetItem`. This slot must be filled for the
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
:c:func:`PyMapping_Check` function to return ``1``, it can be ``NULL``
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
otherwise.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: objobjargproc PyMappingMethods.mp_ass_subscript
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
This function is used by :c:func:`PyObject_SetItem`,
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
:c:func:`PyObject_DelItem`, :c:func:`PySequence_SetSlice` and
:c:func:`PySequence_DelSlice`. It has the same signature as
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
:c:func:`!PyObject_SetItem`, but *v* can also be set to ``NULL`` to delete
an item. If this slot is ``NULL``, the object does not support item
Issue #25701: Document C API functions that both set and delete objects Also document that the separate functions that delete objects are preferred; using PyObject_SetAttr(), _SetAttrString(), and PySequence_SetItem() to delete is deprecated.
2015-12-08 00:03:20 +00:00
assignment and deletion.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
.. _sequence-structs:
Sequence Object Structures
==========================
.. sectionauthor:: Amaury Forgeot d'Arc
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:type:: PySequenceMethods
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
This structure holds pointers to the functions which an object uses to
implement the sequence protocol.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: lenfunc PySequenceMethods.sq_length
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
This function is used by :c:func:`PySequence_Size` and
:c:func:`PyObject_Size`, and has the same signature. It is also used for
handling negative indices via the :c:member:`~PySequenceMethods.sq_item`
and the :c:member:`~PySequenceMethods.sq_ass_item` slots.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: binaryfunc PySequenceMethods.sq_concat
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This function is used by :c:func:`PySequence_Concat` and has the same
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
signature. It is also used by the ``+`` operator, after trying the numeric
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
addition via the :c:member:`~PyNumberMethods.nb_add` slot.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: ssizeargfunc PySequenceMethods.sq_repeat
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This function is used by :c:func:`PySequence_Repeat` and has the same
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
signature. It is also used by the ``*`` operator, after trying numeric
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
multiplication via the :c:member:`~PyNumberMethods.nb_multiply` slot.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: ssizeargfunc PySequenceMethods.sq_item
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This function is used by :c:func:`PySequence_GetItem` and has the same
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
signature. It is also used by :c:func:`PyObject_GetItem`, after trying
the subscription via the :c:member:`~PyMappingMethods.mp_subscript` slot.
This slot must be filled for the :c:func:`PySequence_Check`
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
function to return ``1``, it can be ``NULL`` otherwise.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
Negative indexes are handled as follows: if the :c:member:`~PySequenceMethods.sq_length` slot is
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
filled, it is called and the sequence length is used to compute a positive
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
index which is passed to :c:member:`~PySequenceMethods.sq_item`. If :c:member:`!sq_length` is ``NULL``,
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
the index is passed as is to the function.
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: ssizeobjargproc PySequenceMethods.sq_ass_item
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This function is used by :c:func:`PySequence_SetItem` and has the same
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
signature. It is also used by :c:func:`PyObject_SetItem` and
:c:func:`PyObject_DelItem`, after trying the item assignment and deletion
via the :c:member:`~PyMappingMethods.mp_ass_subscript` slot.
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
This slot may be left to ``NULL`` if the object does not support
Issue #25701: Document C API functions that both set and delete objects Also document that the separate functions that delete objects are preferred; using PyObject_SetAttr(), _SetAttrString(), and PySequence_SetItem() to delete is deprecated.
2015-12-08 00:03:20 +00:00
item assignment and deletion.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: objobjproc PySequenceMethods.sq_contains
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This function may be used by :c:func:`PySequence_Contains` and has the same
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
signature. This slot may be left to ``NULL``, in this case
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
:c:func:`!PySequence_Contains` simply traverses the sequence until it
finds a match.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: binaryfunc PySequenceMethods.sq_inplace_concat
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This function is used by :c:func:`PySequence_InPlaceConcat` and has the same
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
signature. It should modify its first operand, and return it. This slot
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
may be left to ``NULL``, in this case :c:func:`!PySequence_InPlaceConcat`
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
will fall back to :c:func:`PySequence_Concat`. It is also used by the
Correct "inplace" with "in-place" (GH-10480)
2019-04-08 06:14:43 -03:00
augmented assignment ``+=``, after trying numeric in-place addition
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
via the :c:member:`~PyNumberMethods.nb_inplace_add` slot.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
.. c:member:: ssizeargfunc PySequenceMethods.sq_inplace_repeat
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
This function is used by :c:func:`PySequence_InPlaceRepeat` and has the same
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
signature. It should modify its first operand, and return it. This slot
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
may be left to ``NULL``, in this case :c:func:`!PySequence_InPlaceRepeat`
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
will fall back to :c:func:`PySequence_Repeat`. It is also used by the
Correct "inplace" with "in-place" (GH-10480)
2019-04-08 06:14:43 -03:00
augmented assignment ``*=``, after trying numeric in-place multiplication
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
via the :c:member:`~PyNumberMethods.nb_inplace_multiply` slot.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
.. _buffer-structs:
Buffer Object Structures
========================
.. sectionauthor:: Greg J. Stein <greg@lyra.org>
add documentation for the new buffer interface based on PEP 3118; I hope it's at least 60% right...
2008-09-16 02:24:31 +00:00
.. sectionauthor:: Benjamin Peterson
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
.. sectionauthor:: Stefan Krah
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
.. c:type:: PyBufferProcs
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
This structure holds pointers to the functions required by the
:ref:`Buffer protocol <bufferobjects>`. The protocol defines how
an exporter object can expose its internal data to consumer objects.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
.. c:member:: getbufferproc PyBufferProcs.bf_getbuffer
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
The signature of this function is::
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
int (PyObject *exporter, Py_buffer *view, int flags);
Handle a request to *exporter* to fill in *view* as specified by *flags*.
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
Except for point (3), an implementation of this function MUST take these
steps:
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
gh-107298: Fix C API Buffer documentation (#108011)
2023-08-16 18:24:46 +02:00
(1) Check if the request can be met. If not, raise :exc:`BufferError`,
gh-93738: Documentation C syntax (:c:data:`view->obj` -> :c:expr:`view->obj`) (#97773) :c:data:`view->obj` -> :c:expr:`view->obj`
2022-10-05 00:18:09 +01:00
set :c:expr:`view->obj` to ``NULL`` and return ``-1``.
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
(2) Fill in the requested fields.
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
(3) Increment an internal counter for the number of exports.
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
gh-93738: Documentation C syntax (:c:data:`view->obj` -> :c:expr:`view->obj`) (#97773) :c:data:`view->obj` -> :c:expr:`view->obj`
2022-10-05 00:18:09 +01:00
(4) Set :c:expr:`view->obj` to *exporter* and increment :c:expr:`view->obj`.
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
Issue #28496: Mark up constants 0, 1 and -1 that denote return values or special input values as literal text.
2016-10-27 21:41:19 +03:00
(5) Return ``0``.
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
If *exporter* is part of a chain or tree of buffer providers, two main
schemes can be used:
* Re-export: Each member of the tree acts as the exporting object and
gh-93738: Documentation C syntax (:c:data:`view->obj` -> :c:expr:`view->obj`) (#97773) :c:data:`view->obj` -> :c:expr:`view->obj`
2022-10-05 00:18:09 +01:00
sets :c:expr:`view->obj` to a new reference to itself.
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
* Redirect: The buffer request is redirected to the root object of the
gh-93738: Documentation C syntax (:c:data:`view->obj` -> :c:expr:`view->obj`) (#97773) :c:data:`view->obj` -> :c:expr:`view->obj`
2022-10-05 00:18:09 +01:00
tree. Here, :c:expr:`view->obj` will be a new reference to the root
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
object.
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
The individual fields of *view* are described in section
:ref:`Buffer structure <buffer-structure>`, the rules how an exporter
must react to specific requests are in section
:ref:`Buffer request types <buffer-request-types>`.
All memory pointed to in the :c:type:`Py_buffer` structure belongs to
the exporter and must remain valid until there are no consumers left.
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
:c:member:`~Py_buffer.format`, :c:member:`~Py_buffer.shape`,
:c:member:`~Py_buffer.strides`, :c:member:`~Py_buffer.suboffsets`
and :c:member:`~Py_buffer.internal`
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
are read-only for the consumer.
:c:func:`PyBuffer_FillInfo` provides an easy way of exposing a simple
bytes buffer while dealing correctly with all request types.
:c:func:`PyObject_GetBuffer` is the interface for the consumer that
wraps this function.
.. c:member:: releasebufferproc PyBufferProcs.bf_releasebuffer
The signature of this function is::
void (PyObject *exporter, Py_buffer *view);
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
Handle a request to release the resources of the buffer. If no resources
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
need to be released, :c:member:`PyBufferProcs.bf_releasebuffer` may be
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
``NULL``. Otherwise, a standard implementation of this function will take
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
these optional steps:
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
(1) Decrement an internal counter for the number of exports.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Issue #28496: Mark up constants 0, 1 and -1 that denote return values or special input values as literal text.
2016-10-27 21:41:19 +03:00
(2) If the counter is ``0``, free all memory associated with *view*.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
The exporter MUST use the :c:member:`~Py_buffer.internal` field to keep
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
track of buffer-specific resources. This field is guaranteed to remain
constant, while a consumer MAY pass a copy of the original buffer as the
*view* argument.
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
gh-93738: Documentation C syntax (:c:data:`view->obj` -> :c:expr:`view->obj`) (#97773) :c:data:`view->obj` -> :c:expr:`view->obj`
2022-10-05 00:18:09 +01:00
This function MUST NOT decrement :c:expr:`view->obj`, since that is
Issue #14181: Improve clarity in the documentation for the multi-purpose Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
done automatically in :c:func:`PyBuffer_Release` (this scheme is
useful for breaking reference cycles).
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
- Issue #10181: New memoryview implementation fixes multiple ownership and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
2012-02-25 12:24:21 +01:00
:c:func:`PyBuffer_Release` is the interface for the consumer that
wraps this function.
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
.. _async-structs:
Async Object Structures
=======================
.. sectionauthor:: Yury Selivanov <yselivanov@sprymix.com>
Issue 24180: Fixes by Berker Peksag.
2015-05-21 17:02:31 -04:00
.. versionadded:: 3.5
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
.. c:type:: PyAsyncMethods
This structure holds pointers to the functions required to implement
:term:`awaitable` and :term:`asynchronous iterator` objects.
Here is the structure definition::
typedef struct {
Issue 24017: Drop getawaitablefunc and friends in favor of unaryfunc.
2015-05-28 11:21:31 -04:00
unaryfunc am_await;
unaryfunc am_aiter;
unaryfunc am_anext;
bpo-42085: Introduce dedicated entry in PyAsyncMethods for sending values (#22780)
2020-11-10 12:09:55 -08:00
sendfunc am_send;
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
} PyAsyncMethods;
Issue 24017: Drop getawaitablefunc and friends in favor of unaryfunc.
2015-05-28 11:21:31 -04:00
.. c:member:: unaryfunc PyAsyncMethods.am_await
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
The signature of this function is::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
PyObject *am_await(PyObject *self);
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
bpo-45250: fix docs regarding `__iter__` and iterators being inconsistently required by CPython (GH-29170) It is now considered a historical accident that e.g. `for` loops and the `iter()` built-in function do not require the iterators they work with to define `__iter__`, only `__next__`.
2021-11-19 16:40:34 -08:00
The returned object must be an :term:`iterator`, i.e. :c:func:`PyIter_Check`
must return ``1`` for it.
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
This slot may be set to ``NULL`` if an object is not an :term:`awaitable`.
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
Issue 24017: Drop getawaitablefunc and friends in favor of unaryfunc.
2015-05-28 11:21:31 -04:00
.. c:member:: unaryfunc PyAsyncMethods.am_aiter
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
The signature of this function is::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
PyObject *am_aiter(PyObject *self);
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
Minor fixes to C API docs (GH-31501) * C API docs: move PyErr_SetImportErrorSubclass docs It was in the section about warnings, but it makes more sense to put it with PyErr_SetImportError. * C API docs: document closeit argument to PyRun_AnyFileExFlags It was already documented for PyRun_SimpleFileExFlags. * textual fixes to unicode docs * Move paragraph about tp_dealloc into tp_dealloc section * __aiter__ returns an async iterator, not an awaitable
2022-02-22 20:34:17 -08:00
Must return an :term:`asynchronous iterator` object.
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
See :meth:`~object.__anext__` for details.
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
This slot may be set to ``NULL`` if an object does not implement
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
asynchronous iteration protocol.
Issue 24017: Drop getawaitablefunc and friends in favor of unaryfunc.
2015-05-28 11:21:31 -04:00
.. c:member:: unaryfunc PyAsyncMethods.am_anext
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
The signature of this function is::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
PyObject *am_anext(PyObject *self);
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
Must return an :term:`awaitable` object.
See :meth:`~object.__anext__` for details.
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
This slot may be set to ``NULL``.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
bpo-42085: Introduce dedicated entry in PyAsyncMethods for sending values (#22780)
2020-11-10 12:09:55 -08:00
.. c:member:: sendfunc PyAsyncMethods.am_send
The signature of this function is::
PySendResult am_send(PyObject *self, PyObject *arg, PyObject **result);
See :c:func:`PyIter_Send` for details.
This slot may be set to ``NULL``.
bpo-42085: [docs] Add versionadded for am_send in type object documentation (GH-25465)
2021-05-29 22:30:27 +02:00
.. versionadded:: 3.10
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. _slot-typedefs:
Slot Type typedefs
==================
.. c:type:: PyObject *(*allocfunc)(PyTypeObject *cls, Py_ssize_t nitems)
The purpose of this function is to separate memory allocation from memory
initialization. It should return a pointer to a block of memory of adequate
length for the instance, suitably aligned, and initialized to zeros, but with
gh-107091: Fix some uses of :attr: role (GH-107318) Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
:c:member:`~PyObject.ob_refcnt` set to ``1`` and :c:member:`~PyObject.ob_type` set to the type argument. If
the type's :c:member:`~PyTypeObject.tp_itemsize` is non-zero, the object's :c:member:`~PyVarObject.ob_size` field
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
should be initialized to *nitems* and the length of the allocated memory block
should be ``tp_basicsize + nitems*tp_itemsize``, rounded up to a multiple of
``sizeof(void*)``; otherwise, *nitems* is not used and the length of the block
should be :c:member:`~PyTypeObject.tp_basicsize`.
This function should not do any other instance initialization, not even to
allocate additional memory; that should be done by :c:member:`~PyTypeObject.tp_new`.
.. c:type:: void (*destructor)(PyObject *)
.. c:type:: void (*freefunc)(void *)
See :c:member:`~PyTypeObject.tp_free`.
.. c:type:: PyObject *(*newfunc)(PyObject *, PyObject *, PyObject *)
See :c:member:`~PyTypeObject.tp_new`.
.. c:type:: int (*initproc)(PyObject *, PyObject *, PyObject *)
See :c:member:`~PyTypeObject.tp_init`.
.. c:type:: PyObject *(*reprfunc)(PyObject *)
See :c:member:`~PyTypeObject.tp_repr`.
.. c:type:: PyObject *(*getattrfunc)(PyObject *self, char *attr)
Return the value of the named attribute for the object.
.. c:type:: int (*setattrfunc)(PyObject *self, char *attr, PyObject *value)
Set the value of the named attribute for the object.
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
The value argument is set to ``NULL`` to delete the attribute.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:type:: PyObject *(*getattrofunc)(PyObject *self, PyObject *attr)
Return the value of the named attribute for the object.
See :c:member:`~PyTypeObject.tp_getattro`.
.. c:type:: int (*setattrofunc)(PyObject *self, PyObject *attr, PyObject *value)
Set the value of the named attribute for the object.
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
The value argument is set to ``NULL`` to delete the attribute.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
See :c:member:`~PyTypeObject.tp_setattro`.
.. c:type:: PyObject *(*descrgetfunc)(PyObject *, PyObject *, PyObject *)
[doc] fix typo in reference to tp_descr_get and tp_descr_set (GH-94140)
2022-06-26 12:02:29 +02:00
See :c:member:`~PyTypeObject.tp_descr_get`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:type:: int (*descrsetfunc)(PyObject *, PyObject *, PyObject *)
[doc] fix typo in reference to tp_descr_get and tp_descr_set (GH-94140)
2022-06-26 12:02:29 +02:00
See :c:member:`~PyTypeObject.tp_descr_set`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:type:: Py_hash_t (*hashfunc)(PyObject *)
See :c:member:`~PyTypeObject.tp_hash`.
.. c:type:: PyObject *(*richcmpfunc)(PyObject *, PyObject *, int)
See :c:member:`~PyTypeObject.tp_richcompare`.
.. c:type:: PyObject *(*getiterfunc)(PyObject *)
See :c:member:`~PyTypeObject.tp_iter`.
.. c:type:: PyObject *(*iternextfunc)(PyObject *)
See :c:member:`~PyTypeObject.tp_iternext`.
.. c:type:: Py_ssize_t (*lenfunc)(PyObject *)
.. c:type:: int (*getbufferproc)(PyObject *, Py_buffer *, int)
.. c:type:: void (*releasebufferproc)(PyObject *, Py_buffer *)
.. c:type:: PyObject *(*unaryfunc)(PyObject *)
.. c:type:: PyObject *(*binaryfunc)(PyObject *, PyObject *)
bpo-42085: Introduce dedicated entry in PyAsyncMethods for sending values (#22780)
2020-11-10 12:09:55 -08:00
.. c:type:: PySendResult (*sendfunc)(PyObject *, PyObject *, PyObject **)
See :c:member:`~PyAsyncMethods.am_send`.
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:type:: PyObject *(*ternaryfunc)(PyObject *, PyObject *, PyObject *)
.. c:type:: PyObject *(*ssizeargfunc)(PyObject *, Py_ssize_t)
docs: fix `ssizeobjargproc` parameters (#100736)
2023-01-04 02:17:42 -06:00
.. c:type:: int (*ssizeobjargproc)(PyObject *, Py_ssize_t, PyObject *)
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.. c:type:: int (*objobjproc)(PyObject *, PyObject *)
.. c:type:: int (*objobjargproc)(PyObject *, PyObject *, PyObject *)
bpo-38103: fix conflicting labels in the docs. (GH-15906)
2019-09-11 11:57:59 +01:00
.. _typedef-examples:
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Examples
========
The following are simple examples of Python type definitions. They
include common usage you may encounter. Some demonstrate tricky corner
cases. For more examples, practical info, and a tutorial, see
:ref:`defining-new-types` and :ref:`new-types-topics`.
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
A basic :ref:`static type <static-types>`::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
typedef struct {
PyObject_HEAD
const char *data;
} MyObject;
static PyTypeObject MyObject_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "mymod.MyObject",
.tp_basicsize = sizeof(MyObject),
gh-91118: Fix docstrings that do not honor --without-doc-strings (#31769) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-04-18 06:39:32 +03:00
.tp_doc = PyDoc_STR("My objects"),
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.tp_new = myobj_new,
.tp_dealloc = (destructor)myobj_dealloc,
.tp_repr = (reprfunc)myobj_repr,
};
You may also find older code (especially in the CPython code base)
with a more verbose initializer::
static PyTypeObject MyObject_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"mymod.MyObject", /* tp_name */
sizeof(MyObject), /* tp_basicsize */
0, /* tp_itemsize */
(destructor)myobj_dealloc, /* tp_dealloc */
bpo-36974: document PEP 590 (GH-13450)
2019-06-03 01:43:13 +02:00
0, /* tp_vectorcall_offset */
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_as_async */
(reprfunc)myobj_repr, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
0, /* tp_call */
0, /* tp_str */
0, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
0, /* tp_flags */
gh-91118: Fix docstrings that do not honor --without-doc-strings (#31769) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-04-18 06:39:32 +03:00
PyDoc_STR("My objects"), /* tp_doc */
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
0, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
0, /* tp_init */
0, /* tp_alloc */
myobj_new, /* tp_new */
};
A type that supports weakrefs, instance dicts, and hashing::
typedef struct {
PyObject_HEAD
const char *data;
} MyObject;
static PyTypeObject MyObject_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "mymod.MyObject",
.tp_basicsize = sizeof(MyObject),
gh-91118: Fix docstrings that do not honor --without-doc-strings (#31769) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-04-18 06:39:32 +03:00
.tp_doc = PyDoc_STR("My objects"),
GH-95245: Document use of `MANAGED` flags instead of offsets. (GH-96044)
2022-08-30 16:26:08 +01:00
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_MANAGED_DICT |
Py_TPFLAGS_MANAGED_WEAKREF,
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.tp_new = myobj_new,
.tp_traverse = (traverseproc)myobj_traverse,
.tp_clear = (inquiry)myobj_clear,
.tp_alloc = PyType_GenericNew,
.tp_dealloc = (destructor)myobj_dealloc,
.tp_repr = (reprfunc)myobj_repr,
.tp_hash = (hashfunc)myobj_hash,
.tp_richcompare = PyBaseObject_Type.tp_richcompare,
};
A str subclass that cannot be subclassed and cannot be called
bpo-43916: Add Py_TPFLAGS_DISALLOW_INSTANTIATION type flag (GH-25721) Add a new Py_TPFLAGS_DISALLOW_INSTANTIATION type flag to disallow creating type instances: set tp_new to NULL and don't create the "__new__" key in the type dictionary. The flag is set automatically on static types if tp_base is NULL or &PyBaseObject_Type and tp_new is NULL. Use the flag on the following types: * _curses.ncurses_version type * _curses_panel.panel * _tkinter.Tcl_Obj * _tkinter.tkapp * _tkinter.tktimertoken * _xxsubinterpretersmodule.ChannelID * sys.flags type * sys.getwindowsversion() type * sys.version_info type Update MyStr example in the C API documentation to use Py_TPFLAGS_DISALLOW_INSTANTIATION. Add _PyStructSequence_InitType() function to create a structseq type with the Py_TPFLAGS_DISALLOW_INSTANTIATION flag set. type_new() calls _PyType_CheckConsistency() at exit.
2021-04-30 12:46:15 +02:00
to create instances (e.g. uses a separate factory func) using
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
:c:macro:`Py_TPFLAGS_DISALLOW_INSTANTIATION` flag::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
typedef struct {
PyUnicodeObject raw;
char *extra;
} MyStr;
static PyTypeObject MyStr_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "mymod.MyStr",
.tp_basicsize = sizeof(MyStr),
.tp_base = NULL, // set to &PyUnicode_Type in module init
gh-91118: Fix docstrings that do not honor --without-doc-strings (#31769) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-04-18 06:39:32 +03:00
.tp_doc = PyDoc_STR("my custom str"),
bpo-43916: Add Py_TPFLAGS_DISALLOW_INSTANTIATION type flag (GH-25721) Add a new Py_TPFLAGS_DISALLOW_INSTANTIATION type flag to disallow creating type instances: set tp_new to NULL and don't create the "__new__" key in the type dictionary. The flag is set automatically on static types if tp_base is NULL or &PyBaseObject_Type and tp_new is NULL. Use the flag on the following types: * _curses.ncurses_version type * _curses_panel.panel * _tkinter.Tcl_Obj * _tkinter.tkapp * _tkinter.tktimertoken * _xxsubinterpretersmodule.ChannelID * sys.flags type * sys.getwindowsversion() type * sys.version_info type Update MyStr example in the C API documentation to use Py_TPFLAGS_DISALLOW_INSTANTIATION. Add _PyStructSequence_InitType() function to create a structseq type with the Py_TPFLAGS_DISALLOW_INSTANTIATION flag set. type_new() calls _PyType_CheckConsistency() at exit.
2021-04-30 12:46:15 +02:00
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_DISALLOW_INSTANTIATION,
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
.tp_repr = (reprfunc)myobj_repr,
};
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
The simplest :ref:`static type <static-types>` with fixed-length instances::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
typedef struct {
PyObject_HEAD
} MyObject;
static PyTypeObject MyObject_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "mymod.MyObject",
};
bpo-43908: Document Static Types in the C API (GH-25710) Update also PyTypeObject structure definition in the doc.
2021-04-29 10:26:34 +02:00
The simplest :ref:`static type <static-types>` with variable-length instances::
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
typedef struct {
PyObject_VAR_HEAD
const char *data[1];
} MyObject;
static PyTypeObject MyObject_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "mymod.MyObject",
.tp_basicsize = sizeof(MyObject) - sizeof(char *),
.tp_itemsize = sizeof(char *),
};
Reference in a new issue Copy permalink