Python装饰器是怎么回事？

Python装饰器在python开发过程中，经常被使用。今天看了廖老师的文章之后，对装饰器有了更深的理解。整理如下。

楔子

比如有一个现成的函数，它是有别人写的，我们只能调用它不能修改它。但是我又想在我调用它的时候能够在函数调用前和调用后做一些事情，对该函数进行功能扩展。这种在代码运行期间动态增加函数功能的需求，我们可以通过“装饰器”（Decorator）来实现。

在实际应用中，比如测试函数的调用，我们想每次运行测试代码之前进行测试数据的准备，在测试函数执行后进行测试数据的清理。通过装饰器就可以满足我们的需求。在py.test单元测试框架中的fixture其实就是装饰器。

无参数的装饰器

先定义一个now函数，用来获取当前的时间。

import time

def now():
    print time.localtime()

now()

运行上面这段代码，输出如下：

time.struct_time(tm_year=2015, tm_mon=3, tm_mday=3, tm_hour=16, tm_min=35, tm_sec=16, tm_wday=1, tm_yday=62, tm_isdst=0)

现在，我想要增强 now()函数的功能，比如，在函数调用前后自动打印日志，但又不希望修改 now()函数的定义。我们要定义一个能打印日志的装饰器decorator，可以定义如下：

def fixture1(func):
    def wrapper(*args,**kw):
        print 'before invoking %s' %func.__name__
        func(*args,**kw)
        print 'after invoking %s' %func.__name__
    return wrapper

观察上面的 fixture1，因为它是一个decorator，所以接受一个函数func作为参数，并返回一个函数wrapper。我们要借助Python的@语法糖，把decorator置于函数的定义处：

@fixture1
def now():
    print time.localtime()

调用 now()函数，不仅会运行 now()函数本身，还会在运行 now()函数前后打印一行日志：

before invoking now
time.struct_time(tm_year=2015, tm_mon=3, tm_mday=3, tm_hour=16, tm_min=35, tm_sec=16, tm_wday=1, tm_yday=62, tm_isdst=0)
after invoking now

把@fixture1放到now()函数的定义处，相当于执行了语句：

now = fixture1(now)

由于 fixtrue1()是一个decorator，返回一个函数，所以，原来的 now()函数仍然存在，只是现在同名的now变量指向了新的函数，于是调用 now()将执行新函数，即在 fixture1()函数中返回的 wrapper()函数。

wrapper()函数的参数定义是(*args, **kw)，因此，wrapper()函数可以接受任意参数的调用。在wrapper()函数内，首先打印日志，再紧接着调用原始函数。

我们知道函数都有 __name__等属性，但你去看经过decorator装饰之后的函数，它们的 __name__已经从原来的 'now'变成了 'wrapper'：

>>> now.__name__
'wrapper'

因为返回的那个wrapper()函数名字就是'wrapper'，所以，需要把原始函数的__name__等属性复制到wrapper()函数中，否则，有些依赖函数签名的代码执行就会出错。

不需要编写 wrapper.__name__ = func.__name__这样的代码，Python内置的 functools.wraps就是干这个事的，在定义 wrapper()的前面加上 @functools.wraps(func)即可。

import functools

def fixture1(func):
    @functools.wraps(func)
    def wrapper(*args,**kw):
        print 'before invoking %s' %func.__name__
        func(*args,**kw)
        print 'after invoking %s' %func.__name__
    return wrapper

有参数的装饰器

如果decorator本身需要传入参数，那就需要编写一个返回decorator的高阶函数，写出来会更复杂。比如，要自定义输入日志的文本。写完了不带参数的装饰器，在不带参数的装饰器最外边再嵌套一层形成3曾嵌套的decorator。

import functools

def fixture2(arg):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args,**kw):
            print 'before invoking %s() with %s' % (func.__name__,arg)
            func(*args,**kw)
            print 'after invoking %s() with %s' % (func.__name__,arg)
        return wrapper
    return decorator  

与不带参数的装饰器对比，就是在不带参数的装饰器增加了两行代码：

def fixture2(arg):
......
    return decorator  

灵活参数的装饰器

能否写出一个@fixture的decorator，使它既支持：

@fixture
def now():
    print time.localtime()

又支持：

@fixture('parameter')
def now():
    print time.localtime()

想都不用想，肯定能了。代码如下：

def fixture(arg):
    if hasattr(arg,'__call__'):
        @functools.wraps(arg)
        def wrapper(*args,**kw):
            print 'before invoking %s' %arg.__name__
            arg(*args,**kw)
            print 'after invoking %s' %arg.__name__
        return wrapper
    
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args,**kw):
            print 'before invoking %s() with %s' % (func.__name__,arg)
            func(*args,**kw)
            print 'after invoking %s() with %s' % (func.__name__,arg)
        return wrapper
    return decorator 

就是在带参数的装饰器里面加一个if语句：

if hasattr(arg,'__call__'):

if语句体里面写的就是不带参数的decorator。

这里对if语句进行解释下：

对于任何可调用的方法都具有__call__属性，也就是说，我们可以通过:

hasattr(arg,'__call__')

判断arg是否是一个可调用方法，如果是一个可调用的方法那么hasattr应该返回True，如果不是应该返回false。如果arg是一个可调用的方法，那么fixture就应该是一个不带参数的decorator，而如果arg不是一个可调用的方法，那么fixture应该是一个带参数的decorator。