Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / Python

ExitStack.enter_context() : gérer des contextes à l’exécution

Utilisez `ExitStack.enter_context()` pour choisir les contextes à l’exécution, récupérer la valeur fournie à chaque entrée et effectuer le nettoyage dans l’ordre inverse.

Version : Python 3.12

Syntaxe

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) appelle immédiatement __enter__() sur le gestionnaire de contexte synchrone cm. Si l’entrée réussit, la méthode enregistre son __exit__() et renvoie le résultat de __enter__(), c’est-à-dire la valeur que with cm as value attribuerait à value. Vous pouvez ainsi ajouter des gestionnaires dans une boucle ou sous condition. En Python 3.12, un objet qui ne respecte pas ce protocole provoque une TypeError.

Enregistrez les gestionnaires à l’intérieur de with ExitStack() as stack:. À la sortie, le nettoyage se fait dans l’ordre inverse des enregistrements (LIFO), comme avec des blocs with imbriqués. Si un appel ultérieur à __enter__() lève une exception, le __exit__() correspondant n’est pas enregistré. Les routines de sortie déjà enregistrées s’exécutent tout de même en quittant le bloc et peuvent traiter ou supprimer l’exception.

stack.close() exécute aussitôt le nettoyage en attente, sans information initiale sur une exception. Une fois la pile vidée, quitter with ne répète pas ces appels. Ne comptez pas sur le ramasse-miettes : il ne déclenche pas les routines de sortie.

Dans l’exemple, redirect_stdout() rétablit le sys.stdout précédent sans fermer le tampon StringIO, dont getvalue() peut donc encore lire le contenu. La redirection modifie le sys.stdout global, ne capture pas la sortie des sous-processus et ne convient ni au code de bibliothèque ni à la plupart des applications multithread.

Exemples

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}")

Résultat

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

La boucle enregistre deux gestionnaires. Appelé à l’intérieur de `with`, `stack.close()` rétablit d’abord le tampon externe, qui reçoit `restored after inner`, puis le flux de sortie d’origine, qui reçoit `restored after outer` et `still inside with`.

Leçons associées

  • Python · Leçon 12 · Avancé · Version : 5
  • Python · Leçon 23 · Intermédiaire · Version : 3

Sources