一文彻底读懂Python装饰器
装饰器主要用途是：
不修改函数源码的前提下，添加额外的功能。
如果你有Java开发经验，你会发现，Python中的装饰器其实就类似于Java的注解。好的，废话不多说，进入正题。
我们假想如下一个场景：
测试一个现有的函数的执行耗时，要求是不能修改原始函数块内代码。
1 探索无装饰器的场景实现
1.1 简单初版实现
对于如上需求，我们很轻松会想到一个方案：将函数及其相关参数对象传入一个新定义的函数，在新定义的函数做耗时测试，具体如下：
import time def target_func(a, b, c): time.sleep(2) return a**b + c def test_time(func, a, b, c): t = time.time() out = func(a, b, c) print(time.time() - t) return out test_time(target_func, 99, 199, 9)
1.2 升级版实现
上面这种方案还存在一些缺点：参数不灵活，只能测试有3个参数的函数。因此，升级版如下：
def test_time(func, *args, **kwargs): t = time.time() out = func(*args, **kwargs) print(time.time() - t) return out test_time(target_func, 99, 199, 9)
1.3 进阶版实现
上面的封装还是存在缺点，即破坏了用户的开发思路。用户设计代码时，已经将target_func作为某项功能实现对待。如果转而去执行test_time函数，那么需要传入target_func函数对象作为test_time的参数。在某种程度上说，已经破坏了代码。因此，最好让使用者无感植入代码。具体实现如下：
import time def test_time(func): def wrapper(*args, **kwargs): t = time.time() out = func(*args, **kwargs) print(time.time() - t) return out return wrapper # 提前封装好函数 my_func = test_time(target_func) my_func(99, 199, 9)
倒数第二行对函数做了装饰，经过装饰后的函数可以直接调用，并且调用者是无感的。
2 使用装饰器
2.1 无参装饰器
2.1.1 直接使用@符号
其实1.3小节的进阶版实现就已经是一个装饰器了，读者可能注意到，虽然说1.3中的最后一行代码是无感调用的，但是其实倒数第二行手动去对目标函数做了封装。这一行代码无疑非常影响代码的极简风格，因此，在Python中，这一行代码可以直接使用装饰器来取代：
import time def test_time(func): def wrapper(*args, **kwargs): t = time.time() out = func(*args, **kwargs) print(time.time() - t) return out return wrapper @test_time def target_func(a, b, c): time.sleep(2) return a**b + c target_func(99, 199, 9)
仔细看target_func函数，可以看到，在函数定义前加了装饰器@test_time，这一行等价于：
在执行target_func函数之前，Python解释器会先执行test_time函数，并将返回的函数对象在原来执行的位置通过“偷梁换柱”替换掉。
简而言之，2.1.1中的代码与1.3中的代码是等价的。
2.1.2 使用functools.wraps
2.1.1中的wrapper函数其实有个非常大的问题！即原始函数被偷梁换柱了。在一些业务或者框架中，如果底层需要对函数进行判断，那么将会引来一个BUG，我们做个测试：
import time def test_time(func): def wrapper(*args, **kwargs): ''' 这里是wrapper函数的注释文档 ''' t = time.time() out = func(*args, **kwargs) print(time.time() - t) return out return wrapper @test_time def target_func(a, b, c): ''' 这里是target_func函数的注释文档 ''' time.sleep(2) return a**b + c print(target_func.__name__, target_func.__doc__)
输出结果如下：
wrapper 这里是wrapper函数的注释文档
可以看到，明显当前target_func函数已经不是当年那个target_func函数。为了解决这个问题，python中引入了装饰器functools.wraps，只需在wrapper函数中加入functools.wraps装饰器即可：
import time from functools import wraps def test_time(func): @wraps(func) def wrapper(*args, **kwargs): ''' 这里是wrapper函数的注释文档 ''' t = time.time() out = func(*args, **kwargs) print(time.time() - t) return out return wrapper @test_time def target_func(a, b, c): ''' 这里是target_func函数的注释文档 ''' time.sleep(2) return a**b + c print(target_func.__name__, target_func.__doc__)
输出结果如下：
target_func 这里是target_func函数的注释文档
2.2 有参数装饰器
2.1中使用装饰器时，没有提供额外的参数，有时在装饰器中不仅仅需要目标函数对象，也需要额外的其他参数。
import time def test_time(msg): def test_time_inner(func): @wraps(func) def wrapper(*args, **kwargs): print("before func:", msg) t = time.time() out = func(*args, **kwargs) print(time.time() - t) return out return wrapper return test_time_inner @test_time("测试信息") def target_func(a, b, c): time.sleep(2) return a**b + c target_func(99, 199, 9)
输出结果如下：
before func: 测试信息 2.009385585784912
可以看到，如果需要给装饰器传入参数，那么需要将装饰器封装为3层函数。其中：
最外层函数接收装饰器参数。
内部两层为普通的装饰器定义方式。
3 装饰器类
我们知道，在python中，类实例也是callable的，即类实例也可以像函数一样调用，且实际调用的是类实例的__call__函数。既然如此，类实例也可以完成函数能做的事情：
import time from functools import wraps class TestTime: def __init__(self, msg): self.msg = msg def __call__(self, func): @wraps(func) def wrapper(*args, **kwargs): print("before func:", self.msg) t = time.time() out = func(*args, **kwargs) print(time.time() - t) return out return wrapper @TestTime("测试信息") def target_func(a, b, c): time.sleep(2) return a**b + c target_func(99, 199, 9)
输出结果如下：
before func: 测试信息 2.007122278213501
