保留签名和用户定义属性的Python装饰器

Question

我有一个装饰my_func的简单装饰器my_decorator。

def my_decorator(func):
    def wrapper(*args, **kwargs):
        return func(*args, **kwargs)
    wrapper._decorator_name_ = 'my_decorator'
    return wrapper

@my_decorator
def my_func(x):
    print('hello %s'%x)

my_func._decorator_name_
'my_decorator'

在此之前，一切正常，但我看不到函数的实际签名。

my_func?
Signature: my_func(*args, **kwargs)
Docstring: <no docstring>
File:      ~/<ipython-input-2-e4c91999ef66>
Type:      function

如果我用python的decorator.decorator装饰我的装饰器，我可以看到我的函数的签名，但是我不能拥有我定义的新属性。

import decorator

@decorator.decorator
def my_decorator(func):
    def wrapper(*args, **kwargs):
        return func(*args, **kwargs)
    wrapper._decorator_name_ = 'my_decorator'
    return wrapper

@my_decorator
def my_func(x):
    print('hello %s'%x)

my_func?
Signature: my_func(x)
Docstring: <no docstring>
File:      ~/<ipython-input-8-934f46134434>
Type:      function

my_func._decorator_name_
---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
<ipython-input-10-7e3ef4ebfc8b> in <module>()
----> 1 my_func._decorator_name_

AttributeError: 'function' object has no attribute '_decorator_name_'

在python2.7中怎样才能同时拥有这两个功能呢？

Answer 1

对于Python3，在标准库中使用functools.wraps：

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        return func(*args, **kwargs)
    wrapper._decorator_name_ = 'my_decorator'
    return wrapper

@my_decorator
def my_func(x):
    print('hello %s'%x)

print(my_func._decorator_name_)

Answer 2

​

​

@decorator.decorator返回一个函数，该函数接受另一个函数作为输入。在本例中，您需要返回函数上的属性。

要让它在Python 2.7上工作，您只需进行一些调整

import decorator

def my_dec2(func):
    @decorator.decorator
    def my_decorator(func, *args, **kwargs):
        print("this was called")
        return func(*args, **kwargs)

    test = my_decorator(func)
    test._decorator_name_ = "my_decorator"
    return test

@my_dec2
def my_func(x):
    print('hello %s'%x)


my_func(2)
print(my_func._decorator_name_)

然后当你测试它工作的时候

In [1]: my_func?
Signature: my_func(x)
Docstring: <no docstring>
File:      ~/Desktop/payu/projects/decotest/decos.py
Type:      function

In [2]: my_func._decorator_name_
Out[2]: 'my_decorator'

Answer 3

如果你想以某种方式改变你的函数的行为，你只需要定义一个wrapper函数。因此，如果你真的只想在不改变函数行为的情况下向函数添加一些属性，你可以简单地执行以下操作。

def my_decorator(func):
    func._decorator_name_ = 'my_decorator'
    return func

在更复杂的情况下，你需要一个wrapper，我建议遵循accepted answer for this question，它解释了如何创建一个行为与另一个相同的函数，但具有自定义的签名。使用inspect.getargspec，您可以从my_func恢复签名，并将其转置到您的wrapper。