From: Miro Hrončok <miro@hroncok.cz>
Date: Fri, 13 Dec 2024 09:26:22 +0000 (+0100)
Subject: Document PyObject_SelfIter (#127861)
X-Git-Tag: v3.14.0a3~33
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=58942a07df8811afba9c58dc16c1aab244ccf27a;p=thirdparty%2FPython%2Fcpython.git

Document PyObject_SelfIter (#127861)
---

diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 1ae3c46bea46..f97ade01e678 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 3f49c88c3cc0..a043af48ba7a 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: