From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 13 Dec 2024 09:37:28 +0000 (+0100)
Subject: [3.13] Document PyObject_SelfIter (GH-127861) (#127898)
X-Git-Tag: v3.13.2~202
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6023b3b01e286d5b4273af7ef003dd1fa2c5fb0a;p=thirdparty%2FPython%2Fcpython.git

[3.13] Document PyObject_SelfIter (GH-127861) (#127898)

Document PyObject_SelfIter (GH-127861)
(cherry picked from commit 58942a07df8811afba9c58dc16c1aab244ccf27a)

Co-authored-by: Miro Hrončok <miro@hroncok.cz>
---

diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 1e822fad13aa..3f0fd905da50 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 e5bb0bf78f7a..99f4d59b558e 100644
--- a/Doc/data/refcounts.dat
+++ b/Doc/data/refcounts.dat
@@ -1836,6 +1836,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: