Python 装饰器 Decorator

一、装饰器定义

在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)。本质上,Decorator就是一个返回函数的高阶函数。

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

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

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

1 >>>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
...
>>> @log('execute')
... def now():
...    print('2017-12-16')
...
>>> now()
execute now:
2017-12-16

和两层嵌套的decorator相比,3层嵌套的效果是这样的:

1 >>> now = log('execute')(now)

三、functools.wraps

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

1 >>> now.__name__ 2 '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

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

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/a89cde6f31a4213324b87639631b9b2f.html