Python装饰器(2)
上一篇介绍了装饰器的常规使用方法,即函数形式的装饰器。这篇文章中,进一步介绍类class跟装饰器的相关知识。
【用装饰器来装饰类函数】
这是今天介绍的第一种使用场景,比较常见。因为目前好多的编程语言都面向对象,于是日常工作中也就难免需要我们去“装饰”它们的方法了。
先看代码示例:
import time def debug(func): #传参接受类的方法 def func1(my,m,n): #原类方法有三个参数,故内层函数需要传递相同的参数 print("a=%d\tb=%d" % (m,n)) func(my,m,n) return func1 #返回内层函数 class test(): @debug def myAdd(self,a,b): print(a + b) if __name__ == "__main__": myIns=test() myIns.myAdd(2,3)
其执行结果如下:
可见,跟装饰普通的函数的用法一样,只是注意因为装饰的对象是类函数,所以需要跟类函数一样多传递一个表示对象本身的参数即可。
【用类的实例对象来装饰函数】
这是今天介绍的第二种使用场景,也是比较晦涩的一种用法。因为通过__call__重写运算符()后,类的实例对象也就具有了callable,从而实现跟函数一样形式的使用。
讲解原理之前,我们先来看一个代码示例(示例中的装饰器需要传参):
import time class debug(object): def __init__(self,n): #初始化函数中传递装饰器的参数 self.n=n def __call__(self,func): #实例的调用函数中传递目标函数名称,相当于函数类型装饰器的外层函数 def func1(*args,**kwargs): #内层函数传递目标函数执行所需要的参数 for i in range(1,self.n+1,1): time.sleep(1) print("Time flies: %d" % (i)) print("\n\rStarting...") func(*args,**kwargs) #目标函数真正执行,上下文即为增加的装饰功能 print("Stopped...") return func1 #return返回内层函数的名称 @debug(3) #装饰器携带参数,让sleep N秒后再执行目标函数 def outputName(name): print("\tHello,%s" % (name)) if __name__ == "__main__": outputName("Elon Musk")
其执行的结果如下:
大家可能有疑问,为什么装饰器的参数一定要通过初始化函数传递,不能类似函数形式那样直接定义一个三层嵌套的闭包函数吗?答案是:不能!
下面我们来通过调试代码来看看深藏其中的原理背景。
首先,我删除初始化函数的定义同时改写__call__()函数使其回归三层嵌套定义的闭包函数形式。此时的执行结果如下:
为什么会报错呢?因为我们在类的定义中没有明确定义__init__()这个初始化函数,则在类实例化的时候就认为该类不需要参数。但我们的装饰器调用格式却带了参数,因此报错。
我们都是知错能改的好公民嘛。于是追加初始化函数__init__()的定义,代码改写如下:
import time class debug(object): def __init__(self,n): self.n=n def __call__(self): def func1(func): def func2(*args,**kwargs): for i in range(1,self.n+1,1): time.sleep(1) print("Time flies: %d" % (i)) print("\n\rStarting...") func(*args,**kwargs) print("Stopped...") return func2 return func1 @debug(3) #装饰器携带参数,让sleep N秒后再执行目标函数 def outputName(name): print("\tHello,%s" % (name)) if __name__ == "__main__": outputName("Elon Musk")
其执行的结果如下:
为什么又报错了呢?细看错误提示,是说__call__()只需要一个参数,我们却传递了两个。
通过上一篇的介绍,我们知道装饰器@的本质相当于把目标函数的名称作为参数传递给了装饰器。所以,debug(3)其实得到的是一个对象实例,此时是要把目标函数名称传参给类的对象。虽然我们通过定义__call__()使得对象具有callable,但__call__()定义的时候只有一个self参数,并没有函数名称这个参数。
好了,一切真相大白。我们继续改写代码并运行,于是我们最终得到了刚开始看到的那段代码:
好了,至此大家应该也都终于明白了为什么通过类来装饰函数的时候一定要通过__call__()来实现,并且装饰器的传参不能通过三层嵌套__call__()来实现。
下面再补充一个不需要传参的类装饰器代码及其执行结果,比上面的示例简单了许多,个中的道理跟上面类似,大家可以自行体会下(如果有不明白的地方,欢迎大家评论留言,鄙人定当及时回复):