Formations — 1 037 leçons en français

Accueil › Python › Décorateurs

Décorateurs

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

Un décorateur est une fonction qui reçoit une fonction et en renvoie une autre.

import functools

def tracer(fonction):
    @functools.wraps(fonction)
    def englobante(*args, **kwargs):
        print(f"-> {fonction.__name__}")
        resultat = fonction(*args, **kwargs)
        print(f"<- {fonction.__name__}")
        return resultat
    return englobante

@tracer
def total_commande(lignes):
    return sum(lignes)

La ligne @tracer est du sucre syntaxique pour :

total_commande = tracer(total_commande)

Trois détails font la différence entre un décorateur jouet et un décorateur utilisable.

  1. *args, **kwargs — la fonction englobante doit accepter n'importe quelle signature et la transmettre telle quelle.
  2. return — sans lui, toute fonction décorée renvoie None. L'oubli est fréquent et le symptôme déroutant.
  3. @functools.wraps(fonction) — sans lui, la fonction décorée s'appelle désormais englobante et perd sa docstring.

À quoi cela sert réellement : factoriser un comportement transverse — réessayer un appel réseau, mémoriser un résultat, mesurer une durée, vérifier une autorisation — sans le recopier dans vingt fonctions ni polluer leur logique métier.

Dernier point à retenir dès maintenant : le décorateur s'exécute à la définition de la fonction, donc à l'import du module, et une seule fois. Ce qui tourne à chaque appel, c'est la fonction englobante. Un décorateur lent rend l'import lent, pas les appels — et un décorateur qui a besoin d'arguments s'écrit avec ses parenthèses, @reessayer(3), sans quoi c'est votre fonction qui part dans le premier paramètre.

Les termes à connaître

Décorateur

Une fonction qui reçoit une fonction et en renvoie une autre. @mesurer au-dessus d'un def est exactement équivalent à ma_fonction = mesurer(ma_fonction) : du sucre syntaxique, rien de plus.

Fonction englobante (*wrapper*)

La fonction définie à l'intérieur du décorateur et renvoyée à sa place. C'est elle que l'on appellera désormais ; elle ajoute un comportement avant et après, puis délègue à l'originale.

*args, **kwargs

Signature attrape-tout : *args capte les arguments positionnels, **kwargs les nommés. Indispensable dans une fonction englobante, qui doit accepter n'importe quelle signature et la transmettre intacte.

functools.wraps

Décorateur à appliquer sur la fonction englobante. Il recopie __name__, __doc__, __qualname__, __module__ et __dict__ de la fonction d'origine, et pose __wrapped__. Sans lui, la fonction décorée perd son identité.

Décorateur paramétré

Décorateur qu'on appelle avec des arguments : @reessayer(3). Il faut un niveau de plus — une fonction qui renvoie le décorateur, lequel renvoie la fonction englobante. D'où les trois def imbriqués.

Empilement

Plusieurs décorateurs sur une même fonction s'appliquent du bas vers le haut : le plus proche du def enveloppe en premier, et se retrouve le plus à l'intérieur à l'exécution.

functools.lru_cache

Décorateur de la bibliothèque standard qui mémorise les résultats d'une fonction selon ses arguments. Ceux-ci doivent être hachables — une liste en argument lève TypeError: unhashable type: 'list'.

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.