一、理解装饰器
通俗点说,当我们想给一个函数增强额外的功能,但又不想修改原函数的定义,同时新增的功能其它函数可能也需要使用,装饰器就是来解决这种需求的,将与原函数功能无关的代码提取出来,实现复用,在代码运行期间动态的给原函数增加功能,例如在函数执行前后插入日志、计算函数的执行时间等等
二、实践
1、一个小需求
有一个需求,要在函数执行前后打印start execute
、end execute
,如果我们还不知道有装饰器存在可以怎么做呢?
首先定义原函数:
def my_func():
print('Hello World')
再定义一个函数用来打印日志,并在其中执行原函数:
def log(func):
def wrapper():
print('start execute')
func()
print('end execute')
return wrapper
可以看到,log
函数接收一个函数作为参数,并返回一个新的wrapper
函数。
最后看执行结果:
my_func = log(my_func)
my_func()
0
我们将my_func
函数作为参数传给log
函数,并将返回的wrapper
函数赋值给my_func
变量,则my_func
变量就是返回的wrapper
函数,并不是之前定义的my_func
函数,最后执行my_func()
其实执行的是返回的wrapper
函数。到这里已经实现了前边的小需求,其实装饰器的原理亦是如此。
2、使用装饰器
如果使用装饰器怎么写呢?先不需要修改log
函数,只对my_func
函数做修改:
@log
def my_func():
print('Hello World')
很明显吧,用Python的 @ 语法实现装饰器,实现log
函数对my_func
函数的装饰。
再看执行结果:
1
其实装饰器相当于替我们执行了my_func = log(my_func)
这一步。
但是有个问题,按理my_func
函数的__name__
属性应该是my_func
,但使用装饰器后变成了wrapper
:
其实就是前边讲的赋值操作my_func = log(my_func)
导致的,这当然不是我们想看到的,可以用Python内置functools
模块的wraps()
方法,修改我们的log
函数:
def log(func):
@functools.wraps(func)
def wrapper():
print('start execute')
func()
print('end execute')
return wrapper
再执行结果:
3
3、带参数的被装饰函数
如果my_func
函数有参数呢?像这样:
def my_func(a, b):
print('a+b=%d' % (a + b))
当然还要修改log
函数,怎么改呢,这样???给wrapper
加两个参数???
def log(func):
@functools.wraps(func)
def wrapper(a, b):
print('start execute')
func(a, b)
print('end execute')
return wrapper
如果其它函数的参数个数、参数形式和my_func
不同,也想使用log
作为装饰器,那这样修改log
肯定不行......,可以这样,让装饰器内嵌的wrapper
函数支持可变参数以及关键字参数:
def log(func):
@functools.wraps(func)
def wrapper(*args, **kw):
print('start execute')
func(*args, **kw)
print('end execute')
return wrapper
这样其它函数也就能共用这个log
函数了,要不然还搞啥装饰器。现在使用修改后的log
函数:
@log
def my_func(a, b):
print('a+b=%d' % (a + b))
再来一个my_func1
函数:
@log
def my_func1(a, b, c, *, d):
print('a+b+c+d=%d' % (a + b + c + d))
看下执行结果:
4
以my_func
为例,这时候使用装饰器执行my_func(1, 2)
相当于执行了log(my_func)(1, 2)
。
4、带参数的装饰器函数
如果装饰器函数本身也需要参数呢?继续以log
函数为例,现在需要接受一个字符串为参数,并在被装饰函数执行前打印,则可以给它在内嵌一层函数:
def log(arg):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kw):
print('装饰器的参数:%s' % arg)
print('start execute')
func(*args, **kw)
print('end execute')
return wrapper
return decorator
这时再给my_func
添加装饰器:
@log('Hello World')
def my_func(a, b):
print('a+b=%d' % (a + b))
执行结果如下:
5
此时相当于执行了log('Hello World')(my_func)(1, 2)
5、参数可选的装饰器函数
我们继续扩展装饰器函数log
的功能,使其既支持:
@log('Hello World')
def my_func(a, b):
print('a+b=%d' % (a + b))
又要支持:
@log
def my_func(a, b):
print('a+b=%d' % (a + b))
即参数可选,怎么修改呢?前边已经说过了,第一种情况执行my_func(1, 2)
相当于log('Hello World')(my_func)(1, 2)
,其中log('Hello World')
先执行,返回接受my_func
为参数的decorator
函数,第二种情况执行相当于log(my_func)(1, 2)
,其中log(my_func)
先执行,返回的是接受1、2
为参数的wrapper
函数。所以我们让log
函数在两种情况下分别返回不同的函数,即log
函数的参数为函数时其返回wrapper
函数,即decorator(arg)
,log
函数的参数为字符串时让其返回decorator
函数,至于打印log
的字符串参数,只需要判参数是字符串再打印即可:
def log(arg):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kw):
if arg and isinstance(arg, str):
print('装饰器的参数:%s' % arg)
print('start execute')
func(*args, **kw)
print('end execute')
return wrapper
if callable(arg):
return decorator(arg)
return decorator
1、isinstance(arg, str):判断arg是否为str类型
2、callable(arg):判断arg是否可被调用,可被调用指的是能否使用()括号的方法调用。
测试结果如下:
6
网友评论