Iterator Protocol¶

There are two functions specifically for working with iterators.

intPyIter_Check(PyObject *o)¶

Return true if the objecto supports the iterator protocol.

PyObject*PyIter_Next(PyObject *o)¶

Return value: New reference.

Return the next value from the iterationo. The object must be an iterator(it is up to the caller to check this). If there are no remaining values,returnsNULL with no exception set. If an error occurs while retrievingthe item, returnsNULL and passes along the exception.

To write a loop which iterates over an iterator, the C code should looksomething like this:

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 */}