Belles décoratrices en python

Question

Comment écrire un décorateur?

en particulier les questions comprennent: la compatibilité avec d'autres décorateurs, en conservant des signatures, etc.

Je voudrais éviter la dépendance du module décorateur si possible, mais il y avait suffisamment d'avantages, alors je considérer.

connexes

• Preserving signatures of decorated functions - question beaucoup plus précis. La réponse ici est d'utiliser le module décorateur tiers annotant le décorateur avec @ decorator.decorator

Answer 1

Écrire un bon décorateur n'est pas différent d'écrire une bonne fonction. Ce qui signifie, idéalement, utiliser docstrings et s'assurer que le décorateur est inclus dans votre cadre de test.

Vous devez absolument utiliser la bibliothèque decorator ou, mieux, le décorateur functools.wraps() dans la bibliothèque standard (depuis la version 2.5). Au-delà de cela, il est préférable de garder vos décorateurs étroitement ciblés et bien conçus. N'utilisez pas *args ou **kw si votre décorateur attend des arguments spécifiques. Et faire remplissage dans les arguments que vous attendez, donc au lieu de:

def keep_none(func): 
    def _exec(*args, **kw): 
     return None if args[0] is None else func(*args, **kw) 

    return _exec 

... l'utilisation ...

def keep_none(func): 
    """Wraps a function which expects a value as the first argument, and 
    ensures the function won't get called with *None*. If it is, this 
    will return *None*. 

    >>> def f(x): 
    ...  return x + 5 
    >>> f(1) 
    6 
    >>> f(None) is None 
    Traceback (most recent call last): 
     ... 
    TypeError: unsupported operand type(s) for +: 'NoneType' and 'int' 
    >>> f = keep_none(f) 
    >>> f(1) 
    6 
    >>> f(None) is None 
    True""" 

    @wraps(func) 
    def _exec(value, *args, **kw): 
     return None if value is None else func(value, *args, **kw) 

    return _exec 

Answer 2

Utilisez functools pour conserver le nom et doc. La signature ne sera pas conservée.

Directement à partir du doc.

>>> from functools import wraps 
>>> def my_decorator(f): 
...  @wraps(f) 
...  def wrapper(*args, **kwds): 
...   print 'Calling decorated function' 
...   return f(*args, **kwds) 
...  return wrapper 
... 
>>> @my_decorator 
... def example(): 
...  """Docstring""" 
...  print 'Called example function' 
... 
>>> example() 
Calling decorated function 
Called example function 
>>> example.__name__ 
'example' 
>>> example.__doc__ 
'Docstring'