Python 怎么用 wraps 保留装饰后函数的名称和参数签名?

老磊同学_8655

老磊同学_8655

2026-11-19

153人浏览

原创

在 python 3 中,给包装函数添加 functools.wraps(原函数),可以保留函数名和文档字符串,并通过 __wrapped__ 让 inspect.signature 默认取得原函数签名。wraps 不会自动改变包装函数的调用规则;参数仍要正确转发,返回值也要显式返回。以下三个示例分别保存为 demo.py,执行 python demo.py。

Python 怎么用 wraps 保留装饰后函数的名称和参数签名?

给包装函数添加 wraps,保留名称并转发返回值

装饰器接收一个函数,返回新的 wrapper。wrapper 使用 *args 和 **kwargs 转交位置参数与关键字参数,用 return 把调用结果交回调用者。wraps 加在 wrapper 上,传入被装饰的函数。

from functools import wraps

def trace(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("调用:", func.__name__)
        return func(*args, **kwargs)
    return wrapper

@trace
def greet(name, *, prefix="你好"):
    """生成问候语。"""
    return f"{prefix},{name}"

assert greet("小林", prefix="早上好") == "早上好,小林"
assert greet.__name__ == "greet"
assert greet.__doc__ == "生成问候语。"
print(greet.__name__, greet.__doc__)

预期打印调用名称,再打印 greet 和文档字符串。如果漏掉 return func(...),包装函数会返回 None;如果漏掉 **kwargs,带 prefix 的调用就不能按原接口工作。元信息保留与调用转发需要分别实现。

用 inspect.signature 区分原函数签名和包装函数签名

wraps 设置 __wrapped__,inspect.signature 默认沿着它读取原函数。指定 follow_wrapped=False 可以检查 wrapper 自身的参数结构。两种结果用途不同,不代表 Python 在运行时把 wrapper 的形参改写了。

Python健壮编程
Python健壮编程

编写可靠Python代码,避免可变默认值、导入陷阱与运行时意外

下载
import inspect
from functools import wraps

def trace(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        return func(*args, **kwargs)
    return wrapper

@trace
def add(a, b=2):
    return a + b

original = inspect.signature(add)
wrapper = inspect.signature(add, follow_wrapped=False)
assert str(original) == "(a, b=2)"
assert str(wrapper) == "(*args, **kwargs)"
assert add(3) == 5
print(original)
print(wrapper)

预期依次打印 (a, b=2) 与 (*args, **kwargs)。路由或文档工具可以利用原签名;业务参数验证仍要自行处理,wraps 不会根据类型注解自动验证或转换输入。

通过 __wrapped__ 调用原函数,核对装饰器是否执行

__wrapped__ 指向被包装的函数。测试时可以直接调用它来隔离装饰器副作用;多层装饰时通常只解开当前一层。这个入口也能跳过包装逻辑,不能把装饰器包装本身当成不可绕过的权限边界。

from functools import wraps

calls = []
def trace(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        calls.append(func.__name__)
        return func(*args, **kwargs)
    return wrapper

@trace
def double(number):
    return number * 2

assert double(5) == 10
assert calls == ["double"]
assert double.__wrapped__(5) == 10
assert calls == ["double"]
try:
    double()
except TypeError:
    print("缺少参数仍由原函数调用报错")
else:
    raise AssertionError("缺少 number 应失败")

直接调用 __wrapped__ 后,calls 不增加。最后一次缺参调用会先进入 wrapper,再在转交给 double 时抛 TypeError;因此是否记录调用和是否成功执行函数也应分别判断。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1951

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5564

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1889

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

34037

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3987

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3987

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1283

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

636

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3103

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程