装饰器:
把一个函数当作参数,返回一个替代版的函数
本质就是一个返回函数的函数
在不改变原函数的基础上,给函数增加功能
对修改是封闭的,对扩展是开放的
1.装饰器的作用
如果没有装饰器,要实现以下结果就需要每调用一个函数,输出一次时间,如果时大量工作的时候就会很麻烦,而且对代码内部进行修改是不安全的,所以装饰器就很方便
import time
def f1():
print('This is a function...')
def f2():
print('This is a function...')
def print_current_time(func):
print(time.time())
func()
print_current_time(f1)
print_current_time(f2)
结果:
1554066263.0608213
This is a function...
1554066263.0608754
This is a function...
利用装饰器实现:
import time
def decorator(func): ##这一行相当于一个外壳
def wrapper(): ##wrapper里不写东西就无法接受参数
print(time.time()) ## 打印系统运行的时间(从1970年1月1日开始)
func() ##调用传进来的函数
return wrapper ##必须有返回的wrpper,不返回就无法执行这个函数
@decorator
def f1():
print('This is a function1...')
def f2():
print('This is a function2...')
f1()
f2() ##f2函数没有加装饰器
结果:
1554066736.4885778
This is a function1...
This is a function2...
用wrapper传递参数:
import time
def decorator(func):
def wrapper(*args):
print(time.time())
func(*args)
return wrapper
@decorator
def f1(func_name):
print('This is a function ' + func_name)
@decorator
def f2(func_name1,func_name2):
print('This is a function ' + func_name1)
print('This is a function ' + func_name2)
f1('test')
f2('test1','test2')
结果:
1554067513.6094644
This is a function test
1554067513.609499
This is a function test1
This is a function test2
接受多个参数和关键字参数
import time
def decorator(func):
def warpper(*args,**kwargs):
print(time.time())
func(*args,**kwargs) ##此处接受的参数与wrapper一致
return warpper
@decorator
def f1(func_name):
print('This is a function ' + func_name)
@decorator
def f2(func_name1,func_name2):
print('This is a function ' + func_name1)
print('This is a function ' + func_name2)
@decorator
def f3(func_name1,func_name2,**kwargs):
print('This is a function ' + func_name1)
print('This is a function ' + func_name2)
print(kwargs)
f1('test')
f2('test1','test2')
f3('test1','test2',a=1,b=2,c='westos')
结果:
1554067750.7821703
This is a function test1
This is a function test2
{'a': 1, 'b': 2, 'c': 'westos'}
练习:
装饰器实现一个函数计时器
1.问题1:被装饰的函数有返回值
2.问题2:如何保留被装饰函数的函数名和帮助信息文档
import time
import random
import string
import functools
li = [random.choice(string.ascii_letters) for i in range(10)]
print(li)
def decorator(fun):
"""这是一个装饰器"""
@functools.wraps(fun) ##这的参数要和装饰器的参数一致,没有这一行打印的是默认的文档,
# 就是wrapper函数的帮助文档
def wrapper(*args,**kwargs):
"""这是一个wrapper函数"""
t1 = time.time()
f = fun(*args,**kwargs)
t2 = time.time()
print('运行时间:%.8f' %(t2 - t1))
return f
return wrapper
@decorator
def con_add():
s = ''
for i in li:
s += (i + ',')
print(s)
@decorator
def join_add():
print(','.join(li))
@decorator
def fun_list(n):
"""这是fun_list函数"""
return [i * 2 for i in range(n)]
@decorator
def fun_map(n):
return list(map(lambda x:x*2,range(n)))
con_add()
join_add()
print(fun_list(10))
print(fun_map(10))
print(fun_list.__doc__)
print(fun_list.__name__)
结果:
['c', 'e', 'k', 'Y', 'L', 'Q', 'z', 'U', 'A', 'b']
c,e,k,Y,L,Q,z,U,A,b,
运行时间:0.00000739
c,e,k,Y,L,Q,z,U,A,b
运行时间:0.00000310
运行时间:0.00000262
[0, 2, 4, 6, 8, 10, 12, 14, 16, 18]
运行时间:0.00000453
[0, 2, 4, 6, 8, 10, 12, 14, 16, 18]
这是fun_list函数
fun_list
注:
print(time.ctime()) ##输出linux系统中的时间
结果:
Mon Apr 1 06:32:42 2019
2.装饰器会出现的问题
(1)问题一:被修饰的函数有返回值
被修饰的函数有返回值,需要在装饰器中将函数的返回值传给一个参数,并返回这个参数,否则返回值为None
import time
import functools
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))
return res ##返回函数的返回值
return wrapper
@add_log
def add(x,y):
time.sleep(1)
return x + y
add(1,2)
结果:
[Mon Apr 1 06:34:38 2019] 函数名: add, 运行时间: 1.000505,运行返回值结果: 3
(2)问题二:保留被装饰函数的函数名和帮助信息文档
<1> 导入functools包,加入@functools.wraps(fun)
<2> 帮助信息的写法:""“帮助信息”""
<3> print(add.doc) ##帮助信息文档
print(add.name) ##函数名
import time
import functools
def add_log(fun):
@functools.wraps(fun) ##<1>
def wrapper(*args,**kwargs):
"""这是一个wrapper函数"""
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))
return res
return wrapper
@add_log
def add(x,y):
"""这是add函数""" ##<2>
time.sleep(1)
return x + y
add(1,2)
print(add.__doc__) ##<3>
print(add.__name__)
结果:
[Mon Apr 1 06:47:08 2019] 函数名: add, 运行时间: 1.001007,运行返回值结果: 3
这是add函数
add
练习:
编写装饰器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(str,int)
def add(a,b):
return a + b
print(add(1.5,2.0))
结果:
TypeError:参数必须为 (<class 'str'>, <class 'int'>) ##参数类型不正确
None
练习: 关于inspect.getcallargs
import functools
import inspect
def is_admin(fun):
@functools.wraps(fun)
def wrapper(*args,**kwargs):
#inspect.getcallargs返回一个字典,key值是形参,value值
#是对应的实参{'name':'root'}
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('not root user!')
return wrapper
@is_admin
def add_user(name):
print('添加用户信息...')
def del_user(name):
print('删除用户信息...')
add_user('root')
结果:
inspect的返回值: {'name': 'root'}
添加用户信息...
3.多个装饰器的执行顺序
通过下面的例子可一看出多个装饰器的执行顺序
装饰器是从上到下执行
装饰器的外壳会从下到上执行
def decorator_a(fun):
print('Get in decorator_a')
def inner_a(*args, **kwargs):
print('Get in inner_a')
res = fun(*args, **kwargs)
return res
return inner_a
def decorator_b(fun):
print('Get in decorator_b')
def inner_b(*args, **kwargs):
print('Get in inner_b')
res = fun(*args, **kwargs)
return res
return inner_b
@decorator_a
@decorator_b
def f(x):
print('Get in f')
return x * 2
f(2)
结果:
Get in decorator_b
Get in decorator_a
Get in inner_a
Get in inner_b
Get in f
练习:
定义装饰器admin:判断用户是否登陆成功
定义装饰器login:判断用户是否为超级用户root
先判断用户是否登陆成功,再判断书不是root用户
import functools
import inspect
def is_admin(fun):
@functools.wraps(fun)
def wrapper(*args,**kwargs):
#inspect.getcallargs返回一个字典,key值是形参,value值
#是对应的实参{'name':'root'}
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('not root user!')
return wrapper
login_session = ['root', 'redhat', 'westos']
def is_login(fun):
@functools.wraps(fun)
def wrapper(*args,**kwargs):
if args[0] in login_session:
res = fun(*args,**kwargs)
return res
else:
print('Error:%s未登录' %args[0])
return wrapper
@is_login
@is_admin
def add_student(name):
print('添加学生信息...')
add_student('redhat')
结果:
inspect的返回值: {'name': 'redhat'}
not root user!