如何在Python中使用inspect模块动态获取函数的参数签名与默认值?

落强大大_1616

落强大大_1616

2026-11-14

981人浏览

原创

inspect.signature() 能获取参数名、类型注解、默认值、参数种类(如POSITIONAL_ONLY),但不能获取运行时传入值、闭包变量或未正确设置__signature__的装饰器内部签名。

如何在python中使用inspect模块动态获取函数的参数签名与默认值?

inspect.signature() 能拿到什么,不能拿到什么

inspect.signature() 返回的是 Signature 对象,它包含参数名、类型注解、默认值、参数种类(POSITIONAL_ONLY、KEYWORD_ONLY 等),但不包含运行时实际传入的值,也不解析闭包变量或装饰器内部重写的签名(比如 @functools.wraps 修正是安全的,但 @decorator 自定义未处理 __signature__ 就会丢失)。

常见错误现象:对用 lambda 或某些 C 扩展函数(如 len、map)调用 inspect.signature() 会抛 ValueError: callable <...> is not a function;对被粗暴覆盖 __signature__ 的函数,可能返回空或错误签名。

  • 优先用于你自己写的普通函数、方法、带 @wraps 的装饰函数
  • 避免直接对内置函数、functools.partial 实例(需先用 inspect.unwrap())、或动态生成的 types.FunctionType 对象调用,除非你确认其 __signature__ 已正确定义
  • 若函数有 __signature__ 属性,inspect.signature() 会直接返回它,不会重新推导

提取参数名、默认值和是否必填的实操写法

从 Signature 中遍历 parameters 是最常用路径。每个 Parameter 对象的 default 属性是关键:等于 inspect.Parameter.empty 表示无默认值(即必填),否则就是默认值(包括 None)。

import inspect
<p>def example(a, b: int = 10, *args, c=20, **kwargs):
pass</p><p>sig = inspect.signature(example)
for name, param in sig.parameters.items():
default = param.default if param.default is not inspect.Parameter.empty else '<required>'
print(f'{name}: default={default}, kind={param.kind}')
</required></p>

输出中 c 的 kind 是 KEYWORD_ONLY,而 b 是 POSITIONAL_OR_KEYWORD —— 这直接影响调用时能否用位置传参。忽略 kind 直接按顺序拼调用字符串,很容易在 *args 后出现参数错位。

  • param.annotation 是类型注解(可能是 inspect.Parameter.empty)
  • 判断是否必填,只看 param.default is inspect.Parameter.empty,不要用 == None 或布尔判断
  • 如果函数用了 typing.Union 或 Optional 注解,annotation 里能取到,但 default 不受其影响

处理 functools.partial 和绑定方法的签名补全

functools.partial 实例没有原生可读的签名,inspect.signature() 默认会失败;类方法(bound method)的签名会自动剔除 self,但有时你需要还原成完整参数列表(比如做参数校验)。

对 partial:必须先 inspect.unwrap() 拿到原函数,再手动合并 partial 固定的参数:

Biopython
Biopython

全面的分子生物学工具集。适用于序列操作、文件解析(FASTA/GenBank/PDB)、系统发育分析,以及通过 Bio.Entrez 以编程方式访问 NCBI/

下载
from functools import partial
import inspect
<p>def f(x, y, z=3):
return x + y + z</p><p>pf = partial(f, 1, z=10)
sig = inspect.signature(inspect.unwrap(pf))</p><h1>手动构建新 Signature,把 fixed args 标记为已提供</h1><p></p>

对绑定方法:inspect.signature(method) 正确返回不含 self 的签名,但如果你需要“定义时”的完整签名(含 self),得去查 method.__func__:

  • method.__func__ 是原始函数,inspect.signature(method.__func__) 包含 self
  • method.__self__ 是绑定的实例,可用于后续反射调用
  • 别依赖 str(signature) 做解析——格式不稳定,且不保留 kind 信息

为什么 inspect.getfullargspec() 正在被弃用

inspect.getfullargspec() 返回的是命名元组(ArgSpec),字段包括 args、varargs、varkw、defaults、kwonlyargs、kwonlydefaults、annotations。它无法表达 POSITIONAL_ONLY 参数(Python 3.8+ 引入),也无法区分 **kwargs 和显式 kwonly 参数的边界细节。

更麻烦的是:defaults 是个元组,顺序靠后对齐 args,但一旦中间有 *args,就无法准确映射哪个参数对应哪个默认值;kwonlydefaults 是字典,看似清晰,但缺失参数种类信息,导致无法还原调用约束。

  • 新代码一律用 inspect.signature() + 遍历 parameters
  • 仅在维护旧 Python 3.5–3.7 项目,且不涉及 / 语法时,才考虑 getfullargspec
  • inspect.Signature.bind() 和 .bind_partial() 可直接做参数绑定校验,比手撸逻辑可靠得多

真正容易被忽略的是:签名对象本身是不可变的,但你可以用 Signature.replace() 构造新签名——这在写框架级装饰器时很实用,比如统一加日志参数,但别忘了同步更新 __signature__ 属性,否则用户调用 help() 或 IDE 提示会失效。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1911

4

python能做什么
python能做什么

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

2023.07.25

5404

7

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

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

2023.07.31

1869

3

python教程
python教程

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

2023.08.03

32797

23

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

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

2023.08.04

3867

5

python eval
python eval

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

2023.08.04

3867

5

scratch和python区别
scratch和python区别

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

2023.08.11

1263

5

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

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

2023.08.10

616

4

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

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

2023.08.11

3003

5

热门下载

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

精品课程

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