Skip to content

Commit 58942a0

Browse files
authored
Document PyObject_SelfIter (#127861)
1 parent ba2d2fd commit 58942a0

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

Doc/c-api/object.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,12 @@ Object Protocol
509509
iterated.
510510
511511
512+
.. c:function:: PyObject* PyObject_SelfIter(PyObject *obj)
513+
514+
This is equivalent to the Python ``__iter__(self): return self`` method.
515+
It is intended for :term:`iterator` types, to be used in the :c:member:`PyTypeObject.tp_iter` slot.
516+
517+
512518
.. c:function:: PyObject* PyObject_GetAIter(PyObject *o)
513519
514520
This is the equivalent to the Python expression ``aiter(o)``. Takes an

Doc/data/refcounts.dat

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1849,6 +1849,9 @@ PyObject_RichCompareBool:PyObject*:o1:0:
18491849
PyObject_RichCompareBool:PyObject*:o2:0:
18501850
PyObject_RichCompareBool:int:opid::
18511851

1852+
PyObject_SelfIter:PyObject*::+1:
1853+
PyObject_SelfIter:PyObject*:obj:0:
1854+
18521855
PyObject_SetAttr:int:::
18531856
PyObject_SetAttr:PyObject*:o:0:
18541857
PyObject_SetAttr:PyObject*:attr_name:0:

0 commit comments

Comments
 (0)