python装饰器wraps

最新推荐文章于 2024-06-19 08:48:18 发布

原创最新推荐文章于 2024-06-19 08:48:18 发布 · 533 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#python

Python 专栏收录该内容

8 篇文章

订阅专栏

本文介绍了Python装饰器的作用，特别是functools模块中的wraps装饰器，用于在定义装饰器时保留原函数的元信息，如名称和docstring。通过示例展示了未使用和使用wraps装饰器的区别，强调了其在保持函数属性一致性方面的重要性。

为什么要用wraps：Python装饰器（decorator）在实现的时候，被装饰后的函数其实已经是另外一个函数了（函数名等函数属性会发生改变），而我们不希望原来函数的属性被覆盖。
用法：Python的functools包中提供了一个叫wraps的装饰器来消除这样的副作用。**写一个装饰器的时候，在实现之前加上@wrap(func) **，它能保留原有函数的名称和doc string。

参考自：python装饰器的wraps作用

例子：

不加wraps


from functools import wraps   
def my_decorator(func):
    def wrapper(*args, **kwargs):
        '''decorator'''
        print('Calling decorated function...')
        return func(*args, **kwargs)
    return wrapper  
 
@my_decorator 
def example():
    """Docstring""" 
    print('Called example function')
print(example.__name__, example.__doc__)
输出:
('wrapper', 'decorator')
[Finished in 0.2s]

加wraps

from functools import wraps   
def my_decorator(func):
    @wraps(func)             # wraps的用法：写一个装饰器的时候，最好在实现之前加上functools的wrap
    def wrapper(*args, **kwargs):
        '''decorator'''
        print('Calling decorated function...')
        return func(*args, **kwargs)
    return wrapper  
 
@my_decorator 
def example():
    """Docstring""" 
    print('Called example function')
print(example.__name__, example.__doc__)

输出：
('example', 'Docstring')
[Finished in 0.5s]