装饰器存在的意义
-
不影响原有函数的功能
-
可以添加新功能
一般常见的,比如拿到第三方的api接口,第三方不允许修改这个接口。这个时候装饰器就派上用场了。
装饰器本身也是一个函数,作用是为现有存在的函数,再不改变函数的基础上增加一些功能进行装饰。
它是以闭包的形式去实现的。
在使用装饰器函数时,在被装饰的函数的前一行,使用@装饰器函数名
形式来进行装饰
demo:
在一个项目中,有很多函数,由于项目越来越大,功能也越来越多,导致程序越来越慢。
其中一个函数的功能,是实现一百万次的累加
import time
def my_count():
s = 0
for i in range(1000001):
s += i
print("sum:", s)
start = time.time()
my_count()
end = time.time()
print("执行时间为:", (end - start))
成功的实现时间的计算,但是假如有成千上万个函数,每个函数这么写一遍,非常麻烦,代码量也凭空增加很多,明显不符合开发原则,代码过于冗余
考虑将上述
import time
def my_count():
s = 0
for i in range(1000001):
s += i
print("sum:", s)
def count_time(func):
start = time.time()
func()
my_count()
end = time.time()
print("执行时间为:",(end-start))
count_time(my_count)
经过修改后,定义一个函数来实现时间计算功能
初看上去比之前好很多
只是在使用时,需要将对应的函数传到时间计算函数中
单仍然影响了原来的使用
接下来思考,能不能在使用时不影响函数原来的使用方式,同时实现时间计算:
考虑闭包:
import time
def my_count():
s = 0
for i in range(1000001):
s += i
print("sum:", s)
def count_time(func):
def wrapper():
start = time.time()
func()
end = time.time()
print("执行时间为:", (end - start))
return wrapper
my_count = count_time(my_count)
my_count() # 仍然更改了调用方式
在使用时,让my_count函数重新指向count_time函数返回的函数引用。这样使用my_count时,就和原来的使用方式一样了。
import time
def count_time(func):
def wrapper():
start = time.time()
func()
end = time.time()
print("执行时间为:", (end - start))
return wrapper
@count_time
def my_count():
s = 0
for i in range(1000001):
s += i
print("sum:", s)
这样实现的好处,定义闭包函数后,只需要通过@装饰器函数名
形式的装饰器语法,就可以将@装饰器函数名
加到要装饰的函数前即可。
这种不改变原有函数功能,对函数进行拓展的形式,就成为装饰器。
在执行@装饰器函数名
时,就是将原函数传递到闭包中,然后原函数的引用指向闭包返回的装饰过内部函数的引用。
装饰器的几种形式
1.无参无返回值
def setFunc(func):
def wrapper():
print("Start")
func()
print("end") # 遇到return,此句不再执行
return wrapper
@setFunc
def show():
return "show"
print(show())
'''
Start
end
None
'''
2.有参数无返回值
def setFunc(func):
def wrapper(s):
print('Start')
func(s)
print('End')
return wrapper
@setFunc
def show(s):
print('Hello %s' % s)
show('Tom')
'''
Start
Hello Tom
End
'''
3.无参数有返回值
def setFunc(func):
def wrapper(s):
print("Start")
func(s)
print("end") # 遇到return,此句不再执行
return wrapper
@setFunc #setFunc(show)
def show(s):
print("hello %s"%s)
# print(show())
show("how are you")
'''
Start
hello how are you
end
'''
4.有参数有返回值
def setFunc(func):
def wrapper(x,y):
print("Start")
return func(x,y)
print("end") # 遇到return,此句不再执行
return wrapper
@setFunc #setFunc(show)
def myAdd(x,y):
return x+y
print(myAdd(3,3))
'''
Start
6
'''
万能装饰器
根据被装饰函数的定义不同,分出了四种形式
能不能实现一种适用于任何形式函数定义的装饰器
通过可变参数(*args/**kwargs)
def setFunc(func):
def wrapper(*args, **kwargs):
print("wrapper context.")
return func(*args, **kwargs)
return wrapper
@setFunc
def func(name, age, job="it"):
print(name, age, job)
func("Tom", 18)
'''
wrapper context.
Tom 18 it
'''
@setFunc
def demo(a, b, *c, **d):
print((a, b)) # 元组
print(c)
print(d)
demo("city", "college", 1999, 1, 1, school="zhejiang university")
'''
wrapper context.
('city', 'college')
(1999, 1, 1)
{'school': 'zhejiang university'}
'''
函数被多个装饰器所装饰
一个函数在使用时,通过一个装饰器来拓展,可能并不能达到预期
一个函数被多个装饰其所装饰
# 装饰器1
def setFunc1(func):
def wrapper1(*args, **kwargs):
print("wrapper context 1 start".center(40, '-'))
func(*args, **kwargs)
print("wrapper context 1 end".center(40, '-'))
return wrapper1
# 装饰器2
def setFunc2(func):
def wrapper2(*args, **kwargs):
print("wrapper context 2 start".center(40, '-'))
func(*args, **kwargs)
print("wrapper context 2 end".center(40, '-'))
return wrapper2
@setFunc2 # --->F
@setFunc1 # --->g
def show(*args, **kwargs): # --->f
print("show run.")
show() # F(g(f))
# 从下往上去装饰(程序语句运行顺序来看)
# 从内往外去装饰
'''
--------wrapper context 2 start---------
--------wrapper context 1 start---------
show run.
---------wrapper context 1 end----------
---------wrapper context 2 end----------
'''
总结
1.函数可以像普通变量一样,作为函数的参数或者返回值进行传递。
2.函数的内部可以定义另外一个函数,目的:隐藏函数功能的实现。
3.闭包实际上也是函数定义的一种形式。
4.闭包定义的规则,在外部函数内定义一个内部函数,内部函数使用外部函数的变量,并返回内部函数的引用。
5.python中,装饰器就是用闭包来实现的。
6.装饰器的作用,不改变现有函数的基础上,为函数增加功能。
7.装饰器的使用,通过@装饰器函数名
的形式来给已有函数进行装饰添加功能。
8.装饰器四种形式,根据参数的不同以及返回值的不同。
9.万能装饰器,通过可变参数(*args/**kwargs)来实现。
10.一个装饰器可以为多个函数提供装饰功能。
11.一个函数也可以被多个装饰器所装饰。
12.通过类实现装饰器,重写__init__
和__call__
函数。
13.类装饰器在装饰函数后,原来的引用不再是函数,而是装饰类的对象。