欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

python中装饰器修复技术

程序员文章站 2022-10-04 10:53:18
python装饰器@wraps作用 修复被装饰后的函数名等属性的改变 Python装饰器(decorator)在实现的时候,被装饰后的函数其实已经是另外一个函数了(函数名等函数属性会发生改变), 为了不影响,Python的functools包中提供了一个叫wraps的decorator来消除这样的副 ......

python装饰器@wraps作用-修复被装饰后的函数名等属性的改变
python装饰器(decorator)在实现的时候,被装饰后的函数其实已经是另外一个函数了(函数名等函数属性会发生改变),

为了不影响,python的functools包中提供了一个叫wraps的decorator来消除这样的副作用。写一个decorator的时候,最好在实现之前加上functools的wrap,

它能保留原有函数的名称和docstring。

未加@wraps的时候:

from functools import wraps


def wrapper(func):
    # @wraps(func)
    def inner(*args, **kwargs):
        print("装饰器工作中...")
        func(*args, **kwargs)
    return inner


@wrapper
def f1(arg):
    """
    这是一个测试装饰器修复技术的函数
    :param arg: 随便传
    :return: 没有
    """
    print(arg)

f1('呵呵')
print(f1.__name__,f1.__doc__)

打印结果是:
python中装饰器修复技术

但是加上@wraps以后:

from functools import wraps


def wrapper(func):
    @wraps(func)
    def inner(*args, **kwargs):
        print("装饰器工作中...")
        func(*args, **kwargs)
    return inner


@wrapper
def f1(arg):
    """
    这是一个测试装饰器修复技术的函数
    :param arg: 随便传
    :return: 没有
    """
    print(arg)

f1('呵呵')
print(f1.__name__,f1.__doc__)

打印结果是:
python中装饰器修复技术

其中主要的就是两个变量:

1、显示 正在执行的函数的名称 f.name
2、显示 正在执行的函数的注释 f.doc

简单来说就是:

如果没使用@wraps,当a调用了装饰器b的话,即使a.name,返回的会是装饰器b的函数名称,而不是a的函数名称
如果使用了@wraps,当a调用了装饰器b的话,a.__ name__返回的会是a函数的名称,而不是饰器b的名称,
这也即使常说的@wraps是装饰器的修复技术,
实际就是修复还原了a的__ name__变量,同理__ doc__变量也是一样。