介绍
函数本身也是对象,可以赋值给一个新的函数。如果想在不改变原有函数的基础上,又希望能够增加一些功能,就可以使用装饰器。
需求: 函数执行的时候能够打印函数执行的时间。
这是一个装饰器应用的典型场景。
def print_time2(fun):
def wrapper(*args, **kwargs):
print(time.strftime("%Y-%m-%d %H:%M:%S", time.localtime()))
return fun(*args, **kwargs)
return wrapper
def fun1():
print("fun1 called ")
print_time2(fun1)
这样一来,在执行任何函数fun的时候,只需要套上print_time2 就可以既执行函数fun,又打印了时间。
简单的说,装饰器的本质就如它的名字一样,是对函数的二次包装。其目标是在不改变源代码的前提下,在程序运行期间对函数功能进行动态扩展。
进阶
- 每一次调用fun1都需要套上print_time2(),这样的写法既不美观也不方便
把@print_time2放在 fun1的定义上,执行fun1的时候就会执行print_time2(fun) - 第一个例子中的装饰器是一个粗暴的装饰器,因为它直接改变了函数的名字,如果我们执行这样的测试代码:
def print_time2(fun):
def wrapper(*args, **kwargs):
print(time.strftime("%Y-%m-%d %H:%M:%S", time.localtime()))
return fun(*args, **kwargs)
return wrapper
@print_time
def fun1():
print("fun1 called. ")
print(fun1.__name__) # result will be 'wrapper' not 'fun1'
这时候我们发现,fun1的名字变成了wrapper, 这就是直接将fun1 替换为wrapper 的结果。
在wrapper上加上@function.wrap(fun) function.wrap 就帮你做了类似把wrapper.__name__替换为fun的事情
from functools import wraps
import time
def print_time(fun):
@wraps(fun)
def wrapper(*args, **kwargs):
print (time.strftime("%Y-%m-%d %H:%M:%S", time.localtime()))
return fun(*args, **kwargs)
return wrapper
@print_time
def fun1():
print("fun1 called. ") # the result is 'fun1'
打印的结果就是fun1而不是wrapper了
- 带有参数的装饰器
def log(text):
def decorator(fun):
@wraps(fun)
def wrapper(*args, **kwargs):
print("text :{0} function:{1} is called".format(text, fun.__name__))
return fun(*args, **kwargs)
return wrapper
return decorator
@log('DEBUG')
def log1():
pass
log1()
print(log1.__name__)
输出结果:
text :DEBUG function:log1 is called
log1
可以把带有参数的装饰器看作是将装饰器本身进行了又一次封装
延伸学习
- 类装饰器
- @staticmethod, @classmethod, @property这些内置装饰器的原理是什么?
- 面向对象中的装饰器模式是什么样的?联系python,java 面向对象设计模式中的装饰器模式