装饰器

来自：廖雪峰

python中函数是一个对象，而且函数可以被赋值给变量，所以，通过变量能调用该函数。

def now():
    print('2013-12-25')
f = now
f()

2013-12-25

函数对象有一个__name__属性，可以得到函数的名字：

now.__name__
f.__name__

'now'

'now'

现在增强now()函数的功能，比如：在函数调用前后自动打印日志，但不希望修改now()函数的定义，这种在代码运行期间动态增加功能的方式，称为“装饰器”。

本质上，装饰器是一个返回函数的高阶函数。所以定义一个能打印日志的装饰器，可以定义如下：

def log(func):
    def wrapper(*args, **kw):
        print('call %s()' % func.__name__)　　 # 内函数调用外函数
        return func(*args, **kw)　　　　　　　 　
    return wrapper　　　　　　　　　　　　　　　   # 外函数返回内函数的值

上面的log，它是一个装饰器，所以接受一个函数作为参数，并返回一个函数。

我们借用@语法，把装饰器置于函数的定义出：

@log
def now():
    print('2013-12-25')

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

print(now())

call now()

2013-12-25 

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

now = log(now)

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

wrapper()函数可以接受任意参数调用，在wrapper()函数内，首次打印日志，再调用原函数。

如果迭代器本身需要传入参数，那就需要编写一个返回迭代器的高阶函数，比如，自定义log的文本：

def log(text):
    def decorator(func):
        def wrapper(*args, **kw):
            print('%s %s():' % (text, func.__name__))
            return func(*args, **kw)
        return wrapper
    return decorator

这个3层嵌套的迭代器用法如下： 

now = log('execute')(now)

我们来剖析上面的语句，首先执行log('execute')，返回的是迭代器函数，再调用返回的函数，参数是now函数，返回值最终是wrapper函数。

以上两种迭代器的定义都没有问题，但还差最后一步。因为我们讲了函数也是对象，它有__name__等属性，但你去看经过迭代器装饰之后的函数，它们的__name__已经从原来的'now'变成了'wrapper'：

>>> now.__name__
'wrapper'

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

不需要编写wrapper.__name__ = func.__name__这样的代码，Python内置的functools.wraps就是干这个事的，所以，一个完整的decorator的写法如下：

import functools

def log(func):
    @functools.wraps(func)
    def wrapper(*args, **kw):
        print 'call %s():' % func.__name__
        return func(*args, **kw)
    return wrapper

或者针对带参数的decorator：

import functools

def log(text):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kw):
            print '%s %s():' % (text, func.__name__)
            return func(*args, **kw)
        return wrapper
    return decorator

import functools是导入functools模块。模块的概念稍候讲解。现在，只需记住在定义wrapper()的前面加上@functools.wraps(func)即可。