如何使用Python中的inspect模块获取函数的参数签名_调用signature

老静吖_7666

老静吖_7666

2026-05-18

911人浏览

原创

inspect.signature() 返回 Signature 实例,封装函数全部调用元信息;需用 bind() 转 BoundArguments 才能安全解包,且须调用 apply_defaults() 补全默认值。

如何使用python中的inspect模块获取函数的参数签名_调用signature

inspect.signature() 返回的是什么类型

inspect.signature() 返回一个 Signature 实例,不是字典也不是字符串,而是一个封装了函数全部调用元信息的对象。它本身不能直接传给 func(*args, **kwargs),必须先用 bind() 或 bind_partial() 转成 BoundArguments 才能安全解包。

常见错误是拿到 Signature 后直接尝试 dict(sig) 或 sig.parameters 当成普通 dict 用 —— 虽然 sig.parameters 确实是 OrderedDict 子类,但它的 key 是 Parameter 对象,value 不是默认值本身,而是带 kind、default、annotation 等字段的完整描述。

  • Parameter.default 可能是 inspect.Parameter.empty,不能直接参与逻辑判断,得先比对
  • Parameter.kind 区分 POSITIONAL_ONLY、KEYWORD_ONLY 等,影响参数是否允许被传为 keyword
  • 对内置函数(如 len、print)调用 signature() 可能抛 ValueError,因为 C 实现函数不提供签名信息

如何安全地把 signature 转成可调用的参数映射

最常用路径是:获取 Signature → 用 bind() 绑定实际参数 → 调用 apply_defaults() 补全缺省值 → 取 arguments 属性得到最终字典。

注意 bind() 是严格校验的,传入不合法参数会立刻报 TypeError;如果只想做“尽力绑定”,用 bind_partial() 更合适。

import inspect
<p>def example(a, b: int, c=3, *args, d=None, **kwargs):
pass</p><p>sig = inspect.signature(example)
bound = sig.bind(1, 2, d="x")  # 不传 c,也不传 args/kwargs
bound.apply_defaults()  # 这步必须加,否则 bound.arguments 不含 c
print(bound.arguments)  # {'a': 1, 'b': 2, 'c': 3, 'd': 'x'}
</p>
  • 没调 apply_defaults() 时,bound.arguments 里不会出现有默认值但未传入的参数(如 c)
  • *args 和 **kwargs 在 bound.arguments 中分别对应 'args' 和 'kwargs' 键,值为 tuple/dict
  • 若函数含 POSITIONAL_ONLY 参数(如 C 扩展或用了 / 语法),bind() 会拒绝 keyword 传入,报错提示 “takes X positional arguments but Y were given”

inspect.signature() 在装饰器中怎么避免破坏原函数签名

直接写 @wraps(func) 并不够 —— 如果装饰器内部修改了 __signature__,或者返回了一个新函数但没显式设置签名,调用方看到的仍是装饰器闭包的签名(通常是 (*args, **kwargs)),导致 IDE 提示不准、help() 失效、框架(如 FastAPI)无法正确解析参数。

正确做法是在装饰器返回函数前,手动拷贝原函数的 __signature__:

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载
from functools import wraps
import inspect
<p>def my_decorator(func):
@wraps(func)
def wrapper(*args, *<em>kwargs):
return func(</em>args, **kwargs)</p><h1>关键:把原函数签名赋给 wrapper</h1><pre class="brush:php;toolbar:false;">wrapper.__signature__ = inspect.signature(func)
return wrapper

  • 不要依赖 @wraps 自动处理 __signature__:Python 3.5+ 的 @wraps 默认同步它,但某些旧版本或自定义 wraps 实现可能漏掉
  • 若装饰器本身要增删参数(如注入 request),应基于原 Signature 构造新 Signature,而不是硬编码 __signature__
  • inspect.Signature 构造需要 Parameter 列表,不能直接传 dict;新增参数要用 Parameter(name, kind, default=..., annotation=...) 显式创建

为什么 getfullargspec() 正在被 signature() 替代

inspect.getfullargspec() 返回的是命名元组,字段固定(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations),无法表达 POSITIONAL_ONLY、KEYWORD_ONLY 的边界位置,也不能表示 Union[int, str] 这类复杂注解的结构化信息。

而 signature() 返回的 Signature 是面向未来的:它把每个参数都建模为 Parameter 对象,kind 字段明确区分调用约束,annotation 字段保留原始 AST 类型(而非字符串),且支持 __future__.annotations 延迟求值。

  • getfullargspec() 对带 / 分隔符的函数(如 def f(a, b, /, c):)会把 a, b 归入 args,但丢失 “必须 positional” 这一语义
  • signature() 中 Parameter.kind == Parameter.POSITIONAL_ONLY 明确标识该参数不可 keyword 传入
  • 第三方库(如 pydantic, click)已全面转向 signature() 解析,继续用 getfullargspec() 可能导致兼容性断裂

真正难处理的是动态生成的函数(比如用 types.FunctionType 构造的),它们的 __signature__ 默认为 inspect.Signature.empty,必须手动 attach,否则任何基于签名的逻辑都会 fallback 到模糊匹配。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1691

4

python能做什么
python能做什么

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

2023.07.25

4304

7

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

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

2023.07.31

1689

3

python教程
python教程

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

2023.08.03

25057

23

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

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

2023.08.04

3067

5

python eval
python eval

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

2023.08.04

3087

5

scratch和python区别
scratch和python区别

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

2023.08.11

1163

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2383

5

热门下载

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

精品课程

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