迭代器協議

有兩個專門用於處理迭代器的函式。

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 版本中新增。