迭代器协议

有两个函数专门用于处理迭代器。

int PyIter_Check(PyObject *o)

如果对象 o 支持迭代器协议，则返回非零值，否则返回 0。此功能总是成功。

int PyAIter_Check(PyObject *o): 如果对象 'obj' 提供 AsyncIterator 协议，则返回非零值，否则返回 0。此功能总是成功。

3.10 版中的新功能。

PyObject *PyIter_Next(PyObject *o)

返回迭代 o 的下一个值。该对象必须是一个迭代器（由调用者来检查）。如果没有剩余值，则返回 NULL 且未设置异常。如果检索项目时发生错误，则返回 NULL 并传递异常。

要编写一个遍历迭代器的循环，C 代码应如下所示：

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: 用于表示 PyIter_Send() 不同结果的枚举值。

3.10 版中的新功能。

PySendResult PyIter_Send(PyObject *iter, PyObject *arg, PyObject **presult)

将 arg 值发送到迭代器 iter。返回：

PYGEN_RETURN 如果迭代器返回。返回值通过 presult 返回。
PYGEN_NEXT 如果迭代器产生。产生的值通过 presult 返回。
PYGEN_ERROR 如果迭代器引发异常。 presult 设置为 NULL。

3.10 版中的新功能。

迭代器协议 — Python 文档

迭代器协议