python的装饰器一直是Python里不太好理解的一部分,但是使用确是非常频繁的一个东西。用好装饰器可以让代码更加简洁,更具可读性,所以这里分享一下我对python装饰器的理解。
python装饰器个功效有点类似于java的web开发中spring面向切面编程的前置后置增强,可以在我们的目标操作前先执行一些预处理。经常用在输出日志,性能测试或者事物处理的地方。
如何编写一个装饰器
现在来做一个日志增强的功能:
def log(func):
def wrapper(*args, **kwargs):
print 'call %s()' % func.__name__
return func(*args, **kwargs)
return wrapper
@log
def hello():
print 'hello'
if __name__ == '__main__':
hello()
output:
call hello()
hello
这里新建了一个函数叫log接收一个函数做为参数内部有一个函数叫做wrapper的功能就是打印一句日志。当我们调用hello()的时候不仅hello本身会执行还会执行log里面的打印语句。其实我们在def hello
前面加上的@log
的作用相当于hello = log(hello)
而@符号只是python给它的一个语法糖而已,看起来更简洁美观。
functools @wraps
由于我们的装饰器其实相当于调用hello=log(hello)
而log是返回wrapper函数的,所以如果这时候我们打印hello.__name__
会发现输出是wrapper
这样我们的函数名字都变了。如果你对函数名又要求或者用到函数的一些属性,这样就会造成一些不可预测的后果。于是python在2.5版本之后的functools
模块中加入了一个装饰器叫做@wraps
def log(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
print 'call %s()' % func.__name__
return func(*args, **kwargs)
return wrapper
@log
def hello():
print 'hello'
if __name__ == '__main__':
print hello.__name__
这里我们在wrapper
上面加入了一个这个装饰器再打印hello的名字的适合就不是wrapper
而是hello
了,其实@functools.wraps(func)
就是把wrapper函数的各个属性更新为我们想要装饰的函数的属性。
为装饰器添加参数
经常我们在一些web框架里可以看到很多装饰器用来路由web页面的url同时也加入了很多参数。比如flask里面:
@app.route('/logout')
def logout():
session.pop('logged_in', None)
flash('You were logged out')
return redirect(url_for('show_entries'))
这里使用了@app.route这个装饰器并且传入了一个参数,那么怎么编写一个可以传入参数的装饰器呢?
下面我们写一个可以接收一个参数的装饰器:
def assign_info(text):
def decorater(func):
@functools.wraps(func)
def wrapper():
print 'info:' + text
return func()
return wrapper
return decorater
@ assign_info('decorater input')
def hello():
print 'hello---'
if __name__ == '__main__':
hello()
可以看到我们这个装饰器变成了三层第一次是可以接收我们的参数的函数,里面是装饰器函数,最里面是wrapper函数,然后再一层一层的返回。刚刚说到我们写的那个log装饰器相当于调用hello=log(hello)
,那现在我们的三层的又是怎么调用的呢?其实这相当于hello=assign_info('decorater input')(hello)
总结:python的装饰器在很多地方都经常用到,所以理解并掌握它非常必要,学会了装饰器可以让代码变得更简洁,开发效率也可以得到显著提高,在很多比如权限管理,日志管理等地方我们都可以做成装饰器来处理。