bpo-40170: Always define PyIter_Check() as a function (GH-24548)

Erlend Egeberg Aasland · web-flow · commit cc54001c2eb3 · 2021-02-16T16:05:58.000+01:00
diff --git a/Doc/c-api/iter.rst b/Doc/c-api/iter.rst
@@ -9,8 +9,8 @@ There are two functions specifically for working with iterators.
 
 .. c:function:: int PyIter_Check(PyObject *o)
 
-   Return true if the object *o* supports the iterator protocol.  This
-   function always succeeds.
+   Return non-zero if the object *o* supports the iterator protocol, and ``0``
+   otherwise.  This function always succeeds.
 
 
 .. c:function:: PyObject* PyIter_Next(PyObject *o)
diff --git a/Include/abstract.h b/Include/abstract.h
@@ -324,7 +324,7 @@ PyAPI_FUNC(PyObject *) PyObject_Format(PyObject *obj,
    returns itself. */
 PyAPI_FUNC(PyObject *) PyObject_GetIter(PyObject *);
 
-/* Returns 1 if the object 'obj' provides iterator protocols, and 0 otherwise.
+/* Returns non-zero if the object 'obj' provides iterator protocols, and 0 otherwise.
 
    This function always succeeds. */
 PyAPI_FUNC(int) PyIter_Check(PyObject *);
diff --git a/Include/cpython/abstract.h b/Include/cpython/abstract.h
@@ -325,12 +325,6 @@ PyAPI_FUNC(int) PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf,
 /* Releases a Py_buffer obtained from getbuffer ParseTuple's "s*". */
 PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view);
 
-/* ==== Iterators ================================================ */
-
-#define PyIter_Check(obj) \
-    (Py_TYPE(obj)->tp_iternext != NULL && \
-     Py_TYPE(obj)->tp_iternext != &_PyObject_NextNotImplemented)
-
 /* === Sequence protocol ================================================ */
 
 /* Assume tp_as_sequence and sq_item exist and that 'i' does not
diff --git a/Misc/NEWS.d/next/Core and Builtins/2021-02-15-15-06-43.bpo-40170.ZYeSii.rst b/Misc/NEWS.d/next/Core and Builtins/2021-02-15-15-06-43.bpo-40170.ZYeSii.rst
@@ -0,0 +1,3 @@
+:c:func:`PyIter_Check` is now always declared as a function, in order to hide implementation
+details. The macro accessed :c:member:`PyTypeObject.tp_iternext` directly.
+Patch by Erlend E. Aasland.
diff --git a/Objects/abstract.c b/Objects/abstract.c
@@ -2732,12 +2732,12 @@ PyObject_GetIter(PyObject *o)
     }
 }
 
-#undef PyIter_Check
-
-int PyIter_Check(PyObject *obj)
+int
+PyIter_Check(PyObject *obj)
 {
-    return Py_TYPE(obj)->tp_iternext != NULL &&
-           Py_TYPE(obj)->tp_iternext != &_PyObject_NextNotImplemented;
+    PyTypeObject *tp = Py_TYPE(obj);
+    return (tp->tp_iternext != NULL &&
+            tp->tp_iternext != &_PyObject_NextNotImplemented);
 }
 
 /* Return next item.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+:c:func:`PyIter_Check` is now always declared as a function, in order to hide implementation
	`2`	+details. The macro accessed :c:member:`PyTypeObject.tp_iternext` directly.
	`3`	`+Patch by Erlend E. Aasland.`
Original file line number	Diff line number	Diff line change
`@@ -2732,12 +2732,12 @@ PyObject_GetIter(PyObject *o)`
`2732`	`2732`	`}`
`2733`	`2733`	`}`
`2734`	`2734`
`2735`		`-#undef PyIter_Check`
`2736`		`-`
`2737`		`-int PyIter_Check(PyObject *obj)`
	`2735`	`+int`
	`2736`	`+PyIter_Check(PyObject *obj)`
`2738`	`2737`	`{`
`2739`		`- return Py_TYPE(obj)->tp_iternext != NULL &&`
`2740`		`- Py_TYPE(obj)->tp_iternext != &_PyObject_NextNotImplemented;`
	`2738`	`+ PyTypeObject *tp = Py_TYPE(obj);`
	`2739`	`+ return (tp->tp_iternext != NULL &&`
	`2740`	`+ tp->tp_iternext != &_PyObject_NextNotImplemented);`
`2741`	`2741`	`}`
`2742`	`2742`
`2743`	`2743`	`/* Return next item.`