Python中的装饰器使用

Python装饰器用法

Python的装饰器是个好东西，它能干很多事情。

但对于新手，它看起来似乎没那么简单。

但事实上，装饰器本身也只是个函数。

import time
def log(func):
    def wrapper(*args, **kwargs):
        start = time.time()
        result = func(*args, **kwargs)
        end = time.time()
        print("The func '{}' used {}s.".format(func.__name__, end-start))
        return result
    return warpper

这一个装饰器，当我们这样使用时

@log
def fucok(name):
    """Fucok someone"""
    print("Fucok", name)

它只是执行了fucok = log(fucok)这样一句代码而已。

也就是说，我们表面上是用fucok("myself")，事实上执行的都是log(fucok)("myself")。因为Python里面都是对象嘛。

同样的道理，假设我们定义了一个带参数的装饰器logging，它实际上执行的是

func = logging(arguments)(func)

也就是上面那个不带参数的装饰器多定义一层就行了。

import time
def logging(arguments):
    def log(func):
        def warpper(*args, **kwargs):
            start = time.time()
            result = func(*args, **kwargs)
            end = time.time()
            print("The func '{}' used {}s.".format(func.__name__, end-start))
            return result
        return warpper
    # do something
    return log

但，当我们使用一个装饰器之后，它会将原本的函数元信息给覆盖掉。譬如：函数名称，函数文档等等。

例如上例

print(fucok.__name__)
print(fucok.__doc__)

你会发现，函数信息全部没了！fucok它不叫fucok，改名叫wrapper了。它的文档也变成了none。

解决办法很简单，定义装饰器的时候用warps装饰器装饰接受原函数参数的那一层就行了。

这个来自functools模块的装饰器能帮你复制函数的元信息到被绑定的函数身上。

修改装饰器如下(其实就加了一行代码hhh)

import time
from functools import wraps
def log(func):
    @wraps(func)
    def warpper(*args, **kwargs):
        start = time.time()
        result = func(*args, **kwargs)
        end = time.time()
        print("The func '{}' used {}s.".format(func.__name__, end-start))
        return result
    return warpper

当我们再运行

print(fucok.__name__)
print(fucok.__doc__)

就能看到函数的的元信息没变了。

装饰器定义时加@wraps是个好习惯。

一个较为实用的装饰器demo在该专题的另一篇文章：函数参数类型检查

来源：https://www.jianshu.com/p/4416e291c64d