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

バージョン 2.2 で新たに追加された仕様です。

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

int PyIter_Check( PyObject *o): o がイテレータプロトコルをサポートする場合に真を返します。

PyObject* PyIter_Next( PyObject *o): 戻り値: 新たな参照.
反復処理 o における次の値を返します。オブジェクトがイテレータの場合、この関数は反復処理における次の値を取り出します。要素が何も残っていない場合には例外がセットされていない状態で NULL を返します。オブジェクトがイテレータでない場合には TypeError を送出します。要素を取り出す際にエラーが生じると NULL を返し、発生した例外を送出します。

イテレータの返す要素にわたって反復処理を行うループを書くと、 C のコードは以下のようになるはずです:

PyObject *iterator = PyObject_GetIter(obj);
PyObject *item;

if (iterator == NULL) {
    /* エラーの伝播処理をここに書く */
}

while (item = PyIter_Next(iterator)) {
    /* 取り出した要素で何らかの処理を行う */
    ...
    /* 終わったら参照を放棄する */
    Py_DECREF(item);
}

Py_DECREF(iterator);

if (PyErr_Occurred()) {
    /* エラーの伝播処理をここに書く */
}
else {
    /* 別の処理を続ける */
}

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。