面试官:你了解装饰器吗?
XXX:了解
面试官:那你说说吧
XXX:装饰器是…
面试官:你先写一个装饰器,再写一个带参的装饰器
XXX:xxx。。。
面试官:你知道装饰器有哪些应用场景吗
XXX:xxx。。。(思考)
Python的装饰器(decorator)可以说是Python的一个神器,它可以在不改变一个函数代码和调用方式的情况下给函数添加新的功能。Python的装饰器同时也是Python学习从入门到精通过程中必需要熟练掌握的知识。今天尝试用浅显的语言解释下Python装饰器的工作原理及如何编写自己的装饰器吧。
应用场景
- 附加功能
- 数据的清理或添加:
- 函数参数类型验证 @require_ints 类似请求前拦截
- 数据格式转换 将函数返回字典改为 JSON/YAML 类似响应后篡改
- 为函数提供额外的数据 mock.patch
- 函数注册
- 在任务中心注册一个任务
- 注册一个带信号处理器的函数
你可能还是不理解装饰器是啥?没有关系,下面我们详细的解析一下到底如何去实现装饰器。
简单的装饰器
import time
def getTime(func):
def inner():
start = time.time()
func()
end = time.time()
print('用时:{}秒'.format(end-start))
return inner
@getTime
def func1():
time.sleep(2)
print("Func1 is running.")
if __name__ == '__main__':
func1()
上面的代码,func1函数被getTime函数装饰,这个装饰器实现的功能是统计func1函数执行的时间,这其实就是一个最简单的装饰器。
如何你还是不太理解,我们换种写法
import time
def getTime(func):
def inner():
start = time.time()
func()
end = time.time()
print('用时:{}秒'.format(end-start))
return inner
def func1():
time.sleep(2)
print("Func1 is running.")
res = getTime(func1)
print(res)
本质上的装饰器
Python的装饰器本质上是一个嵌套函数,它接受被装饰的函数(func)作为参数,并返回一个包装过的函数。这样我们可以在不改变被装饰函数的代码的情况下给被装饰函数或程序添加新的功能。
Python的装饰器广泛应用于引入日志,执行函数前预备处理,执行函数后清理功能,权限校验(如django中的@login_required和@permission_required装饰器),缓存,事务处理、性能测试(比如统计一段程序的运行时间)和插入日志等应用场景。有了装饰器,我们就可以抽离出大量与函数功能本身无关的代码,增加一个函数的重用性。
试想你写了很多程序,一直运行也没啥问题。有一天老板突然让你统计每个程序都运行了多长时间并比较下运行效率。此时如果你去手动修改每个程序的代码一定会让你抓狂,而且还破坏了那些程序的重用性。聪明的程序员是绝不能干这种蠢事的。此时你可以编写一个@time_it的装饰器(代码如下所示)。如果你想打印出某个函数或程序运行时间,只需在函数前面@一下,是不是很帅?
由于Python装饰器的工作原理主要依赖于嵌套函数和闭包,所以我们必须先对嵌套函数和闭包有深入的了解。嵌套函数和闭包几乎是Python工作面试必考题哦。闭包相关的讲解请点击专题四:python之作用域和闭包详解
嵌套函数
如果在一个函数的内部还定义了另一个函数(注意: 是定义,不是引用!),这个函数就叫嵌套函数。外部的我们叫它外函数,内部的我们叫他内函数。
我们先来看一个最简单的嵌套函数的例子。我们在outer函数里又定义了一个inner函数,并调用了它。你注意到了吗? 内函数在自己作用域内查找局部变量失败后,会进一步向上一层作用域里查找。
def outer():
x = 1
def inner():
y = x + 1
print(y)
inner()
outer() #输出结果 2
如果我们在外函数里不直接调用内函数,而是通过return inner返回一个内函数的引用 这时会发生什么呢? 你将会得到一个内函数对象,而不是运行结果。
def outer():
x = 1
def inner():
y = x + 1
print(y)
return inner
outer() # 输出<function outer.<locals>.inner at 0x039248E8>
f1 = outer()
f1() # 输出2
上述这个案例比较简单,因为outer和inner函数都是没有参数的。我们现在对上述代码做点改动,加入参数。你可以看到外函数的参数或变量可以很容易传递到内函数。
def outer(x):
a = x
def inner(y):
b = y
print(a+b)
return inner
f1 = outer(1) # 返回inner函数对象
f1(10) # 相当于inner(10)。输出11
如果上例中外函数的变量x换成被装饰函数对象(func),内函数的变量y换成被装饰函数的参数,我们就可以得到一个通用的装饰器啦(如下所示)。你注意到了吗? 我们在没对func本身做任何修改的情况下,添加了其它功能, 从而实现了对函数的装饰。
def decorator(func):
def inner(*args, **kwargs):
add_other_actions()
return func(*args, **kwargs)
return inner
闭包
面试中的装饰器
通用的装饰器
面试官往往会给你提一些简单的需求,如返回被装饰函数执行时间,函数的名称等,这时候要学会灵活的转变。
def hint(func):
def wrapper(*args, **kwargs):
print('{} is running'.format(func.__name__))
return func(*args, **kwargs)
return wrapper
@hint
def hello():
print("Hello!")
执行结果
调用: hello()
hello is running.
Hello!
值得一提的是被装饰器装饰过的函数看上去名字没变,其实已经变了。当你运行print(hello.name) 后,你会发现它的名字已经悄悄变成了wrapper,这显然不是我们想要的。这一点也不奇怪,因为外函数返回的是由wrapper函数和其外部引用变量组成的闭包。
为了解决这个问题保证装饰过的函数__name__属性不变,我们可以使用functools模块里的wraps方法,先对func变量进行wraps。下面这段代码可以作为编写一个通用装饰器的示范代码,注意收藏哦。
from functools import wraps
def hint(func):
@wraps(func)
def wrapper(*args, **kwargs):
print('{} is running'.format(func.__name__))
return func(*args, **kwargs)
return wrapper
@hint
def hello():
print("Hello!")
如果你非常的熟悉上面的这些内容,你就可以轻松的写一个通用的装饰器。
带参的高级装饰器
前面几个装饰器一般是内外两层嵌套函数。如果我们需要编写的装饰器本身是带参数的,我们需要编写三层的嵌套函数,其中最外一层用来传递装饰器的参数。现在我们要对@hint装饰器做点改进,使其能通过@hint(coder=“LeooO”)传递参数。该装饰器在函数运行前给出提示的时候还显示函数编写人员的名字。完整代码如下所示:
from functools import wraps
def hint(coder):
def wrapper(func):
@wraps(func)
def inner_wrapper(*args, **kwargs):
print('{} is running'.format(func.__name__))
print('Coder: {}'.format(coder))
return func(*args, **kwargs)
return inner_wrapper
return wrapper
@hint(coder="LeooO")
def hello():
print("Hello!")
多个装饰器
先看一段代码
def d1(f):
def inner1(*args, **kwargs):
print(1)
f()
print("我是外边的装饰器")
return inner1
def d2(f):
def inner2(*args, **kwargs):
print(2)
print(f.__name__)
f()
print("我是里边的装饰器")
return inner2
@d1
@d2
def func():
print('哈哈哈')
func()
# 执行结果是啥呢?
2
1
func
哈哈哈
我是里边的装饰器
我是外边的装饰器
这是咋回事呢?我换种写法你思考一下。
def d1(f):
def inner1(*args, **kwargs):
print(2)
f()
print("我是外边的装饰器")
return inner1
def d2(f):
def inner2(*args, **kwargs):
print(1)
print(f.__name__)
f()
print("我是里边的装饰器")
return inner2
def func():
print('哈哈哈')
res = d1(d2(func))
如果你还是不明白,没有关系,再来一段代码
from functools import wraps
def A(funE_decorated_by_C):
@wraps(funE_decorated_by_C)
def redecorated_E(str):
print("开始执行", end="——>")
return funE_decorated_by_C(str) + ' > redecorated by A'
return redecorated_E
def C(funE):
@wraps(funE)
def decorated_E(str):
return funE(str) + ' > decorated by C'
return decorated_E
@A
@C
def E(str):
return str
print(E('A string is '))
print(E.__name__)
#开始执行——>A string is > decorated by C > redecorated by A
难理解的地方在C和A在装饰过程中执行的调用关系
- 可以看到,先调用那个装饰器,那个装饰器就先运行
print(“开始执行”, end="——>") - 继续执行 A装饰的是C(A) 即funE_decorated_by_C
调用 funE_decorated_by_C 执行C - C执行 调用E函数 返回的结果作为A funE_decorated_by_C的参数
- 最终在A中调用E 返回 A
案例代码
def decorator_b(fun):
def inner_b(*args, **kwargs):
print('This is inner_b')
print("*****")
# print(fun(*args, **kwargs))
return fun(*args, **kwargs) + 2
return inner_b
def decorator_a(fun):
def inner_a(*args, **kwargs):
print('This is inner_a')
return fun(*args, **kwargs) + 11
return inner_a
@decorator_b
@decorator_a
def f(x):
print('This is f')
return x * 2
print(f(1))
This is inner_b
***************
This is inner_a
This is f
15
推荐文章
https://www.cnblogs.com/Lin-Yi/p/7305364.html
http://python.jobbole.com/81683/
http://lib.csdn.net/article/python/62942
http://lib.csdn.net/article/python/64769
http://www.cnblogs.com/cicaday/p/python-decorator.html