Python14_装饰器

Python

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

>>> def now():
...     print('2017-07-16')
...
>>> f=now
>>> f()
2017-07-16

函数对象有一个 __ name__ 属性，可以拿到函数的名字：

>>> now.__name__
'now'
>>> f.__name__
'now

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

本质上，decorator 就是一个返回函数的高阶函数。

要定义一个能打印日志的 decorator，可以定义如下：

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

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

>>> @log
... def now():
...     print('2017-07-16')
...

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

>>> now()
call now():
2017-07-16

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

now = log(now) 

如果 decorator 本身需要传入参数，那就需要编写一个返回 decorator 的高阶函数，写出来会更复杂。比如，要自定义 log 的文本：

>>> def log(text):
...     def decoractor(func):
...         def wrapper(*args,**kw):
...             print('%s,%s():' %(text,func.__name__))
...             return func(*args,**kw)
...         return wrapper
...     return decoractor
...
>>> @log('execute')
... def now():
...     print('2017-07-16')
...
>>> now()
execute,now():
2017-07-16
>>> now.__name__
'wrapper'
>>> now.__name__
'wrapper'

一个完整的 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 decoractor(func):
        @functools.wraps(func)
        def wrapper(*args,**kw):
            print('%s %s():' %(text,func.__name__))
            return func(*args,**kw)
        return wrapper
    return decoractor