博客

python被修饰的函数消失问题解决(基于wraps函数)

  • Post category:Python

针对“python被修饰的函数消失问题解决(基于wraps函数)”这个话题，我为您提供以下完整攻略：

问题描述

有些时候，在对Python函数做装饰器时，我们会使用装饰器语法@decorator。然而，如果装饰器函数没有使用 functools.wrap 函数修饰器，被修饰的函数可能会“消失”。具体的描述如下：

def my_decorator(func):
    def wrapper():
        print("before")
        func()
        print("after")
    return wrapper

@my_decorator
def say_hello():
    print("hello")

# 调用 say_hello 函数
say_hello()

在上述代码中，我们定义了一个装饰器 my_decorator，其作用是在子函数 func 前后输出 before 和 after。此外，我们还定义了一个被 my_decorator 装饰的函数 say_hello，其作用是输出 hello。最后，我们调用 say_hello 函数。

然而，当我们运行这个程序时，我们发现输出仅有：

before
after

也就是说，say_hello 函数所输出的 hello 只是“消失”了。这是一个比较常见的问题，原因在于装饰器函数返回的是内部函数 wrapper，而未将 wrapper 函数经过修饰器包装后返回。因此，在调用 wrapper 函数时，被修饰的函数 say_hello 所输出的结果被忽略了。

解决方案

要解决被装饰器修饰过函数“消失”的问题，我们可以使用 functools.wrap 函数来修复它。具体的实现方法是，在装饰器内部使用 wrap 修饰被修饰函数，并通过 return 函数的方式来完成对装饰器函数的装饰。

这个思路看起来要更绕一些，所以我们可以通过下面两个示例来讲解。

示例1

import functools

def my_decorator(func):
    @functools.wraps(func)
    def wrapper():
        print("before")
        func()
        print("after")
    return wrapper

@my_decorator
def say_hello():
    print("hello")

# 调用 say_hello 函数
say_hello()

在这个示例中，我们依然使用了 my_decorator 装饰器函数，但我们新增了 functools.wrap 函数。具体的改动如下：

  1. 将 def wrapper() 函数包装在 @functools.wraps(func) 中。
  2. 在 return wrapper 前，使用 return functools.wrap(wrapper) 封装 wrapper 函数。

这样便完成了对 say_hello 函数的装饰。运行这个程序时，你会发现输出为：

before
hello
after

可以看到，我们成功地避免了被装饰函数“消失”的问题。

示例2

如果你不太明白示例1中的 functools.wrap 到底干了什么，可以看下面这个更加详细的示例：

import functools

def my_decorator(func):
    def wrapper():
        print("before")
        func()
        print("after")
    return functools.wrap(wrapper, func)

@my_decorator
def say_hello():
    print("hello")

# 调用 say_hello 函数
say_hello()

在这个示例中，我们依然使用了 my_decorator 装饰器函数，但我们对装饰器的实现方式进行了改动。具体的改动如下：

  1. 不再使用 @functools.wraps(func) 语句。
  2. 将 def wrapper() 函数返回值改为 functools.wrap(wrapper, func)。

这里的 functools.wrap 函数本质上完成了与 @functools.wraps(func) 同样的操作，将 wrapper 函数同样的元数据（doc string、签名、注释等）声明到返回函数 wrapper 上。运行这个程序时，你会发现输出同样为：

before
hello
after

所以，无论是哪种方式，只要对被修饰的函数使用 functools.wrap 函数进行修饰，都可以避免 “被修饰的函数消失” 的问题。

Tags: