イテレータプロトコル (iterator protocol)¶
イテレータを扱うための固有の関数は二つあります。
-
PyObject*
PyIter_Next
(PyObject *o)¶ - Return value: New reference.
反復処理 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 */
}