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

CKTIS / Python

ExitStack.enter_context(): gerir contextos dinamicamente

Use `ExitStack.enter_context()` para decidir em tempo de execução em que contextos entrar, obter o valor de cada entrada e fazer a limpeza pela ordem inversa.

Versão: Python 3.12

Sintaxe

with contextlib.ExitStack() as stack:
    value = stack.enter_context(cm)
    # Use value here.
    stack.close()  # Optional: run cleanup before leaving the block.

contextlib.ExitStack.enter_context(cm) chama imediatamente __enter__() do gestor de contexto síncrono cm. Se a entrada for bem-sucedida, regista o respetivo __exit__() e devolve o resultado de __enter__(), ou seja, o valor que with cm as value atribuiria a value. Assim, pode adicionar gestores num ciclo ou de forma condicional. Em Python 3.12, passar um objeto que não suporta este protocolo provoca um TypeError.

Registe os gestores dentro de with ExitStack() as stack:. À saída, a limpeza faz-se pela ordem inversa do registo (LIFO), como em blocos with encaixados. Se um __enter__() posterior lançar uma exceção, o respetivo __exit__() não é registado, mas as rotinas de saída já registadas continuam a ser executadas à saída do bloco e podem tratar ou suprimir a exceção.

stack.close() executa de imediato a limpeza pendente, começando sem informação sobre exceções. Uma vez esvaziada a pilha, sair de with não repete essas chamadas. Não conte com a recolha de lixo: esta não executa as rotinas de saída da pilha.

No exemplo, redirect_stdout() repõe o sys.stdout anterior sem fechar o buffer StringIO, pelo que ainda é possível lê-lo com getvalue(). O redirecionamento altera o sys.stdout global, não captura a saída de subprocessos e não é adequado para código de bibliotecas nem para a maioria das aplicações com várias threads.

Exemplos

from contextlib import ExitStack, contextmanager, redirect_stdout
from io import StringIO


@contextmanager
def capture(label):
    try:
        with redirect_stdout(StringIO()) as buffer:
            yield buffer
    finally:
        print(f"restored after {label}")


captured = {}
with ExitStack() as stack:
    for label in ("outer", "inner"):
        captured[label] = stack.enter_context(capture(label))
        print(label)

    stack.close()
    print("still inside with")

for label, buffer in captured.items():
    print(f"{label}: {buffer.getvalue()!r}")

Resultado

restored after outer
still inside with
outer: 'outer\nrestored after inner\n'
inner: 'inner\n'

O ciclo regista dois gestores. Ao chamar `stack.close()` dentro de `with`, é reposto primeiro o buffer exterior, que recebe `restored after inner`, e depois o fluxo de saída original, que recebe `restored after outer` e `still inside with`.

Lições relacionadas

  • Python · Lição 12 · Avançado · Versão: 5
  • Python · Lição 23 · Intermédio · Versão: 3

Fontes