装饰器说明
函数要实现对扩展开放,对修改封闭。使用装饰器的目的是为其他人添加新功能,装饰器本身可以是任意可调用对象,被装饰的对象也可以是任意可调用对象。
装饰器遵循的原则:
- 不修改被装饰对象的源代码
- 不修改被调用对象的调用方式
装饰器的目的:在遵循1和2原则的前提,为其他新功能函数添加调用。
装饰器充分使用了闭包函数的原理,通过引入一个新函数,对其进行功能的扩展,并在新函数中调用原函数,最后,将新函数赋值给同名的原函数,从而达到对原函数功能的扩展而不改变其内部代码,并使用与原函数相同的调用方式。
使用闭包函数,对原函数f()
进行扩展:
def f1():
print('welcome to python')
def ex():
f=f1
def func():
f()
print('life is short,I use python!')
return func
f1=ex()
f1()
以上代码实现了装饰器的功能,但是在实际应用时可能有扩展多个函数功能场景,可以使用编写带参数的通用闭包函数对多个函数进行扩展:
def f1():
print('welcom to python')
def f2():
print('my name is andy')
def ex(func):
f=func
def aa():
f()
print('life is short,I use python!')
return aa
f1=ex(f1)
f2=ex(f2)
f1()
f2()
装饰器语法规则
python 中为了更加简化多装饰器的书写,制定了更加简洁的书写方式,如果对上面的代码使用装饰器的方式书写,应该是这样:
def ex(func): # 函数必须先定义,要在f1() 和f2() 之前
f=func
def aa():
f()
print('life is short,I use python!')
return aa
@ex # 在函数的正上方使用@装饰器名的方式
def f1():
print('welcom to python')
@ex
def f2():
print('my name is andy')
f1()
f2()
装饰器名必须写在函数的最上方,并且是单独的一行,使用@装饰器名。但这并非实际应用中的方式。
装饰器的参数和返回值
在上面的实例中,如果原函数有参数,那么在使用装饰器的时候,依然需要将参数传递到原函数中。同理,如果原函数有返回值,也需要将返回值返回。
因此,实际的应用是这样:
def ex(func):
f=func
def aa(*args,**kwargs): # 可以接收任意参数
res = f(*args,**kwargs) #将接收的参数传递给原函数,如果有返回值,赋值给res
print('life is short,I use python!')
return res # 返回原函数中的返回值
return aa
@ex
def f1():
print('welcom to python')
return 0
@ex
def f2(name):
print('my name is %s' %name)
re=f1()
print(re)
f2('andy')
针对参数和返回值的处理,就能实现对原函数任意参数和有无返回值的处理。
使用装饰器实现认证功能
这里使用一个小实例,对上面的代码添加认证功能,使用文件认证的方式,认证文件a.txt
的内容:
{'andy':'123','tt':'456'}
示例代码:
current_user={'username':None} # 记录用户是否登录
def ex(func):
f=func
def auth(*args,**kwargs):
if current_user['username']: # 如果已经登录,不再进行认证,直接执行原函数
return f(*args,**kwargs)
name=input('please input your name: ').strip()
password=input('please input your password: ').strip()
with open('a.txt','r',encoding='utf-8') as user:
user_list=eval(user.read())
if name in user_list and password==user_list[name]:
current_user['username']=name
res = f(*args,**kwargs)
return res
else:
print('username or password incorrect')
exit(1)
return auth
@ex
def f1():
print('welcom to python')
return 0
@ex
def f2(name):
print('my name is %s' %name)
re=f1()
print(re)
f2('andy')
有参装饰器
针对上面的认证,如果开发者需要对认证方式进行选择,如根据传入参数不同,选择不同的认证方式,就需要对装饰器传入参数了。由于原函数的参数是不能修改的,闭包中的返回函数参数是与原函数对应,所以也不能修改。所以解决方式是通过定义一个新的函数,带入要传的参数,在执行的时候只需要对外层的装饰器传值即可 (相当于再添加一层闭包函数):
current_user={'username':None}
def auth_type(type='file'): # 添加一层闭包函数,对此函数传值
def ex(func): # 原装饰器不做修改
f=func
def auth(*args,**kwargs):
if type=='file':
if current_user['username']:
return f(*args,**kwargs)
name=input('please input your name: ').strip()
password=input('please input your password: ').strip()
with open('a.txt','r',encoding='utf-8') as user:
user_list=eval(user.read())
if name in user_list and password==user_list[name]:
current_user['username']=name
res = f(*args,**kwargs)
return res
else:
print('username or password incorrect')
exit(1)
elif type=='mysql':
print('mysql')
elif type=='ldap':
print('ldap')
return auth
return ex # 最后返回原装饰器的内存地址
@auth_type('file') # 直接带参数执行最外层函数,获取返回的ex函数,等同于 @ex
def f1():
print('welcom to python')
return 0
@auth_type('mysql') # 可以根据参数不同,进行不同的操作
def f2(name):
print('my name is %s' %name)
re=f1()
print(re)
f2('andy')
此示例中外层函数auth_type()
只引入参数,然后直接返回内层函数对象ex
,使用装饰器时,直接执行外层函数,获得内层函数对象,由于外层引入了参数type
,闭包函数的内部就可以直接使用此参数进行操作了。
装饰器的注释
在一般函数中,我们如果要查看函数中的注释信息,可以通过help()
和__doc__
来查看:
def f1():
'''this is f1()'''
print('welcom to python')
return 0
print(help(f1))
或者:
def f1():
'''this is f1()'''
print('welcom to python')
return 0
print(f1.__doc__)
但是在装饰器中,使用这里的代码不会生效,因为在调用被装饰函数时,实际是先运行的装饰器,要通过装饰器抛出被装饰函数的注释,需要用到python中自带的模块from functools import wraps
:
from functools import wraps # 导入模块
current_user={'username':None}
def ex(func):
f=func
@wraps(func) # 在最内层函数的开头加入 @wraps()
def auth(*args,**kwargs):
if current_user['username']:
return f(*args,**kwargs)
name=input('please input your name: ').strip()
password=input('please input your password: ').strip()
with open('a.txt','r',encoding='utf-8') as user:
user_list=eval(user.read())
if name in user_list and password==user_list[name]:
current_user['username']=name
res = f(*args,**kwargs)
return res
else:
print('username or password incorrect')
exit(1)
return auth
@ex
def f1():
'''this is fi()'''
print('welcom to python')
return 0
@ex
def f2(name):
'''this is f2()'''
print('my name is %s' %name)
re=f1()
print(re)
f2('andy')
print(f1.__doc__) # 打印注释信息
print(f2.__doc__)
多装饰器情况
在一个函数需要多个装饰器进行叠加,一般是咱找顺序,依次执行。