Python自学成才之路 装饰器必用的wraps注解

保留元信息

先看一个案例:


def my_decorate(func):

    def inner_fun(*args, **kargs):
        print('here is my_decorate')
        func()
    return inner_fun


@my_decorate
def greet():
    print("say hi")


print(greet.__name__)
输出:
inner_fun

Greet函数的名字为何会变成了inner_fun?因为装饰器最终会返回一个可调用对象,而这个可调用对象才是正在最后被执行的,所以greet被装饰器修饰后,得到的是inner_fun这个函数(函数是可调用对象),所以最终greet就变成了inner_fun的一部分,于是乎greet.__name__实际上是inner_fun._name_。那该怎么解决这个问题呢,加上wraps注解。


from functools import wraps

def my_decorate(func):

    @wraps(func)
    def inner_fun(*args, **kargs):
        print('here is my_decorate')
        func()
    return inner_fun


@my_decorate
def greet():
    print("say hi")


print(greet.__name__)
输出:
greet

这里wraps本身也是一个装饰器,这个装饰器是一个带参数的装饰器,参数本身就是greet函数。在获取greet函数元信息时,实际上还是在执行inner_fun._name_,但是inner_fun有wraps装饰器,最终元信息是通过wraps装饰器返回的,wraps装饰器对greet函数做了份拷贝,所以拿到的还是greet函数的元信息。

建议写装饰器时都加上wraps注解,这是一个好习惯,反正是没有坏处的。

去除装饰器

Wraps注解还有一个作用就是去除装饰器。上面案例中的greet函数可以绕开装饰器直接执行:

greet.__wrapped__()
输出:
say hi

这里装饰器编程部分算是完结了,总结一点:无论是类作为装饰器还是函数作为装饰器,当将被装饰的函数作为参数时,需要返回一个可调用对象,这个可调用对象才是后面真正被调用的。同时,记得加上@wraps注解保证被装饰器修饰的函数元信息保持不变。


题外话:
一开始是想写得不一样一点,看了网上大多数都说wraps注解的作用可以使被装饰的函数保留元信息,确实是这样的,但是为什么要保留元信息呢,我找了个遍也不知道这些元信息保留下来到底有什么作用,或者说找不到一个案例来告诉我不加wraps注解后果会很严重。可惜的是自己水平不够,也不想花太多时间来找这个案例,所以这篇文章算是对装饰器连载的补充吧。后面要是找到了这样的案例,再加到进来!


本人是做大数据开发的,在微信上开了个个人号,会经常在上面分享一些学习心得,原创文章都会首发到公众号上,感兴趣的盆友可以关注下哦!
Python自学成才之路 装饰器必用的wraps注解_第1张图片

备注:微信公众号搜索‘大数据入坑指南’

你可能感兴趣的:(python)