Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Python

StopIteration — esgotamento do iterador

StopIteration assinala o esgotamento de um iterador durante next(). O seu atributo value pode conter o valor devolvido por um gerador. Terminar um gerador com return é diferente de deixar que um StopIteration explicitamente lançado escape do seu código.

Versão: Python 3.14; repository image, production runtime not attested

Sintaxe

StopIteration(*args)
try:
    item = next(iterator)
except StopIteration as exc:
    result = exc.value

StopIteration assinala que um iterador não tem mais elementos. next(iterator) chama iterator.__next__(); quando o iterador se esgota, lança a exceção, a menos que tenha sido fornecido um valor predefinido.

next(iterator, default) devolve o próximo elemento, se estiver disponível. Só quando o iterador está esgotado é que devolve default em vez de lançar StopIteration. Escolha um valor predefinido que se consiga distinguir dos elementos válidos. Se tratar a exceção manualmente, limite o bloco try à obtenção de um elemento.

StopIteration(value) guarda o argumento em value, que por predefinição é None. Terminar um gerador com return result disponibiliza result como StopIteration.value, e não como outro elemento produzido por yield.

Dentro de um gerador, use return, não raise StopIteration. Se um StopIteration lançado direta ou indiretamente escapar do seu código, o Python converte-o em RuntimeError, mantendo a exceção original como causa. A iteração assíncrona termina com o StopAsyncIteration, que é distinto.

Exemplos

def numbers():
    yield 7
    return 99

iterator = numbers()
print(next(iterator))
try:
    next(iterator)
except StopIteration as exc:
    print(type(exc).__name__, exc.value)
print(next(iterator, "END"))

Resultado

7
StopIteration 99
END

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes