本次学习python中发现一个好玩的东西,装饰器
什么是装饰器呢!
先理解字面意思(脑补下呗)
器具;它有一些功能的器具,它能实现哪些功能呢,它能不改变本体,给本体加上一些新的东西或者功能。
用在程序上就是:不修改被装饰对象源代码和调用方式的前提下为被装饰对象添加额外的功能,首先它本身也是一个函数
为何要用装饰器
软件的设计应该遵循开放封闭原则,即对扩展是开放的,而对修改是封闭的。对扩展开放,意味着有新的需求或变化时,可以对现有代码进行扩展,以适应新的情况。对修改封闭,意味着对象一旦设计完成,就可以独立完成其工作,而不要对其进行修改
应用场景
装饰器经常用于有切面需求的场景,比如:插入日志、性能测试、事务处理、缓存、权限校验等应用场景,装饰器是解决这类问题的绝佳设计,有了装饰器,就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。
装饰器的分类
无参装饰器和
有参装饰两种,
二者的实现原理一样,都是’函数嵌套+闭包+函数对象’的组合使用的产物
举例说明
这个是一个函数也是一个
import time
def index():
time.sleep(3)
print('Welcome to the index page')
return 200
# index()
遵循开放封闭不修改被装饰对象源代码的原则,我们想到的解决方法可能是
方法1:
start_time = time.time()
index()
stop_time = time.time()
print(f"runtime is {stop_time-start_time}")
这样做有一个不好的地方是,如果在程序中有多个地方需要调用这个时间那就要多次去写这一段,如果不想可以把这个整体写成一个函数:
把函数当成一个要传递的对象:
方法2:
def wrapper(fun):
start_time = time.time()
res = fun()
stop_time = time.time()
print('run time is %s' %(stop_time-start_time))
return res
wrapper(index)
有什么好处呢,如上所讲当需要统计别的函数的功能的时候,直接把别的函数放进装饰器里面就可以了。这样就修改了装饰对象的调用方式(需要添加参数),无法直接调用,需要通过wrapper来进行,换种方式,为函数体传值的方式
def timer(fun):
def wrapper():
start_time = time.time()
res = fun() #引用外部作用域的变量;
stop_time = time.time()
print(f"runtime is {stop_time-start_time}")
return res
return wrapper #这个wrapper是闭包函数第一次传递index的时候,这个wrapper是内存地址<function timer.<locals>.wrapper at 0x00000247F8A0DC10>,timer(index)也是一个函数,简而言之就是当我们使用括号后调用的就是实例化后的结果,当我们直接写wrapper后调用的就是函数,那返回的就是函数
timer(index)
index = timer(index) #得到index = wrapper wrapper携带外部作用域的变量。
index() #这样是不是就是直接调用,又添加了新功能,又不修改源码
这样我们便可以在不修改被装饰函数源代码和调用方式的前提下为其加上统计时间的功能,只不过需要事先执行一次timer将被装饰的函数传入,返回一个闭包函数wrapper重新赋值给变量名 /函数名index,
至此我们便实现了一个无参装饰器timer,这个装饰函数可以在不修改被装饰对象index源代码和调用方式的前提下为其加上新功能。但我们忽略了若被装饰的函数是一个有参函数,便会抛出异常,所以我们可以使用便用上args+*kwargs组合
#这个会报错
def home(name):
time.sleep(2)
print('welcome to here %s' % name)
home = timer(home)
home('nike')
以下是不会报错的,如果看不懂就记住吧
def timer(fun):
def wrapper(*args,**kwargs):
start_time = time.time()
res = fun(*args,**kwargs) #引用外部作用域的变量;
stop_time = time.time()
print(f"runtime is {stop_time-start_time}")
return res
return wrapper
这样一个装饰器就完成啦,但是为了简洁而优雅地使用装饰器,Python提供了专门的装饰器语法来取代index=timer(index)的形式,需要在被装饰对象的正上方单独一行添加@timer,当解释器解释到@timer时就会调用timer函数,且把它正下方的函数名当做实参传入,然后将返回的结果重新赋值给原函数名
@timer
def index():
time.sleep(3)
print('Welcome to the index page')
return 200
@timer
def home(name):
time.sleep(2)
print('welcome to here %s' % name)
这里又一点要注意要把,装饰器放在被装饰的函数之前,不然无法调用
调用的时候就是
home("nike")
index()
有参装饰器的实现
了解无参装饰器的实现原理后,我们可以再实现一个用来为被装饰对象添加认证功能的装饰器,实现的基本形式如下
def deco(func):
def wrapper(*args, **kwargs):
if driver == "file"
# 编写基于文件的认证,认证通过则执行
res=func(*args,**kwargs)
return res
elif driver == "myscql":
res=func(*args,**kwargs),
return wrapper
函数wrapper需要一个driver参数,而函数deco与wrapper的参数都有其特定的功能,不能用来接受其他类别的参数,可以在deco的外部再包一层函数auth,用来专门接受额外的参数,这样便保证了在auth函数内无论多少层都可以引用到
import time
from functools import wraps
def timer(fun):
@wraps(fun) #用来同步fun函数和同步函数的文档和函数名属性
def wrapper(*args,**kwargs):
start_time = time.time()
res = fun(*args,**kwargs) #引用外部作用域的变量;
stop_time = time.time()
print(f"runtime is {stop_time-start_time}")
return res
# wrapper.__doc__ = fun.__doc__
# wrapper.__name__ = fun.__name__
return wrapper
def auth(driver): #如果需要带有参数就要在增加一层嵌套
def demo(func):
@wraps(func)
def wrapper(*args, **kwargs):
if driver == "file":
# 编写基于文件的认证,认证通过则执行
res=func(*args,**kwargs)
print("file_driver")
return res
elif driver == "mysql":
res=func(*args,**kwargs)
print("mysql_driver")
return res
return wrapper
return demo
@auth(driver = "file")
# @timer
def index():
"""file等于driver"""
time.sleep(1)
print("pass")
@auth(driver = "mysql")
def home(name):
"""mysql等于driver"""
print(f"{name} is a good boy")
time.sleep(2)
pass
print(help(home))
# home("nike")
# print(home.__name__)