From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 13 Dec 2024 09:38:19 +0000 (+0100)
Subject: [3.12] Document PyObject_SelfIter (GH-127861) (#127899)
X-Git-Tag: v3.12.9~159
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2d317332c0b2f0696177bc4b23c55e75751d1718;p=thirdparty%2FPython%2Fcpython.git

[3.12] Document PyObject_SelfIter (GH-127861) (#127899)

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 2109b12bac90..cefd384fd35a 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -410,6 +410,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 28532620ba60..88d283aa51e9 100644
--- a/Doc/data/refcounts.dat
+++ b/Doc/data/refcounts.dat
@@ -1818,6 +1818,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: