Programmation PYTHON - Zenk - Security - Repository

106
Éléments du langage
DEUXIÈME PARTIE
Decorators
Toutes les fonctions fournies dans Python sont dotées d’un docstring, ce qui est pratique
pour une documentation en ligne directe. On y renseigne sur l’objectif de la
fonction et sur le détail de ses paramètres.
Détails sur divmod par son docstring
>>> print(divmod.__doc__)
divmod(x, y) -> (div, mod)
Return the tuple ((x-x%y)/y, x%y). Invariant: div*y + mod == x.
À RETENIR Importance des docstrings
Les docstrings jouent un rôle relativement important en Python. Le chapitre 7 décrit précisément les conventions
de nommage des docstrings et le chapitre 12 leur utilisation dans le cadre des tests unitaires.
Les decorators sont issus d’un besoin de généralisation des mécanismes introduits par
les fonctions classmethod() et staticmethod() apparus à la version 2.2 de Python.
En l’occurrence, pour spécifier qu’une fonction est une méthode statique ou une méthode
de classe (voir les decorators pour les classes à la prochaine section), il est nécessaire de
procéder à un appel à l’une des primitives en passant en paramètre la fonction.
D’un point de vue plus général aux fonctions, le principe, calqué sur le modèle existant
en Java (annotations), est d’effectuer un prétraitement au moment de l’appel
d’une fonction.
Définition d’un prétraitement
>>> def decorate(function):
... function.__doc__ = 'Fonction décorée %s' % function.__doc__
... return fonction
...
>>> def a_function():
... """Ma fonction."""
... print('traitement')
...
>>> a_function = decorate(a_function)
>>> print(a_function.__doc__)
Fonction décorée Ma fonction.
La fonction decorate décore la fonction a_function de détails supplémentaires et la
liaison se fait par function=decorate(function).