Declare tp_iteritem and iteritemfunc private by adding _ prefix to names

Author: markshannon

Doc/c-api/typeobj.rst

@@ -147,8 +147,6 @@ Quick Reference
    +------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
    | :c:member:`~PyTypeObject.tp_vectorcall`        | :c:type:`vectorcallfunc`          |                   |   |   |   |   |
    +------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
-   | [:c:member:`~PyTypeObject.tp_iteritem`]        | opaque function pointer           |                   |   |   |   |   |
-   +------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
    | [:c:member:`~PyTypeObject.tp_watched`]         | unsigned char                     |                   |   |   |   |   |
    +------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
 
@@ -2552,13 +2550,6 @@ and :c:data:`PyType_Type` effectively act as defaults.)
    .. versionadded:: 3.12
 
 
-.. c:member:: function_pointer PyTypeObject.tp_iteritem
-
-   Internal. Do not use.
-
-   .. versionadded:: 3.15
-
-
 .. _static-types:
 
 Static Types

Doc/conf.py

@@ -179,8 +179,6 @@
     ('c:type', 'unsigned __int64'),
     ('c:type', 'double'),
     ('c:type', '_Float16'),
-    # Opaque C types
-    ('c:type', 'function_pointer'),
     # Standard C structures
     ('c:struct', 'in6_addr'),
     ('c:struct', 'in_addr'),

Include/cpython/object.h

@@ -241,7 +241,7 @@ struct _typeobject {
      * Otherwise, limited to MAX_VERSIONS_PER_CLASS (defined elsewhere).
      */
     uint16_t tp_versions_used;
-    iteritemfunc tp_iteritem; /* Virtual iterator next function */
+    _Py_iteritemfunc _tp_iteritem; /* Virtual iterator next function */
 };
 
 #define _Py_ATTR_CACHE_UNUSED (30000)  // (see tp_versions_used)

Include/object.h

@@ -310,7 +310,7 @@ typedef struct _py_object_index_pair {
     PyObject *object;
     Py_ssize_t index;
 } _PyObjectIndexPair;
-typedef _PyObjectIndexPair (*iteritemfunc) (PyObject *, Py_ssize_t index);
+typedef _PyObjectIndexPair (*_Py_iteritemfunc) (PyObject *, Py_ssize_t index);
 typedef PyObject *(*descrgetfunc) (PyObject *, PyObject *, PyObject *);
 typedef int (*descrsetfunc) (PyObject *, PyObject *, PyObject *);
 typedef int (*initproc)(PyObject *, PyObject *, PyObject *);

Modules/_testinternalcapi/test_cases.c.h

@@ -3260,7 +3260,7 @@ PyTypeObject PyBytes_Type = {
     bytes_new,                                  /* tp_new */
     PyObject_Free,                              /* tp_free */
     .tp_version_tag = _Py_TYPE_VERSION_BYTES,
-    .tp_iteritem = bytes_iteritem,
+    ._tp_iteritem = bytes_iteritem,
 };
 
 void

Objects/bytesobject.c

@@ -3970,7 +3970,7 @@ PyTypeObject PyList_Type = {
     PyObject_GC_Del,                            /* tp_free */
     .tp_vectorcall = list_vectorcall,
     .tp_version_tag = _Py_TYPE_VERSION_LIST,
-    .tp_iteritem = list_iteritem,
+    ._tp_iteritem = list_iteritem,
 };
 
 /*********************** List Iterator **************************/

Objects/listobject.c

@@ -1011,7 +1011,7 @@ PyTypeObject PyTuple_Type = {
     PyObject_GC_Del,                            /* tp_free */
     .tp_vectorcall = tuple_vectorcall,
     .tp_version_tag = _Py_TYPE_VERSION_TUPLE,
-    .tp_iteritem = tuple_iteritem,
+    ._tp_iteritem = tuple_iteritem,
 };
 
 /* The following function breaks the notion that tuples are immutable:

Objects/tupleobject.c

@@ -14061,7 +14061,7 @@ PyTypeObject PyUnicode_Type = {
     unicode_new,                  /* tp_new */
     PyObject_Free,                /* tp_free */
     .tp_vectorcall = unicode_vectorcall,
-    .tp_iteritem = unicode_iteritem,
+    ._tp_iteritem = unicode_iteritem,
 };
 
 /* Initialize the Unicode implementation */

Objects/unicodeobject.c

@@ -3634,7 +3634,7 @@ dummy_func(
 
         op(_GUARD_ITER_VIRTUAL, (iterable -- iterable)) {
             PyTypeObject *tp = Py_TYPE(PyStackRef_AsPyObjectBorrow(iterable));
-            EXIT_IF(tp->tp_iteritem == NULL);
+            EXIT_IF(tp->_tp_iteritem == NULL);
             STAT_INC(GET_ITER, hit);
         }
 
@@ -3712,13 +3712,13 @@ dummy_func(
 
         op(_GUARD_NOS_ITER_VIRTUAL, (iter, null_or_index -- iter, null_or_index)) {
             PyObject *iter_o = PyStackRef_AsPyObjectBorrow(iter);
-            EXIT_IF(Py_TYPE(iter_o)->tp_iteritem == NULL);
+            EXIT_IF(Py_TYPE(iter_o)->_tp_iteritem == NULL);
         }
 
         replaced op(_FOR_ITER_VIRTUAL, (iter, null_or_index -- iter, null_or_index, next)) {
             PyObject *iter_o = PyStackRef_AsPyObjectBorrow(iter);
             Py_ssize_t index = PyStackRef_UntagInt(null_or_index);
-            _PyObjectIndexPair next_index = Py_TYPE(iter_o)->tp_iteritem(iter_o, index);
+            _PyObjectIndexPair next_index = Py_TYPE(iter_o)->_tp_iteritem(iter_o, index);
             PyObject *next_o = next_index.object;
             index = next_index.index;
             if (next_o == NULL) {
@@ -3741,7 +3741,7 @@ dummy_func(
         op(_FOR_ITER_VIRTUAL_TIER_TWO, (iter, null_or_index -- iter, null_or_index, next)) {
             PyObject *iter_o = PyStackRef_AsPyObjectBorrow(iter);
             Py_ssize_t index = PyStackRef_UntagInt(null_or_index);
-            _PyObjectIndexPair next_index = Py_TYPE(iter_o)->tp_iteritem(iter_o, index);
+            _PyObjectIndexPair next_index = Py_TYPE(iter_o)->_tp_iteritem(iter_o, index);
             PyObject *next_o = next_index.object;
             index = next_index.index;
             if (next_o == NULL) {