Python décorateur de manutention docstrings

J'ai un problème à l'aide de docstrings avec des décorateurs. Soit l'exemple suivant:

def decorator(f):
    def _decorator():
        print 'decorator active'
        f()
    return _decorator

@decorator
def foo():
    '''the magic foo function'''
    print 'this is function foo'

help(foo)

Maintenant l'aider à ne pas me montrer la docstring de foo comme prévu, il montre:

Help on function _decorator in module __main__:

_decorator()

Sans le décorateur, l'aide est correct:

Help on function foo in module __main__:

foo()
    the magic foo function

Je sais que la fonction foo est enveloppé par le décorateur, et donc la fonction de l'objet n'est pas la fonction foo plus. Mais ce qui est une belle solution pour obtenir la docstring (et l'aide) comme prévu?

InformationsquelleAutor Günther Jena | 2009-11-23

79

Utilisation functools.wraps() de mettre à jour les attributs de la décoratrice:
```
from functools import wraps

def decorator(f):
    @wraps(f)
    def _decorator():
        print 'decorator active'
        f()
    return _decorator

@decorator
def foo():
    '''the magic foo function'''
    print 'this is function foo'

help(foo)
```
Également voir le La documentation de la Bibliothèque Standard pour functools.
- Cela ne fonctionne pas si foo prend tous les arguments - ils remplacés par ce que le _decorator utilise. C'est un problème surtout quand vous voulez votre décorateur à prendre *args, **kwds. Je n'ai jamais été en mesure de trouver un moyen d'obtenir la docstring corriger à l'aide de functools.wraps.
- Griffiths: La docstring sera encore correcte, même si foo des arguments. Cependant, help(foo) affiche la liste des paramètres de l' _decorator, puisqu'il remplace le foo fonction. Il n'y a pas de bonne façon de contourner ce problème si vous écrivez des décorateurs qui prennent des arguments arbitraires à l'aide de *args, **kwargs, mais pour moi, le point important est que la docstring est conservé intact. Détails des paramètres pourrait toujours être spécifiée dans la docstring pour plus de clarté.
- Merci pour les informations supplémentaires. J'ai récemment été à défaut d'obtenir l'aide de la description correcte pour décorées fonctions -, il semble un assez mauvais état des affaires, mais je comprends la difficulté que l'décorées fonction pourrait avoir une toute autre signature. Toujours, il doit y avoir un moyen... 🙂
- Il y a un moyen de le faire. Le décorateur le module pypi.python.org/pypi/decorator le fait en utilisant une astuce. L'astuce consiste à reconstruire le décorateur de la signature et de l'exécution exec sur elle. Vous pouvez trouver l'astuce dans la ligne 118 decorator.py. Je pense cependant que cette approche est extrême.
- Il semble que functools.s'enroule ne activer help() pour fonctionner correctement maintenant. J'ai du mal à trouver lorsque cela a changé, mais je suis toujours à l'aide de Python 2.7. Heureux jour!
- Comment puis-je utiliser cette méthode avec la docorator @classmethod?
- Ce sujet de mettre une ligne comme _decorator.__doc__ += '\n(decorated by <decorator description>)' juste avant return _decorator? Semble que ce serait faire de la docstring plus instructif, mais je n'ai pas vu que, si vous vous demandez si il y a une raison de ne pas le faire.
InformationsquelleAutor Pär Wieslander
16

J'ai trouvé une solution, mais ne sais pas si c'est vraiment gentil:
```
def decorator(f):
    def _decorator():
        print 'decorator active'
        f()
    _decorator.__name__=f.__name__
    _decorator.__doc__=f.__doc__
    return _decorator
```
La partie avec _decorator.__name__=f.__name__ semble un peu hideux... Qu'en pensez-vous?
- En fait, c'est (presque ?) exactement ce que functools.roulés de faire 🙂
- Il n'a pas l'air horrible pour moi. Il dit exactement ce que vous voulez dire. "Je veux le nom de cette fonction pour être "myfunction" au lieu de "_decorator'."
- vous ne devriez pas ré-inventer la roue, surtout quand il n'y est une fonction de la bibliothèque standard qui le fait, bien testé, entretenus et documenté
- Je ne peut pas aller de pair avec @Azat Ibrakov; je lui préfère toujours clairement à la lecture de la solution qui ne dépend pas de tout (aussi éventuellement changer) les bibliothèques. Donc, j'aime vraiment beaucoup cette simple et approche (+1).
InformationsquelleAutor Günther Jena
2

Prendre un coup d'oeil à functools.wraps: http://docs.python.org/library/functools.html

InformationsquelleAutor Mark Byers

Vous devez vous connecter pour publier un commentaire.