Les décorateurs Python : Qu’est-ce que c’est et comment l’utiliser ?

Lorsque vous écrivez du code, vous aurez parfois besoin d’étendre une fonction sans modifier directement son code. Dans cette situation, les décorateurs peuvent vous aider.

Un décorateur est un type spécial de fonction qui enveloppe une autre fonction. Ils vous permettent d’ajouter du code supplémentaire avant et après la fonction d’origine, ce qui constitue une manière élégante d’étendre les fonctions existantes.

Comment fonctionnent les décorateurs ?

Les fonctions Python sont des citoyens de première classe, ce qui signifie que vous pouvez les assigner à des variables, les passer en tant qu’arguments à d’autres fonctions et les retourner à partir de fonctions. Ces propriétés facilitent la création de décorateurs.

Une fonction décoratrice renvoie une autre fonction. Elle agit comme un méta-fonction qui ajoute des fonctionnalités supplémentaires à une fonction cible. Lorsque vous décorez une fonction, Python appelle la fonction décoratrice et passe la fonction cible en argument.

La fonction décoratrice peut effectuer toutes les actions nécessaires avant et après l’appel de la fonction cible. Elle peut également modifier le comportement de la fonction cible en renvoyant une nouvelle fonction ou en remplaçant complètement la fonction d’origine.

Création d’une fonction décoratrice

Pour créer un décorateur, définissez une fonction qui prend une fonction cible en argument et renvoie une fonction enveloppante. Cette dernière contient les fonctionnalités supplémentaires et un appel à la fonction cible.

Ici, decorator_func prend target_func comme argument. Elle renvoie wrapper_func qui appelle target_func et contient la fonctionnalité supplémentaire.

Décorer une fonction avec le décorateur

Pour appliquer le décorateur à une fonction cible, utilisez la fonction @ et placez le décorateur directement au-dessus de la définition de la fonction cible.

Ici, la syntaxe decorator_func décore ma_fonction. Ainsi, chaque fois que vous utilisez ma_fonction Python appelle decorator_func et passe ma_fonction comme argument.

Remarquez que la fonction décoratrice n’utilise pas de parenthèses ouvrantes et fermantes.

Pour plus de clarté, la fonction @ est plutôt un sucre syntaxique. Vous pouvez passer la fonction cible directement à la fonction décoratrice en tant qu’argument :

Gestion des arguments de fonction dans les décorateurs

Pour gérer les arguments de fonction à l’intérieur des décorateurs, utilisez *args et **kwargs dans la fonction enveloppante. Ceux-ci permettent au décorateur d’accepter un nombre quelconque d’arguments positionnels et de mots-clés.

Les *args et **kwargs à l’intérieur de wrapper_func garantissent que le décorateur peut gérer tous les arguments que vous transmettez à la fonction cible.

Décorateurs avec arguments

Les décorateurs peuvent également prendre leurs propres arguments. Cela vous offre une manière plus flexible de décorer les fonctions.

Les mon_decorateur prend un nombre (2) comme argument et renvoie une fonction enveloppant qui l’enveloppe. Cette fonction renvoie une fonction interne qui appelle la fonction décorée (saluer dans ce cas) un certain nombre de fois (2). C’est ainsi que :

imprimera deux fois « Bonjour, Prince ».

Utilisations pratiques des décorateurs

Vous pouvez utiliser les décorateurs à des fins très diverses, telles que la journalisation, la mise en cache, la validation des entrées et l’optimisation des performances.

Décorateur de journalisation

Vous pouvez utiliser un décorateur de journalisation pour consigner des informations sur l’exécution d’une fonction. Cela peut aider à déboguer ou à surveiller le comportement de fonctions spécifiques.

Décorateur de temporisation

Vous pouvez utiliser un décorateur de timing pour mesurer le temps d’exécution d’une fonction. C’est utile pour le profilage ou l’optimisation du code.

Appliquer les décorateurs :

Vous verrez maintenant un débogage lorsque la fonction s’exécute et un résumé du temps qu’elle prend.

Décorateur d’autorisation

Vous pouvez utiliser un décorateur d’autorisation pour vérifier si un utilisateur dispose des autorisations nécessaires pour accéder à une fonction spécifique. La plupart des frameworks web utilisent cette fonctionnalité pour ajouter une couche de sécurité. Un exemple courant est le décorateur @login_required de Django.

Ces exemples illustrent quelques cas d’utilisation courants des décorateurs. Vous pouvez créer des décorateurs à des fins diverses, en fonction de vos besoins spécifiques.

Concepts avancés des décorateurs

Les décorateurs sont faciles à mettre en œuvre et à utiliser. Mais ils sont également puissants et peuvent offrir encore plus de flexibilité et de contrôle.

Décorateurs basés sur des classes

En plus des décorateurs basés sur des fonctions, Python prend également en charge les décorateurs basés sur des classes.

Un décorateur basé sur une classe est une classe qui définit une fonction __call__ ce qui permet d’utiliser la classe comme décorateur.

Cet exemple définit une classe de décorateur. Lorsque vous décorez une fonction avec Classe de décorateur Python invoque la classe __call__ qui applique la fonctionnalité du décorateur à la fonction cible.

Les décorateurs basés sur des classes peuvent conserver un état à travers plusieurs appels en stockant des informations dans des variables d’instance. Cela permet des implémentations de décorateurs plus avancées et plus flexibles.

Imbrication et enchaînement des décorateurs

Supposons que vous ayez besoin de combiner différents types de fonctionnalités en une seule unité pour des actions connexes sur une fonction. Vous pouvez y parvenir en appliquant plusieurs décorateurs à une seule fonction.

Ici, les deux décorateur1 et décorateur2 décorer ma_fonction. Chaque fois que vous utilisez ma_fonction la fonctionnalité de décorateur1 s’applique d’abord, puis celle de décorateur2.

Un exemple courant est celui où vous devez appliquer un décorateur post-only et que login-required à une vue Django.

Les avantages des décorateurs

Les décorateurs offrent plusieurs avantages qui les rendent indispensables dans de nombreux projets Python :

• Réutilisation du code: Favorise la réutilisation du code en séparant les préoccupations transversales de la logique de base.
• Principe DRY: Adhère au principe « ne pas se répéter » en appliquant la même fonctionnalité à plusieurs fonctions sans duplication du code.
• Lisibilité et maintenabilité: Améliore la lisibilité et la maintenabilité du code en gardant la fonctionnalité principale concentrée et claire.
• Style pythonique: S’aligne sur le style Pythonique en mettant l’accent sur un code propre, expressif et lisible.

Pour ces raisons, vous devez tirer parti des décorateurs lorsque cela est possible.

Bonnes pratiques pour l’utilisation des décorateurs

Lorsque vous travaillez avec des décorateurs, vous devez suivre certaines bonnes pratiques :

• Veillez à ce que la fonctionnalité du décorateur soit axée sur une préoccupation spécifique, telle que la journalisation ou la mise en cache. Cela favorise la modularité du code et rend les décorateurs plus polyvalents.
• Rendre les décorateurs configurables en utilisant des paramètres et en évitant les valeurs codées en dur. Cela vous permet de personnaliser le comportement du décorateur lorsque vous l’appliquez à différentes fonctions.
• Fournir une description claire et concise de l’objectif du décorateur, de ses paramètres (le cas échéant) et du comportement attendu lorsqu’il est appliqué à une fonction.
• Si le décorateur a des effets secondaires, tels que la modification du comportement de la fonction ou l’introduction de dépendances supplémentaires, documenter clairement ces effets pour référence future.
• Écrivez des tests unitaires pour vos décorateurs afin de vous assurer qu’ils se comportent comme vous le souhaitez. Testez différents scénarios et cas limites afin de couvrir un large éventail de situations.

Travailler avec des fonctions en Python

Les décorateurs sont l’un des principaux domaines dans lesquels les fonctions excellent. En général, les fonctions Python sont un élément fondamental de l’organisation et de la réutilisation du code. Elles vous permettent d’encapsuler des fonctionnalités, de transmettre des données et de renvoyer des résultats.

Comprendre comment définir et utiliser les fonctions est essentiel pour une programmation Python efficace.