イテレータプロトコル
イテレータを操作するための2つの関数があります。
- int PyIter_Check(PyObject *o)
- オブジェクト o がイテレータプロトコルをサポートしている場合はゼロ以外を返し、それ以外の場合は
0
を返します。 この関数は常に成功します。
- int PyAIter_Check(PyObject *o)
オブジェクト 'obj'が
AsyncIterator
プロトコルを提供する場合はゼロ以外を返し、それ以外の場合は0
を返します。 この関数は常に成功します。バージョン3.10の新機能。
- 反復 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の新機能。