Decorator更容易编写python装饰器代码,更重要的是,它使python中装饰为装饰器的方法看起来像装饰前的方法。
普通装饰机
以下是在运行myfunc函数前后打印日志的最简单的装饰器示例。
Defdeco(func):
Defwrapper(*args,**kw):
打印(' ready to runtask ')
Func(*args,**kw)
Print('Successfultoruntask ')
Returnwrapper
@deco
Defmyfunc():
Print('Runningthetask ')
Myfunc()装饰器看起来很高级,很神奇,一些重复的功能经常被装饰器函数封装。
定义装饰器的时候,要用上面这样机械嵌套的函数,不太理解装饰器原理的初学者往往会随着时间的推移忘记如何定义装饰器。
有一些聪明的学生利用PyCharm自动生成装饰器模板。
然后在使用时直接按deco,将生成简单的生成器代码,从而提高编码准备效率。
使用报警
使用PyCharm的Live Template可以减少编写装饰器的困难,但必须依赖名为PyCharm的专业代码编辑器。
这里推荐一个更简单的方法。要使用此方法,必须先安装库。使用decorator、pip可以轻松安装。
$python3-mpipinstalldecorator库名称表明,该库是用于解决装饰器问题的第三方库。
之后,以后自己定义的装饰器不再需要使用嵌套函数
Fromdecoratorimportdecorator
@decorator
Defdeco(func、*args、**kw):
打印(' ready to runtask ')
Func(*args,**kw)
Print('Successfultoruntask ')
@deco
Defmyfunc():
Print('Runningthetask ')
Myfunc()deco是装饰函数,第一个参数是固定的,指向装饰函数,下一个参数是使用变量*args和**kw固定的,代码使用装饰函数的原始参数。
这种写法更符合直觉,代码的逻辑也更容易理解。
我可以使用有参数的装饰器吗?
装饰器可以根据是否有搬运参数分为两种
第一个:没有参数最简单的例子已经是例子了
Defdecorator(func):
Defwrapper(*args,**kw):
Func(*args,**kw)
Returnwrapper的第二个:有参数。这比较复杂,不容易理解。
Defdecorator(arg1、arg2):
Defwrapper(func):
Defdeco(*args,**kwargs)
Func(*args,**kwargs)
Returndeco
Returnwrapper能很好地支持decorator吗?
下面是一个正式的例子
Fromdecoratorimportdecorator
@decorator
Defwarn _ slow (func,timelimit=60,* args,* * kw) :
T0=()
Result=func(*args,**kw)
Dt=()-t0
Ifdttimelimit:
Logging.warn ('%stook% dseconds 'dt)
Else:
Logging.info ('%stook% dseconds 'dt)
Returnresult
@ warn _ slow(time limit=600)# warnifittakesmor
e than 10 minutes def run_calculation(tempdir, outdir): pass可以看到
- 装饰函数的第一个参数,还是被装饰器 func ,这个跟之前一样
- 而第二个参数 timelimit 写成了位置参数的写法,并且有默认值
- 再往后,就还是跟原来一样使用了可变参数的写法
不难推断,只要在装饰函数中第二个参数开始,使用了非可变参数的写法,这些参数就可以做为装饰器调用时的参数。
签名问题有解决?
在自己写装饰器的时候,通常都会顺手加上一个叫的装饰器,那他有啥用呢?
先来看一个例子
def wrapper(func):
def inner_function():
pass
return inner_function
@wrapper
def wrapped():
pass
prin)
#inner_function
为什么会这样子?不是应该返回func吗?
这也不难理解,因为上边执行func和下边decorator(func) 是等价的,所以上面是等价于下面decorator(func).__name__的,那当然名字是inner_function
def wrapper(func):
def inner_function():
pass
return inner_function
def wrapped():
pass
print(wrapper(wrapped).__name__)
#inner_function
目前,可以看到当一个函数被装饰器装饰过后,它的签名信息会发生变化(譬如上面看到的函数名)
那如何避免这种情况的产生?
解决方案就是使用前面所说的 functools .wraps 装饰器。
它的作用就是将 被修饰的函数(wrapped) 的一些属性值赋值给 修饰器函数(wrapper) ,最终让属性的显示更符合直觉。
from functools import wraps
def wrapper(func):
@wraps(func)
def inner_function():
pass
return inner_function
@wrapper
def wrapped():
pass
prin)
# wrapped
那么问题就来了,使用了 decorator 之后,是否还会存在这种签名的问题呢?
写个例子来验证一下就知道了
from decorator import decorator
@decorator
def deco(func, *args, **kw):
print("Ready to run task")
func(*args, **kw)
print("Successful to run task")
@deco
def myfunc():
print("Running the task")
print(my)
输出的结果是myfunc,说明decorator已经默认处理了一切可预见的问题.
总结
decorator是一个提高装饰器编码效率的第三方库,它适用于对装饰器原理感到困惑的新手,可以让你很轻易的写出更符合人类直觉的代码。
对于带参数装饰器的定义,是非常复杂的,它需要要写多层的嵌套函数,并且需要熟悉各个参数的传递路径,才能保证写出来的装饰器可以正常使用。
这时候,只要用上decorator这个库,就可以很轻松的写出一个带参数的装饰器。同时也不用担心他会出现签名问题,这些它都妥善的处理好了。