Python学习笔记之装饰器

现在我们有一个函数：

# 一个函数
def now():
    print('2019-07-12')

假设我们想增加它的功能，在每次调用该函数时，都打印一下日志，但是不能更改这个函数 now() 的定义，那么就可以采用装饰器。在代码运行期间动态增加功能的方式，称之为“装饰器”（Decorator）。下面代码展示了如何定义一个装饰器：

# 定义一个打印日志的装饰器
def log(func):
    def wrapper(*args, **kw):
        print('call %s():' % func.__name__)
        return func(*args, **kw)
    return wrapper

本质上，装饰器就是一个返回函数的高阶函数。log() 函数中定义了一个 wrapper() 函数，并且返回该 wrapper() 函数。注意，wrapper(*args, **kw) 是固定的写法， wrapper() 函数可以接受任意参数的调用 （注：参数具体含义看文章最后）。在 wrapper() 函数中，首先打印了日志，紧接着调用原始的函数。
如何使用该装饰器呢？这就需要借助Python的@语法，把装饰器置于函数的定义处：

# 使用 @ 语法将装饰器与函数绑定
@log
def now():
    print('2019-07-11')
# 调用 now() 函数的结果：
# call now():
# 2019-7-12

注意，装饰器要出现在函数的前边，否则 @log 语法会报错。把@log放到now()函数的定义处，相当于执行了语句：

# 把 @log 放到 now() 函数的定义处，相当于执行下边的语句：
now = log(now)

这样的装饰器有一个缺点，就是日志是固定的。如果想自定义日志文本呢？具体代码如下：

# 定义一个返回装饰器的高阶函数
def log(text):
    def decorator(func):
        def wrapper(*args, **kw):
            print('%s %s():' %(text, func._name_))
            return func(*args, **kw)
        return wrapper
    return decorator

同样使用@语句与 now() 函数绑定：

@log('execute')
def now():
    print('2019-07-12')
# 调用 now() 函数的结果：
# execute now():
# 2019-7-12

三层嵌套的效果如下：

now = log('execute')(now)

log() 函数接受一个字符串参数，并且返回一个装饰器。返回的装饰器接收一个函数参数，这和上面不自定义日志文本的装饰器就一样了。
还有一点需要说明，decorator() 函数返回的是 wrapper() 函数，然后 wrapper() 函数中再调用原来的 now() 函数。所以 now 这一变量，就变成了 wrapper() 函数。试试调用 now.name 看看是什么结果：

# now 是否改变了自己的属性
print(now.__name__)
# 结果：wrapper

所以，now 已经改变了。如何解决呢？Python 有专门解决该问题的方法，就是引入 functools 包，并且在 wrapper() 函数前添加一条语句：@functools.wraps(func)。看看一个完整的自定义文本装饰器的定义：

# 一个完整的装饰器定义
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

注：
(*args, **kw) 参数的含义：一个*代表的是list，即可变参数，两个*代表的是dict，即关键字参数。