Iterator Protocol¶
There are two functions specifically for working with iterators.
-
int
PyIter_Check(PyObject *o)¶ - Part of the Stable ABI since version 3.8.
Return non-zero if the object o supports the iterator protocol, and
0otherwise. This function always succeeds.
-
int
PyAIter_Check(PyObject *o)¶ - Part of the Stable ABI since version 3.10.
Returns non-zero if the object ‘obj’ provides
AsyncIteratorprotocols, and0otherwise. This function always succeeds.New in version 3.10.
-
PyObject *
PyIter_Next(PyObject *o)¶ - Return value: New reference. Part of the Stable ABI.
Return the next value from the iteration o. The object must be an iterator (it is up to the caller to check this). If there are no remaining values, returns
NULLwith no exception set. If an error occurs while retrieving the item, returnsNULLand passes along the exception.
To write a loop which iterates over an iterator, the C code should look something like this:
PyObject *iterator = PyObject_GetIter(obj);
PyObject *item;
if (iterator == NULL) {
/* propagate error */
}
while ((item = PyIter_Next(iterator))) {
/* do something with item */
...
/* release reference when done */
Py_DECREF(item);
}
Py_DECREF(iterator);
if (PyErr_Occurred()) {
/* propagate error */
}
else {
/* continue doing useful work */
}
-
type
PySendResult¶ The enum value used to represent different results of
PyIter_Send().New in version 3.10.
-
PySendResult
PyIter_Send(PyObject *iter, PyObject *arg, PyObject **presult)¶ - Part of the Stable ABI since version 3.10.
Sends the arg value into the iterator iter. Returns:
PYGEN_RETURNif iterator returns. Return value is returned via presult.PYGEN_NEXTif iterator yields. Yielded value is returned via presult.PYGEN_ERRORif iterator has raised and exception. presult is set toNULL.
New in version 3.10.