装饰器
装饰器:不能改代码,但是要增加功能的情况下。
装饰器:
把一个函数当作参数,返回一个替代版的函数
本质就是一个返回函数的函数
作用:在不改变原函数的基础上,给函数增加功能
例子:
现在我们要在输出Have a nice day!前面输出~~~~~~~~~~~~~~~~,
但是不能改变func1函数,这个时候我们可以再添加一个函数outer,
去调用func1,但是这会改变函数的调用方式
def func1():
print('Have a nice day!')
def outer():
print('~~~~~~~~~~~~~~~~')
func1()
outer() #改变了函数的调用方式,不方便,因为此时我们调用的这个函数里面没有过多的参数
#有的函数里面含有大量参数
为了更能明白装饰器的作用,我们用以下案例:
import time
def decorator(func): #装饰器
def wrapper(*args,**kwargs):
print(time.time())
func(*args,**kwargs)
return wrapper
@decorator #加上@装饰器函数名就不用修改调用方式
def f1():
print('This is a function')
f = decorator(f1)
f()
import time
def decorator(func):
def wrapper(*args,**kwargs):
print(time.time())
func(*args,**kwargs)
return wrapper
@decorator
def f2(func_name1,func_name2):
print('This is function ' + func_name1)
print('This is function ' + func_name2)
f2('test1','test2')
import time
def decorator(func):
def wrapper(*args,**kwargs):
print(time.time())
func(*args,**kwargs)
return wrapper
@decorator
def f3(func_name1,func_name2,**kwargs):
print('This is function ' + func_name1)
print('This is function ' + func_name2)
print(kwargs)
f3('test1','test2',a=1,b=2,c='westos')
案例:
装饰器实现一个函数计时器
第一种:
import time
import random
import string
import functools
li = [random.choice(string.ascii_letters) for i in range(100)]
# print(li)
def timec(fun):
"""这是一个装饰器timec"""
@functools.wraps(fun) #添加这行代码,打印帮助文档,如果没有帮助文档,则返回None,不添加这一行,打印帮助文档,默认打印的是装饰器的帮助文档
def wrapper(*args,**kwargs):
"""这是一个wrapper函数"""
#args:元组 kwargs:字典
#函数执行前
start_time = time.time()
res = fun(*args,**kwargs)
end_time = time.time()
print('运行时间为: %.6f' %(end_time - start_time))
return res
return wrapper
@timec
def con_add():
"""这是一个con_add函数"""
s = ''
for i in li:
s += (i + ',')
print(s)
@timec
def join_add():
print(','.join(li))
con_add()
join_add()
print(con_add.__doc__) #打印帮助文档
print(con_add.__name__) #打印函数名
第二种:
import random
import string
import functools
import time
li = [random.choice(string.ascii_letters) for i in range(100)]
# print(li)
def timec(fun):
"""这是一个装饰器timec"""
@functools.wraps(fun)
def wrapper(*args,**kwargs):
"""这是一个wrapper函数"""
#args:元组 kwargs:字典
#函数执行前
start_time = time.time()
res = fun(*args,**kwargs)
end_time = time.time()
print('运行时间为: %.6f' %(end_time - start_time))
return res
return wrapper
@timec
def fun_list(n):
return [2 * i for i in range(n)]
@timec
def fun_map(n):
return list(map(lambda x:x*2,range(n)))
print(fun_list(10000))
print(fun_map(10000))
案例:
创建装饰器, 要求如下:
- 创建add_log装饰器, 被装饰的函数打印日志信息;
- 日志格式为: [字符串时间] 函数名: xxx, 运行时间:xxx, 运行返回值结果:xxx
import functools
import time
def add_log(fun):
@functools.wraps(fun)
def wrapper(*args,**kwargs):
start_time = time.time()
res = fun(*args,**kwargs)
end_time = time.time()
print('[%s] 函数名: %s, 运行时间: %.6f, 运行返回值结果: %d'
%(time.ctime(),fun.__name__,end_time - start_time,res)) #time.ctime字符串时间
return res
return wrapper
@add_log
def add(x,y):
time.sleep(1)
return x + y
add(1,2)
案例:
只有登陆root用户才能添加学生信息,其他用户没有权限(只有大体框架,并没有真的实现添加学生信息)
import functools
import inspect
def is_admin(fun):
@functools.wraps(fun)
def wrapper(*args,**kwargs):
#inspect.getcallargs返回一个字典,key值:形参 value值:对应的实参
inspect_res = inspect.getcallargs(fun,*args,**kwargs)
print('inspect的返回值: %s' %inspect_res)
if inspect_res.get('name') == 'root':
res = fun(*args,**kwargs)
return res
else:
print('Permission denied!')
return wrapper
@is_admin
def add_student(name):
print('添加学生信息')
def del_student(name):
print('删除学生信息')
add_student('root') #root用户登陆
如果装饰器也需要传递参数,那么需要定义一个‘函数‘来传递这个参数
import time
import functools
def log_kind(kind): #传递参数
def add_log(fun):
@functools.wraps(fun)
def wrapper(*args,**kwargs):
start_time = time.time()
res = fun(*args,**kwargs)
end_time = time.time()
print('<%s>[%s] 函数名: %s, 运行时间: %.6f, 运行返回值结果: %d'
%(kind,time.ctime(),fun.__name__,end_time - start_time,res))
return res
return wrapper
return add_log
@log_kind('debug') #装饰器传的参数为debug
def add(x,y):
time.sleep(1)
return x + y
add(1,2)
编写装饰器required_types, 条件如下:
1). 当装饰器为@required_types(int,float)确保函数接收到的 每一个参数都是int或者float类型;
2). 当装饰器为@required_types(list)确保函数接收到的
每一个参数都是list类型;
3). 当装饰器为@required_types(str,int)确保函数接收到的每 一个参数都是str或者int类型;
4). 如果参数不满足条件, 打印 TypeError:参数必须为xxxx类 型
import functools
def required_types(*kinds):
def required(fun):
@functools.wraps(fun)
def wrapper(*args,**kwargs):
for i in args:
if not isinstance(i,kinds):
# print('TypeError:参数必须为',kinds)
# break
raise TypeError('参数必须为%s,%s' %kinds)
else:
res = fun(*args,**kwargs)
return res
return wrapper
return required
@required_types(float,int)
def add(a,b):
return a + b
print(add(1.2,2.0))
此时就会报错
多个装饰器的执行顺序,谁在前先执行谁
def decorator_a(fun):
def inner_a(*args,**kwargs):
print('Get in inner_a')
return fun(*args,**kwargs)
return inner_a
def decorator_b(fun):
def inner_b(*args,**kwargs):
print('Get in inner_b')
return fun(*args,**kwargs)
return inner_b
@decorator_b
@decorator_a
def f(x):
print('Get in f')
return x*2
f(1)
多个装饰器练习:
import functools
import inspect
login_tables = ['root','admin','westos']
def is_admin(fun):
@functools.wraps(fun)
def wrapper(*args,**kwargs):
#inspect.getcallargs返回一个字典,key值:形参 value值:对应的实参
inspect_res = inspect.getcallargs(fun,*args,**kwargs)
print('inspect的返回值: %s' %inspect_res)
if inspect_res.get('name') == 'root':
res = fun(*args,**kwargs)
return res
else:
print('Permission denied!')
return wrapper
def login(fun):
@functools.wraps(fun)
def wrapper(*args,**kwargs):
if args[0] in login_tables:
res = fun(*args,**kwargs)
return res
else:
print('Error:无此用户')
return wrapper
@login
@is_admin
def add_student(name):
print('添加学生信息')
def del_student(name):
print('删除学生信息')
add_student('root')