python装饰器

作者 新城 日期 2017-08-23
python装饰器



装饰器

由于函数也是一个对象,而且函数对象可以被赋值给变量,所以,通过变量也能调用该函数。

Demo

1
2
3
4
def now():
print ('1')
f = now
print (f()) #输出1

函数对象也有自己的属性

1
2
print (now.__name_)  #now
print (f.__name_) #now

现在,假设我们要增强now()函数的功能,比如,在函数调用前后自动打印日志,但又不希望修改now()函数的定义,这种在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)

本质上,decorator就是一个返回函数的高阶函数。所以,我们要定义一个能打印日志的decorator,可以定义如下




观察上面的log,因为它是一个decorator,所以接受一个函数作为参数,并返回一个函数。
我们要借助Python的@语法,把decorator置于函数的定义处:

调用now()函数,不仅会运行now()函数本身,还会在运行now()函数前打印一行日志:

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



如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:




通俗点说就是 作用就是在调用nows的时候 会提前输出 nows函数的一些信息

因为返回的那个wrapper()函数名字就是’wrapper’,所以,
需要把原始函数的name等属性复制到wrapper()函数中,否则,有些依赖函数签名的代码执行就会出错。

不需要编写wrapper.name = func.name这样的代码,
Python内置的functools.wraps就是干这个事的,所以,一个完整的decorator的写法如下:

1
2
3
4
5
6
7
8
9
import functools
def log(text):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kw):
print '%s %s():' % (text, func.__name__)
return func(*args, **kw)
return wrapper
return decorator

以上两种decorator的定义都没有问题,但还差最后一步。因为我们讲了函数也是对象,
它有name等属性,但你去看经过decorator装饰之后的函数,它们的name已经从原来的’now’变成了’wrapper’

now.name 输出’wrapper’
import functools是导入functools模块。
现在,只需记住在定义wrapper()的前面加上@functools.wraps(func)即可。