functools.wraps

functools.wraps 是 Python 标准库中的一个装饰器，它用于更新包装后的函数的信息（如文档字符串、注解等），使得包装后的函数看起来像是原始函数。这对于那些需要修改或扩展其他函数行为的装饰器来说非常有用，因为它可以帮助保持函数的元信息（如函数名、文档字符串、注解等）的一致性。

当你编写一个装饰器时，通常会返回一个包装函数，而这个包装函数可能会丢失原函数的一些元信息。使用 functools.wraps 可以解决这个问题。

示例代码

下面是一个简单的例子，展示了如何使用 functools.wraps 来装饰一个函数，并保留其元信息：

import functools

def my_decorator(func):
    @functools.wraps(func)  # 保留原函数的信息
    def wrapper(*args, **kwargs):
        print("Before calling the function")
        result = func(*args, **kwargs)
        print("After calling the function")
        return result
    return wrapper

@my_decorator
def add(a, b):
    """Adds two numbers."""
    return a + b

print(add.__name__)  # 输出: add
print(add.__doc__)   # 输出: Adds two numbers.

如果没有使用 functools.wraps，则包装函数会显示为装饰器函数的名字和文档字符串，而不是原始函数的信息。

不使用 functools.wraps 的情况

如果不使用 functools.wraps，则包装后的函数将不会保留原函数的信息：

def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("Before calling the function")
        result = func(*args, **kwargs)
        print("After calling the function")
        return result
    return wrapper

@my_decorator
def add(a, b):
    """Adds two numbers."""
    return a + b

print(add.__name__)  # 输出: wrapper
print(add.__doc__)   # 输出: None

可以看到，在这种情况下，add 函数的名称和文档字符串都显示为 wrapper 的信息。

总结来说，functools.wraps 是一个很有用的工具，它可以确保装饰器不会改变被装饰函数的行为，并且能够正确地保留函数的元信息。这对于调试、文档编写和其他依赖于函数元信息的应用场景非常重要。