Decorator

==装饰器模式==提供在不破坏函数内部结构的前提下动态添加代码的功能。

举个栗子,想要知道一个函数在执行过程中所耗费的时间。

函数A

def A(x, y):
    time.sleep(1)
    print("A")
    return x + y

使用装饰器模式包装该方法:

def calculateFunTime(fun):
    @functools.wraps(fun)
    def wraps(*args, **kwargs):
        startTime = time.time()
        fun(*args, **kwargs)
        endTime = time.time()
        print("fun %s 执行了 %.4f s" % (fun.__name__, endTime - startTime))
        return fun

    return wraps

如何使用该calculateFunTime方法,只需要在要计算的方法头加上@calculateFunTime 如下:

@calculateFunTime
def A(x, y):
    time.sleep(1)
    print("A")
    return x + y

在调用该A方法时候就可计算出该方法执行的时间:

test1 = testFun(2, 3)

打印如下:

A
fun A 执行了 1.0038 s

接下来说明一下@calculateFunTime,借助Pyhton提供的@语法，将calculateFunTime高阶函数作用在A函数的定义处即为:

@calculateFunTime
def A(x, y):
    time.sleep(1)
    print("A")
    return x + y

这样定义之后,在运行A方法时候，执行的A方法时,就会优先执行calculateFunTime方法中定义的方法.

此时执行A方法:

A = calculateFunTime(A)

由于calculateFunTime是高阶函数,允许函数作为参数传入,且函数calculateFunTime返回也为一个函数.

A方法执行时候被calculateFunTime方法替换。

由于calculateFunTime()是一个decorator，返回一个函数，所以，原来的A()函数仍然存在，只是现在同名的A变量指向了新的函数，于是调用A()将执行新函数，即在calculateFunTime()函数中返回的wraps()函数。

wraps()函数的参数定义是(*args, **kw)，因此，wraps()函数可以接受任意参数的调用。在wraps()函数内，首先打印日志，再紧接着调用原始函数。

执行顺序为
calculateFunTime->wraps

返回值依次为fun->wraps

fun方法即为传入的方法A(此处为A)。

借助高阶函数可接受函数为参数,可返回函数的功能。实现在函数运行前后动态添加逻辑代码的功能。

@functools.wraps(fun)

在calculateFunTime中添加这一行是为了避免有些依赖函数签名的代码执行就会出错。

因为函数也是对象.当使用@calculateFunTime标注了函数A 之后。函数A作为参数传给calculateFunTime。在运行函数A 时候相当于运行了calculateFunTime函数。此时函数A 依然存在，只不过函数A 指向了新的高阶函数calculateFunTime。由于函数calculateFunTime返回的函数为wraps函数。因此在调用函数A.__name __()时：

没有添加@functools.wraps(fun)
A.__name__
返回值为:
wraps

在wraps函数上添加 @functools.wraps(fun) calculateFunTime的返回函数wraps的name方法返回的值就转为了传入函数的name

添加@functools.wraps(fun)
A.__name__
返回值为:
A

Python装饰器模式

Python装饰器模式

Decorator

推荐阅读更多精彩内容