https://github.com/python/cpython/commit/58942a07df8811afba9c58dc16c1aab244ccf27a
commit: 58942a07df8811afba9c58dc16c1aab244ccf27a
branch: main
author: Miro HronĨok <[email protected]>
committer: kumaraditya303 <[email protected]>
date: 2024-12-13T14:56:22+05:30
summary:

Document PyObject_SelfIter (#127861)

files:
M Doc/c-api/object.rst
M Doc/data/refcounts.dat

diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 1ae3c46bea46ea..f97ade01e67850 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -509,6 +509,12 @@ Object Protocol
    iterated.
 
 
+.. c:function:: PyObject* PyObject_SelfIter(PyObject *obj)
+
+   This is equivalent to the Python ``__iter__(self): return self`` method.
+   It is intended for :term:`iterator` types, to be used in the 
:c:member:`PyTypeObject.tp_iter` slot.
+
+
 .. c:function:: PyObject* PyObject_GetAIter(PyObject *o)
 
    This is the equivalent to the Python expression ``aiter(o)``. Takes an
diff --git a/Doc/data/refcounts.dat b/Doc/data/refcounts.dat
index 3f49c88c3cc028..a043af48ba7a05 100644
--- a/Doc/data/refcounts.dat
+++ b/Doc/data/refcounts.dat
@@ -1849,6 +1849,9 @@ PyObject_RichCompareBool:PyObject*:o1:0:
 PyObject_RichCompareBool:PyObject*:o2:0:
 PyObject_RichCompareBool:int:opid::
 
+PyObject_SelfIter:PyObject*::+1:
+PyObject_SelfIter:PyObject*:obj:0:
+
 PyObject_SetAttr:int:::
 PyObject_SetAttr:PyObject*:o:0:
 PyObject_SetAttr:PyObject*:attr_name:0:

_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]

Reply via email to