装饰器

Posted 2020-10-05 王记不住

装饰器是类似于形容词的存在。它扩展了所修饰的函数。

1. 装饰器入门

1.1. 为什么需要装饰器

def foo():
    print ‘in foo()‘
foo()

就像是在C++中为了验证static的功能，而创建了一个统计自己执行次数的函数一样。我们创建了一个这样的函数，我们想知道运行这个函数花了多长时间。

于是修改代码如下：

import time  
def foo():  
    start= time.clock()  
    print ‘in foo()‘  
    end= time.clock()  
    print ‘used:‘, end - start  
foo() 

但是这样就修改了这个函数，如果这个函数是别人写的，那这样做不好，甚至办不到。而且对于别的函数而言，这样的统计时间功能是完全没办法复用的。

1.2. 另一种不修改函数的方法

我们可以考虑重新定义一个函数timeit，将foo的引用传递给他，然后在timeit中调用foo并进行计时，这样，我们就达到了不改动foo定义的目的，而且，不论看多少个函数，我们都不用去修改函数定义了！

import time  
   
def foo():  
    print ‘in foo()‘  
   
def timeit(func):  
    start= time.clock()  
    func()  
    end=time.clock()  
    print ‘used:‘, end - start  
   
timeit(foo)
<span style="font-family:Verdana, Arial, Helvetica, sans-serif;">
<span style="line-height: 14.399999618530273px;">  
</span></span>  

看起来逻辑上并没有问题，一切都很美好并且运作正常！……等等，我们似乎修改了调用部分的代码。原本我们是这样调用的：foo()，修改以后变成了：timeit(foo)。这样的话，如果foo在N处都被调用了，你就不得不去修改这N处的代码。或者更极端的，考虑其中某处调用的代码无法修改这个情况，比如：这个函数是你交给别人使用的。

1.3. 最大限度地少改动！

如果不修改调用代码，也就意味着调用foo()需要产生调用timeit(foo)的效果。我们可以想到将timeit赋值给foo，但是timeit似乎带有一个参数……想办法把参数统一吧！如果timeit(foo)不是直接产生调用效果，而是返回一个与foo参数列表一致的函数的话……就很好办了，将timeit(foo)的返回值赋值给foo，然后，调用foo()的代码完全不用修改

#-*-coding: UTF-8 -*-
import time
 
def foo():
    print ‘in foo()‘
 
#定义一个计时器，传入一个，并返回另一个附加了计时功能的方法
def timeit(func):
     
    #定义一个内嵌的包装函数，给传入的函数加上计时功能的包装
    def wrapper():
        start= time.clock()
        func()
        end=time.clock()
        print ‘used:‘,end - start
     
    #将包装后的函数返回
    return wrapper
 
foo= timeit(foo)
foo()

这样，一个简易的计时器就做好了！我们只需要在定义foo以后调用foo之前，加上foo = timeit(foo)，就可以达到计时的目的，这也就是装饰器的概念，看起来像是foo被timeit装饰了。在在这个例子中，函数进入和退出时需要计时，这被称为一个横切面(Aspect)，这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。与传统编程习惯的从上往下执行方式相比较而言，像是在函数执行的流程中横向地插入了一段逻辑。在特定的业务领域里，能减少大量重复代码。面向切面编程还有相当多的术语，这里就不多做介绍，感兴趣的话可以去找找相关的资料。

注意，上述代码中必须定义一个嵌套函数，不然将会引发错误“TypeError: ‘NoneType‘ object is not callable”

2. Python的额外支持

2.1. 语法糖

Python提供了一个语法糖来降低字符输入量。

import time
 
def timeit(func):
    def wrapper():
        start= time.clock()
        func()
        end=time.clock()
        print ‘used:‘,end - start
    return wrapper
 
@timeit
def foo():
    print ‘in foo()‘
 
foo()

重点关注第11行的@timeit，在定义上加上这一行与另外写foo = timeit(foo)完全等价，千万不要以为@有另外的魔力。除了字符输入少了一些，还有一个额外的好处：这样看上去更有装饰器的感觉。

2.2. 内置的装饰器

内置的装饰器有三个，分别是staticmethod、classmethod和property，作用分别是把类中定义的实例方法变成静态方法、类方法和类属性。由于模块里可以定义函数，所以静态方法和类方法的用处并不是太多，除非你想要完全的面向对象编程。而属性也不是不可或缺的，Java没有属性也一样活得很滋润。从我个人的Python经验来看，我没有使用过property，使用staticmethod和classmethod的频率也非常低。

==