`functools.wraps` 在 Python 装饰器中做什么？

揭示 functools.wraps 的功能

在 Python 装饰器领域内，出现了一个问题：functools.wraps 的目的是什么？

理解装饰器

装饰器允许我们通过用自定义逻辑包装现有函数来增强它们的功能。但是，此包装过程可能会导致与原始函数相关的元数据丢失，即其名称、文档和参数列表。

介绍 functools.wraps

这就是 functools.wraps 发挥作用的地方。它是一个解决元数据丢失问题的装饰器。通过将 @wraps(func) 应用于装饰器函数，我们指示装饰器继承原始函数的元数据。

functools.wraps 的工作原理

• 保留函数名称：防止修饰函数的名称被替换为装饰器。
• 维护文档字符串： 将原始函数的文档复制到装饰函数中。
• 保留参数： 确保装饰函数保留与原始参数签名相同的参数签名function.

示例用法

考虑以下示例：

def logged(func):
    @wraps(func)
    def with_logging(*args, **kwargs):
        print(func.__name__ + " was called")
        return func(*args, **kwargs)
    return with_logging

@logged
def f(x):
    """Computes a mathematical operation."""
    return x + x * x

通过将 @wraps(func) 应用于记录的装饰器，我们确保包装的函数 f 保留其原始名称、文档和参数list:

• print(f.__name__) 输出 'f'
• print(f.__doc__) 打印 '计算数学运算。'

结论

functools.wraps 播放在保存装饰器包装的函数的元数据方面发挥着至关重要的作用，确保重要信息不会丢失。通过使用@wraps(func)，我们可以创建灵活且信息丰富的装饰器，可以有效增强函数行为，而不会影响其原始特性。

以上是`functools.wraps` 在 Python 装饰器中做什么？的详细内容。更多信息请关注PHP中文网其他相关文章！