Formations — 1 037 leçons en français

Accueil › Python › Gestionnaires de contexte

Gestionnaires de contexte

Itérateurs, générateurs et décorateursavance

with garantit qu'une action de sortie aura lieu, quoi qu'il arrive dans le bloc.

with open("commandes.csv", encoding="utf-8") as f:
    traiter(f)              # le fichier est fermé à la sortie du bloc,
                            # même si traiter() lève une exception

Un objet est utilisable avec with s'il possède deux méthodes :

class Chronometre:
    def __enter__(self):
        self.debut = time.perf_counter()
        return self                      # c'est ce que reçoit le « as »

    def __exit__(self, type_exc, valeur, trace):
        self.duree = time.perf_counter() - self.debut
        # on ne renvoie rien : une exception éventuelle continue sa route

with Chronometre() as c:
    recalculer_stock()
print(f"{c.duree:.3f} s")

__exit__ est appelé dans tous les cas : fin normale, return, break, ou exception. Il reçoit alors le type, la valeur et la trace de l'exception — ou trois None s'il n'y en a pas.

Un seul point mérite d'être mémorisé : si __exit__ renvoie une valeur vraie, l'exception est étouffée. C'est rarement ce qu'on veut. Par défaut, ne renvoyez rien.

L'intérêt dépasse largement les fichiers : un verrou qu'on relâche, une connexion qu'on rend au pool, une transaction qu'on annule, un répertoire temporaire qu'on supprime. Chaque fois que deux actions doivent aller par paire, le with empêche d'oublier la seconde — y compris sur le chemin d'erreur, celui qu'on teste le moins. Notez aussi que as ne reçoit pas le gestionnaire lui-même, mais la valeur que renvoie son __enter__ : beaucoup de classes renvoient self, d'où la confusion.

La version courte, pour un besoin simple :

from contextlib import contextmanager

@contextmanager
def chronometre(libelle):
    debut = time.perf_counter()
    try:
        yield
    finally:
        print(f"{libelle} : {time.perf_counter() - debut:.3f} s")

Les termes à connaître

Gestionnaire de contexte

Un objet utilisable avec with, parce qu'il possède __enter__ et __exit__. Il garantit qu'une action de sortie aura lieu — fermeture, libération, annulation — quoi qu'il arrive dans le bloc.

__enter__

Appelé à l'entrée du bloc. Ce qu'il renvoie est la valeur liée par as : c'est pour cela que with open(...) as f donne un fichier et non le gestionnaire.

__exit__

Appelé à la sortie du bloc, toujours : fin normale, return, break ou exception. Il reçoit trois arguments décrivant l'exception en cours, ou trois None s'il n'y en a pas.

Suppression d'exception

Si __exit__ renvoie une valeur vraie, l'exception en cours est étouffée et le programme continue après le bloc. Renvoyer une valeur fausse — ou rien — la laisse se propager. C'est le comportement voulu dans la quasi-totalité des cas.

contextlib.contextmanager

Décorateur qui transforme une fonction génératrice en gestionnaire de contexte : ce qui précède le yield est l'entrée, ce qui suit est la sortie. La forme la plus courte pour un gestionnaire simple.

contextlib.suppress

Gestionnaire qui ignore les exceptions des types indiqués. with suppress(FileNotFoundError): remplace un try/except/pass et dit explicitement ce qu'on accepte d'ignorer.

contextlib.ExitStack

Permet d'empiler un nombre variable de gestionnaires, décidé à l'exécution, et garantit leur sortie dans l'ordre inverse. La réponse quand on ne connaît pas d'avance combien de ressources on ouvrira.

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.