00311 Python @wraps装饰器

Python

发布日期: 2025-03-12

更新日期: 2025-03-12

前言

Python @wraps装饰器。

Operating System: Ubuntu 22.04.4 LTS

参考文档

介绍

@wraps 是 Python 标准库 functools 模块中的一个装饰器。它通常用于定义装饰器时，以便保留被装饰函数的原始属性，如 __name__、__doc__、__module__ 以及其他的一些属性。

在详细解释 @wraps 之前，我们先来看看什么是装饰器。

装饰器

装饰器是一种特殊类型的函数，它可以用来修改其他函数的功能。装饰器本质上是一个接受函数作为参数并返回一个新函数的函数。装饰器在 Python 中通过 @ 符号加装饰器名称来使用。

为什么需要 `@wraps`

当我们使用装饰器来修改函数时，新返回的函数通常会覆盖原始函数的一些属性，比如名字和文档字符串。这意味着如果你尝试打印被装饰函数的名字或文档字符串，你可能会得到与预期不同的结果。

例如，如果我们定义一个简单的装饰器：

def my_decorator(func):
    def wrapper():
        print("Something is happening before the function is called.")
        func()
        print("Something is happening after the function is called.")
    return wrapper

@my_decorator
def say_hello():
    """Prints hello"""
    print("Hello!")

print(say_hello.__name__)  # 输出: wrapper

在这个例子中，say_hello 函数被 my_decorator 装饰，但是当我们打印 say_hello.__name__ 时，输出是 wrapper 而不是 say_hello。这是因为装饰器返回的是 wrapper 函数，它覆盖了 say_hello 的 __name__ 属性。

使用 `@wraps`

为了解决这个问题，我们可以使用 @wraps 装饰器来更新 wrapper 函数的属性，使其看起来更像原始的 say_hello 函数。

下面是使用 @wraps 的例子：

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper():
        print("Something is happening before the function is called.")
        func()
        print("Something is happening after the function is called.")
    return wrapper

@my_decorator
def say_hello():
    """Prints hello"""
    print("Hello!")

print(say_hello.__name__)  # 输出: say_hello