[Python学习]decorator的使用

来自：limodou的学习记录

[Python学习]decorator的使用

在我之前介绍 Python 2.4 特性的Blog中已经介绍过了decorator了，不过，那时是照猫画虎，如今再仔细描述一下它的使用。

关于decorator的详细介绍在 Python 2.4中的What’s new中已经有介绍，你们能够看一下。

如何调用decorator

基本上调用decorator有两种形式

第一种：

@A
def f ():
    …

这种形式是decorator不带参数的写法。最终 Python 会处理为：

f = A(f)

还能够扩展成：

@A
@B
@C
def f ():
    …

最终 Python 会处理为：

f = A(B(C(f)))

注：文档上写的是@A @B @C的形式，但其实是不行的，要写成多行。 并且执行顺序是按函数调用顺序来的，先最下面的C，而后是B，而后是A。所以，若是decorator有顺序话，必定要注意：先要执行的放在最下面，最后执行的放在最上面。 (应该不存在这种倒序的关系)

第二种：

@A(args)
def f ():
    …

这种形式是decorator带参数的写法。那么 Python 会处理为：

def f(): …
_deco = A(args)
f = _deco(f)

能够看出， Python 会先执行A(args)获得一个decorator函数，而后再按与第一种同样的方式进行处理。

decorator函数的定义

每个decorator都对应有相应的函数，它要对后面的函数进行处理，要么返回原来的函数对象，要么返回一个新的函数对象。请注意，decorator只用来处理函数和类方法。

第一种：

针对于第一种调用形式

def A(func):
    #处理func
    #如func.attr=’decorated’
    return func
@A
def f(args):pass

上面是对func处理后，仍返回原函数对象。这个decorator函数的参数为要处理的函数。若是要返回一个新的函数，能够为：

def A(func):
    def new_func(args):
        #作一些额外的工做
        return func(args) #调用原函数继续进行处理
    return new_func
@A
def f(args):pass

要注意 new_func的定义形式要与待处理的函数相同，所以还能够写得通用一些，如：

def A(func):
    def new_func(*args, **argkw):
        #作一些额外的工做
        return func(*args, **argkw) #调用原函数继续进行处理
    return new_func
@A
def f(args):pass

能够看出，在A中定义了新的函数，而后A返回这个新的函数。在新函数中，先处理一些事情，好比对参数进行检查，或作一些其它的工做，而后再调原始的函数进行处理。这种模式能够当作，在调用函数前，经过使用decorator技术，能够在调用函数以前进行了一些处理。若是你想在调用函数以后进行一些处理，或者再进一步，在调用函数以后，根据函数的返回值进行一些处理能够写成这样：

def A(func):
    def new_func(*args, **argkw):
        result = func(*args, **argkw) #调用原函数继续进行处理
        if result:
            #作一些额外的工做
            return new_result
        else:
            return result
    return new_func
@A
def f(args):pass

第二种：

针对第二种调用形式

在文档上说，若是你的decorator在调用时使用了参数，那么你的decorator函数只会使用这些参数进行调用，所以你须要返回一个新的decorator函数，这样就与第一种形式一致了。

def A(arg):
    def _A(func):
        def new_func(args):
            #作一些额外的工做
            return func(args)
        return new_func
    return _A
@A(arg)
def f(args):pass

能够看出A(arg)返回了一个新的 decorator _A。

decorator的应用场景

不过我也一直在想，到底decorator的魔力是什么？适合在哪些场合呢？是否我须要使用它呢？

decorator的魔力就是它能够对所修饰的函数进行加工。那么这种加工是在不改变原来函数代码的状况下进行的。有点象我知道那么一点点的AOP(面向方面编程)的想法。

它适合的场合我能想到的列举出下：

1. 象文档中所说，最初是为了使调用staticmethod和classmethod这样的方法更方便
2. 在某些函数执行前作一些工做，如web开发中，许多函数在调用前须要先检查一下用户是否已经登陆，而后才能调用
3. 在某此函数执行后作一些工做，如调用完毕后，根据返回状态写日志
4. 作参数检查

可能还有许多，你能够自由发挥想象

那么我须要用它吗？

我想那要看你了。不过，我想在某些状况下，使用decorator能够增长程序的灵活性，减小耦合度。好比前面所说的用户登陆检查。的确能够写一个通用的登陆检查函数，而后在每一个函数中进行调用。但这样会形成函数不够灵活，并且增长了与其它函数之间的结合程度。若是用户登陆检查功能有所修改，好比返回值的判断发生了变化，有可能每一个用到它的函数都要修改。而使用decorator不会形成这一问题。同时使用decorator的语法也使得代码简单，清晰(一但你熟悉它的语法的话)。固然你不使用它是能够的。不过，这种函数之间相互结合的方式，更符合搭积木的要求，它能够把函数功能进一步分解，使得功能足够简单和单一。而后再经过decorator的机制灵活的把相关的函数串成一个串，这么一想，还真是不错。好比下面：

@A
@B
def account(args):pass

假设这是一个记账处理函数，account只管记账。但一个真正的记账还有一些判断和处理，好比：B检查账户状态，A记日志。这样的效果实际上是先检查B、经过在A中的处理能够先执行account，而后再进行记日志的处理。象搭积木同样很方便，改起来也容易。甚至能够把account也写成decorator，而下面执行的函数是一个空函数。而后再经过配置文件等方法，将decorator的组合保存起来，就基本实现功能的组装化。是否是很是理想。

Python 带给人的创造力真是无穷啊！