Python décorateur manipulant docstrings

J'ai un problème en utilisant docstrings avec des décorateurs. Compte tenu de l'exemple suivant:Python décorateur manipulant docstrings

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'aide ne me montre pas le docstring de foo comme prévu, il montre:

Help on function _decorator in module __main__: 

_decorator()

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

Help on function foo in module __main__: 

foo() 
    the magic foo function

Je sais, que la fonction foo est enveloppée par le décorateur, et donc l'objet fonction n'est plus la fonction foo. Mais quelle est la bonne solution pour obtenir la docstring (et l'aide) comme prévu?

Source

2009-11-23 Günther Jena

Utilisez functools.wraps() pour mettre à jour les attributs du décorateur:

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)

Voir aussi la Standard Library documentation pour functools.

Source

2009-11-23 12:33:04

Cela ne fonctionne pas si 'foo' prend n'importe quel argument - ils sont remplacés par tout ce que' _decorator' utilise. C'est un problème surtout quand vous voulez que votre décorateur prenne '* args, ** kwds'. Je n'ai jamais réussi à trouver un moyen d'obtenir la docstring correcte en utilisant 'functools.wraps'. –

@Scott Griffiths: La docstring sera toujours correcte même si 'foo' prend des arguments. Cependant, 'help (foo)' affichera la liste des paramètres de '_decorator', car elle remplace réellement la fonction' foo'. Il n'y a pas de bonne solution si vous écrivez des décorateurs qui prennent des arguments arbitraires en utilisant '* args, ** kwargs', mais pour moi, le point important est que la docstring reste intacte. Les détails des paramètres peuvent toujours être spécifiés dans la docstring pour plus de clarté. –

Merci pour les informations supplémentaires. J'ai récemment échoué à obtenir la description de l'aide correcte pour les fonctions décorées - cela semble être un mauvais état de choses, mais je comprends la difficulté car la fonction décorée pourrait avoir une signature complètement différente. Pourtant, il doit y avoir un moyen ... :) –

J'ai trouvé une solution, mais je ne sais pas si c'est vraiment agréable:

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 ... Que pensez-vous?

Source

2009-11-23 12:31:32

En fait, c'est (presque?) Exactement ce que font functools.wraps :) – thomas

Il ne semble pas affreux pour moi. Il dit exactement ce que vous voulez dire. "Je veux que le nom de cette fonction soit 'myfunction' au lieu de '_decorator'." – jcdyer

Jetez un oeil à functools.wraps: http://docs.python.org/library/functools.html

Source

2009-11-23 12:34:52

-5

Il est probablement un peu vieux maintenant, mais voici comment vous le faites. Assurez-vous que @decorator est dentelés la même ligne que def decorator(f):

from functools import wraps 

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

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

help(foo)

Source

2012-06-12 15:00:34 gazza

Cela fait écho à la réponse déjà acceptée. –

Répondre

Questions connexes