イテレータプロトコル (iterator protocol)

イテレータを扱うための固有の関数は二つあります。

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 0 otherwise. 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 AsyncIterator protocols, and 0 otherwise. This function always succeeds.

バージョン 3.10 で追加.

PyObject *PyIter_Next(PyObject *o)
Return value: New reference. Part of the Stable ABI.

反復処理 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

The enum value used to represent different results of PyIter_Send().

バージョン 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_RETURN if iterator returns. Return value is returned via presult.

  • PYGEN_NEXT if iterator yields. Yielded value is returned via presult.

  • PYGEN_ERROR if iterator has raised and exception. presult is set to NULL.

バージョン 3.10 で追加.