迭代器协议

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

int PyIter_Check(PyObject *o)

自 3.8 版本起，成为 稳定 ABI 的一部分。

如果对象 o 可以安全地传递给 PyIter_Next()，则返回非零值，否则返回 0。此函数始终成功。

int PyAIter_Check(PyObject *o)

自 3.10 版本起，成为 稳定 ABI 的一部分。

如果对象 o 提供 AsyncIterator 协议，则返回非零值，否则返回 0。此函数始终成功。

在 3.10 版本中添加。

PyObject *PyIter_Next(PyObject *o)

返回值：新引用。 成为 稳定 ABI 的一部分。

返回迭代器 o 中的下一个值。该对象必须是根据 PyIter_Check() 的迭代器（由调用者检查）。如果没有剩余的值，则返回 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)

自 3.10 版本起，成为 稳定 ABI 的一部分。

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

• PYGEN_RETURN 如果迭代器返回。返回值通过presult返回。

• PYGEN_NEXT 如果迭代器生成。生成的返回值通过presult返回。

• PYGEN_ERROR 如果迭代器引发异常。presult 设置为 NULL。

在 3.10 版本中添加。