Protocolo Iterador

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

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.

Novo na versão 3.10.

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

Retorna o próximo valor da iteração o. O objeto deve ser um iterador (cabe ao chamador verificar isso). Se não houver valores restantes, retorna NULL sem nenhuma exceção. Se ocorrer um erro ao recuperar o item, retornará NULL e passará a 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 */
}
type PySendResult

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

Novo na versão 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.

Novo na versão 3.10.