python函数修饰符@的作用是为现有函数增加额外的功能,常用于插入日志、性能测试、事务处理等等。
创建函数修饰符的规则:
(1)修饰符是一个函数
(2)修饰符取被修饰函数为参数
(3)修饰符返回一个新函数
(4)修饰符维护被维护函数的签名
例子1:被修饰函数不带参数
deflog(func):defwrapper():print('log开始 ...')
func()print('log结束 ...')returnwrapper
@logdeftest():print('test ..')
test()
运行结果:
log开始 ...
test ..
log结束 ...
例子2:使用functools模块提供的修改函数属性的方法wraps
deflog(func):defwrapper():print('log开始 ...')
func()print('log结束 ...')returnwrapper
@logdeftest1():print('test1 ..')deftest2():print('test2 ..')print(test1.__name__)print(test2.__name__)
运行结果:
wrapper
test2
可见test1的函数名称变了,如果某些代码用到就会出问题,可以使用functools模块提供的修改函数属性的方法wraps
from functools importwrapsdeflog(func):
@wraps(func)defwrapper():print('log开始 ...')
func()print('log结束 ...')returnwrapper
@logdeftest1():print('test1 ..')deftest2():print('test2 ..')print(test1.__name__)print(test2.__name__)
运行结果:
test1
test2
例子3:被修饰函数带参数
from functools importwrapsdeflog(func):
@wraps(func)def wrapper(*args,**kwargs):print('log开始 ...',func.__name__)
ret= func(*args,**kwargs)print('log结束 ...')returnretreturnwrapper
@logdeftest1(s):print('test1 ..', s)returns
@logdeftest2(s1, s2):print('test2 ..', s1, s2)return s1 +s2
test1('a')
test2('a','bc')
运行结果:
log开始 ... test1
test1 .. a
log结束 ...
log开始 ... test2
test2 .. a bc
log结束 ...
例子4:修饰符带参数,需要比上面例子多一层包装
from functools importwrapsdeflog(arg):def_log(func):
@wraps(func)def wrapper(*args,**kwargs):print('log开始 ...',func.__name__, arg)
ret= func(*args,**kwargs)print('log结束 ...')returnretreturnwrapperreturn_log
@log('module1')deftest1(s):print('test1 ..', s)returns
@log('module1')deftest2(s1, s2):print('test2 ..', s1, s2)return s1 +s2
test1('a')
test2('a','bc')
运行结果:
log开始 ... test1 module1
test1 .. a
log结束 ...
log开始 ... test2 module1
test2 .. a bc
log结束 ...