Protocolo Iterador

Novo na versão 2.2.

Existem duas funções especificas para trabalhar com iteradores.

int PyIter_Check(PyObject *o)

Retorna verdadeiro se o objeto o suporta o protocolo do iterador.

This function can return a false positive in the case of old-style classes because those classes always define a tp_iternext slot with logic that either invokes a next() method or raises a TypeError.

PyObject* PyIter_Next(PyObject *o)
Return value: New reference.

Retorna o próximo valor da iteração * o *. O objeto deve ser um iterador (depende do chamador verificar isso). Se não houver valores restantes, retorna * NULL * sem exceção definida. Se ocorrer um erro ao recuperar o item, retorna * NULL * e passa ao longo da exceção.

Para escrever um loop que itere sobre um iterador, o código C deve ser algo como isto

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