装饰器

装饰器

首先，看一个demo：

@func1
def func():
    print('aaa')

装饰器存在的意义

• 不影响原有函数的功能
• 可以添加新功能

一般常见的，比如拿到第三方的API接口，第三方不允许修改这个接口。这个时候，装饰器就派上用场。

装饰器本身也是一个函数，作用是为现有存在的函数，在不改变函数的基础上添加一些功能进行装饰。

它是以闭包的形式去实现的。

在使用装饰器函数时，在被装饰的函数的前一行，使用@装饰器函数名形式来进行装饰。

Demo:

现在在一个项目中，有很多函数，由于我们的项目越来越大，功能也越来越多，导致程序越来越慢。

其中一个功能函数的功能，是实现一百万次的累加。

import time
def my_count():
	a=0
	for i in range(1000001):
		a+=i
		print("sum:",a)

start=time.time()
my_count()
end=time.time()
print("执行时间为：",(end-start))

So easy,How simple it is!

成功的实现时间的计算，但是假如有成千上万个函数。每个函数这么写一遍，非常麻烦，代码量也凭空增加很多。

明显不符合开发原则，代码太过复杂

考虑将上述代码中的时间计算

import time
def my_count():
	a=0
	for i in range(1000001):
		a+=i
		print("sum:",a)

def count_time(func):
	start=time.time()
	func()
	end=time.time()
	print("执行时间为：",(end-start))

count_time(my_count)

经过修改后，定义一个函数来实现时间计算功能

初看上去，比之前好很多

只是在使用时，需要将对应的函数传入到时间计算函数中。

import time
def my_count():
	a=0
	for i in range(1000001):
		a+=i
		print("sum:",a)

def count_time(func):
	start=time.time()
	func()
	end=time.time()
	print("执行时间为：",(end-start))
	
count_time(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():
	a=0
	for i in range(1000001):
		a+=i

	print("sum:",a)		
my_count()

这样实现的好处，定义闭包函数后，只需要通过````python@装饰器函数名形式的装饰器语法，就可以将@装饰器函数名`加到要装饰的函数前即可。

这种不改变原有函数功能，对函数进行拓展的形式，就称为装饰器

在执行@装饰器函数名时，就是将原函数传递到闭包中。然后，原函数的引用指向闭包返回的装饰过的内部函数的引用。

装饰器的几种形式

1.无参无返回值

def setFunc(func):
	def wrapper():
		print("Start")
		func()
		print("end")
	return wrapper

@setFunc
def show():
	print("show")


show()
'''
Start
show
end
'''

2.无参有返回值

def setFunc(func):
	def wrapper():
		print("Start")
		return func()
		print("end")#遇到return，此句不再执行
	return wrapper

@setFunc #setFunc(show)
def show():
	return "show"


show()
'''
Start
end
'''

3.有参无返回值

def setFunc(func):
	def wrapper(s):
		print("Start")
		func(s)
		print("end")
	return wrapper

@setFunc
def show(s):
	print("Hello %s" %s)

show("City college")

​```
Start
Hello City college
end
​```

4.有参有返回值

def setFunc(func):
	def wrapper(x,y):
		print("Start")
		return func(x,y)
		print("end")
	return wrapper

@setFunc
def myAdd(x,y):
	return x+y

print(myAdd(3,3))

'''
start
6
'''

万能装饰器

根据被装饰函数的定义不同，分出了四种形式。

能不能实现一种，试用于任何形式函数定义的装饰器？

通过可变参数(*arg/**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",19)
func("Jack",20,"student")

@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.
Tom 19 IT
Wrapper context.
Jack 20 student
Wrapper context.
('City', 'College')
(1999, 1, 1)
{'school': 'Zhejiang University'}
	'''

函数被多个装饰器所装饰

一个函数在使用时，通过一个装饰器来拓展，可能并不能达到预期

一个函数被多个装饰器所装饰。

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

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.".center(40,'-'))


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.类装饰器在装饰函数后，原来的引用不再是函数，而是装饰类的对象。