目录
一、装饰器的概念
装饰器它不是一个新的知识点,它是有之前我们学习的名称空间、函数嵌套、闭包函数等知识点汇总而来。
什么是装饰器:
器:指工具
装饰:添加功能
装饰器的核心思想:
在'不改变原来的调用方式'和'内部代码'的基础之上给函数'添加额外的功能'。
补充:给index函数添加统计执行时间的功能。
# 补充:如何计算时间
import time # 内置的时间模块,拿来直接用
print(time.time()) # 1694139138.4503667 称为是时间戳:1694139138秒数,从1970-1-1到当前时间的秒数
# 1694139138.4503667-------------》格式化之后的时间
time.sleep(3) # 睡眠
print(123) # 123
import time
def index():
time.sleep(3)
print('from index') # from index
# 1. 在执行函数之前加一个时间点
start_time = time.time() # 此时的时间戳
index()
# 2. 等index函数执行之后在打个时间点
end_time = time.time()
# 3. 获取index 的总执行时间
print('index一共执行了%s秒' % (end_time - start_time))
# index一共执行了3.0146665573120117秒
二、装饰器的简易版本
import time
def index():
time.sleep(3)
print('from index')
def home():
print('from home')
def func():
print('from func')
def outer(func_name):
# func_name = index
def get_time():
# 1. 函数执行之前打一个时间点
start_time = time.time()
func_name() # index() home()
# 2. 在函数执行之后,在打一个时间点
end_time = time.time()
print('总共执行了:%s' % (end_time - start_time))
return get_time
# get_time(index)
# get_time(home)
index=outer(index) # res=get_time
index() # get_time()
三、装饰器进阶版本
我们现在统计的函数有时候需要参数,有时候不需要参数,所以,参数到底应该传还是不传?我们确定不了什么时候传,或者是传几个?如何解决?
*args和**kwargs
# 解决参数问题、
import time
def index():
time.sleep(3)
print('from index')
def home(name):
time.sleep(1)
print('from home:', name)
def outer(func):
# func:index
# func = home
def get_time(*args, **kwargs):
# func:index
start_time = time.time()
# index() # 只能够统计index函数的时间
# func()---->index()
# func:home
func(*args, **kwargs) # 只能够统计index函数的时间
end_time = time.time()
print('执行时间:%s' % (end_time - start_time))
return get_time
# get_time(index()) # get_time(None)
# get_time(index) #
index = outer(index) # res:get_time的函数名(其实也是get_time的内存地址)
index() # get_time()
# home = outer(home)
# home('jerry') # get_time('jerry')
# 解决返回值问题
def outer(func):
# func:index
# func = home
def get_time(*args, **kwargs):
# func:index
start_time = time.time()
# index() # 只能够统计index函数的时间
# func()---->index()
# func:home
res = func(*args, **kwargs) # 只能够统计index函数的时间
end_time = time.time()
print('执行时间:%s' % (end_time - start_time))
# return res # 其实返回的是上面index的返回值
return res
return get_time
home = outer(home)
res = home('jerry') # get_time('jerry')
print(res)
四、装饰器练习题
认证登录功能
我们现在需要做:只要登录成功一次,后续的函数就不用在登录了,直接可以访问
# 必须登录之后才能够访问函数
def index():
print('from index')
def home():
print('from home')
def home1():
print('from home1')
# index()
# 用户必须是登录之后才能访问,否则不让访问
is_login = {'is_login': False}
# 1. 写一个登录程序
def outer(func):
# func = index
def auth():
if is_login.get('is_login'):
## 如果条件成立,直接执行函数
res = func()
return res # 解决返回值问题的
username = input('username:>>>').strip()
password = input('password:>>>').strip()
# 2. 比较用户名和密码
if username == 'jerry' and password == '123':
# 执行函数
print('登录成功')
func()
is_login['is_login'] = True #
else:
print('用户名或者密码错误')
return auth
# auth(index)
# auth(home)
index = outer(index)
index()
home = outer(home)
home()
home1 = outer(home1)
home1()
home = outer(home)
res = home() # get_time('jerry')
print(res)
五、装饰器的固定模版
1. 语法糖的书写规范:
@装饰器名字
必须把上面的写在被装饰对象的头上(紧贴着被装饰对象写)
2. 语法糖的原理:
它会把下面的被装饰对象的名字当成参数传递给装饰器
def outer(func):
def inner(*args, **kwargs):
print('函数被调用之前需要添加的功能')
res = func(*args, **kwargs) # 真正的函数执行
print('函数被调用之后需要添加的功能')
return res
return inner
def outer(func):
def inner(*args, **kwargs):
print('函数被调用之前需要添加的功能')
res = func(*args, **kwargs) # 真正的函数执行
print('函数被调用之后需要添加的功能')
return res
return inner
# @outer # index = outer(index)
# def index():
# print('from index')
# return 'index'
#
#
# @outer # home=outer(home)
# def home():
# print('from home')
#
# # index = outer(index)
#
# index()
#
# home() # inner()
@outer # func=outer(func)
def func():
print('from func')
func()
六、双层语法糖
import time
def outer(func):
def get_time(*args, **kwargs):
start_time = time.time()
res = func(*args, **kwargs)
enf_time = time.time()
print('执行时间:%s' % (enf_time - start_time))
return res
return get_time
def login_auth(func):
def auth():
username = input('username:>>>').strip()
password = input('password:>>>').strip()
if username == 'jerry' and password == '123':
print('登录成功')
else:
print('用户名或者密码错误')
return auth
@login_auth
@outer
def index():
time.sleep(3)
print('from index')
index()
七、三层语法糖(多重)
# 判断七句print执行顺序
def outter1(func1):
print('加载了outter1')
def wrapper1(*args, **kwargs):
print('执行了wrapper1')
res1 = func1(*args, **kwargs)
return res1
return wrapper1
def outter2(func2):
print('加载了outter2')
def wrapper2(*args, **kwargs):
print('执行了wrapper2')
res2 = func2(*args, **kwargs)
return res2
return wrapper2
def outter3(func3):
print('加载了outter3')
def wrapper3(*args, **kwargs):
print('执行了wrapper3')
res3 = func3(*args, **kwargs)
return res3
return wrapper3
@outter1
@outter2
@outter3
def index():
print('from index')
index()
# 加载了outter3
# 加载了outter2
# 加载了outter1
# 执行了wrapper1
# 执行了wrapper2
# 执行了wrapper3
# from index
八、装饰器的修复技术(了解)
import time
from functools import wraps
def outer(func):
@wraps(func) # 修复技术
def get_time():
start_time = time.time()
func() # 只能够统计index函数的时间
end_time = time.time()
print('执行时间:%s' % (end_time - start_time))
return get_time
# @outer # index=outer(index)
def index():
print('from index')
'''修复技术就是为了让装饰器伪装的更像'''
# index()
# print(index) # <function index at 0x000002F69849A940>
# print(index) # <function index at 0x000002F69849A940>
# help(index)
@outer
def home():
'''这是home函数'''
help(home)
九、有参装饰器(重要)
了解无参装饰器的实现原理后,我们可以再实现一个用来为被装饰对象添加认证功能的装饰器,实现的基本形式如下
def deco(func):
def wrapper(*args,**kwargs):
编写基于文件的认证,认证通过则执行res=func(*args,**kwargs),并返回res
return wrapper
如果我们想提供多种不同的认证方式以供选择,单从wrapper函数的实现角度改写如下
def deco(func):
def wrapper(*args,**kwargs):
if driver == 'file':
编写基于文件的认证,认证通过则执行res=func(*args,**kwargs),并返回res
elif driver == 'mysql':
编写基于mysql认证,认证通过则执行res=func(*args,**kwargs),并返回res
return wrapper
函数wrapper需要一个driver参数,而函数deco与wrapper的参数都有其特定的功能,不能用来接受其他类别的参数,可以在deco的外部再包一层函数auth,用来专门接受额外的参数,这样便保证了在auth函数内无论多少层都可以引用到
def auth(driver):
def deco(func):
……
return deco
此时我们就实现了一个有参装饰器,使用方式如下
# 先调用auth_type(driver='file'),得到@deco,deco是一个闭包函数,包含了对外部作用域名字driver的引用,@deco的语法意义与无参装饰器一样
@auth(driver='file')
def index():
pass
@auth(driver='mysql')
def home():
pa
可以使用help(函数名)来查看函数的文档注释,本质就是查看函数的doc属性,但对于被装饰之后的函数,查看文档注释
@timer
def home(name):
'''
home page function
:param name: str
:return: None
'''
time.sleep(5)
print('Welcome to the home page',name)
print(help(home))
'''
打印结果:
Help on function wrapper in module __main__:
wrapper(*args, **kwargs)
None
'''
在被装饰之后home=wrapper,查看home.name也可以发现home的函数名确实是wrapper,想要保留原函数的文档和函数名属性,需要修正装饰器
def timer(func):
def wrapper(*args,**kwargs):
start_time=time.time()
res=func(*args,**kwargs)
stop_time=time.time()
print('run time is %s' %(stop_time-start_time))
return res
wrapper.__doc__=func.__doc__
wrapper.__name__=func.__name__
return wrapper
按照上述方式来实现保留原函数属性过于麻烦,functools模块下提供一个装饰器wraps专门用来帮我们实现这件事,用法如下
from functools import wraps
def timer(func):
@wraps(func)
def wrapper(*args,**kwargs):
start_time=time.time()
res=func(*args,**kwargs)
stop_time=time.time()
print('run time is %s' %(stop_time-start_time))
return res
return wrapper
案例
def outter(source_type):
def login_auth(func):
def auth(*args, **kwargs):
username = input('username:>>>').strip()
password = input('password:>>>').strip()
# 比较用户名和密码
"""
1.文件中获取用户名和密码
2.从MySQL中获取用户名和密码
3.从oracle中获取用户名和密码
4.从postgresql中获取用户名和密码
"""
if source_type == 'file':
print('文件中获取用户名和密码')
elif source_type == 'mysql':
print('从MySQL中获取用户名和密码')
elif source_type == 'oracle':
print('从oracle中获取用户名和密码')
elif source_type == 'postgresql':
print('从postgresql中获取用户名和密码')
if username == 'jerry' and password == '123':
print('登录成功')
else:
print('用户名或者密码错误')
return auth
return login_auth
@outter('file', )
def home():
pass
home()
# username:>>>jerry
# password:>>>123
# 文件中获取用户名和密码
# 登录成功