如何在Python中使用inspect模块获取函数签名信息

雨墨大大_7054

雨墨大大_7054

2026-11-08

898人浏览

原创

inspect.signature()返回Signature实例,含parameters(OrderedDict子类)、return_annotation等字段;需通过.parameters访问Parameter对象获取参数名、默认值、类型注解等,不可直接当字典使用。

如何在python中使用inspect模块获取函数签名信息

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

inspect.signature() 返回一个 Signature 实例,不是字典也不是字符串,而是一个包含 parameters(有序映射)、return_annotation 和 __str__ 方法的专用对象。直接 print(sig) 看到的是人类可读格式,但真要取参数名或默认值,得访问 sig.parameters —— 它是 OrderedDict 子类,键是参数名,值是 Parameter 对象。

常见错误:把 sig 当成字典遍历,或试图用 sig['arg'] 取值。正确做法是:

import inspect
def foo(a, b: int = 10) -> str:
    pass
<p>sig = inspect.signature(foo)
for name, param in sig.parameters.items():
print(f"{name}: {param.default if param.default != inspect.Parameter.empty else 'no default'}")</p><h1>输出:</h1><h1>a: no default</h1><h1>b: 10</h1>

如何安全处理缺失注解和默认值

函数参数可能没写类型注解、没设默认值,甚至用了 *args 或 **kwargs。Parameter 对象的 annotation 和 default 字段会分别等于 inspect.Parameter.empty,不能直接参与类型检查或 JSON 序列化。

  • 判断是否有类型注解:param.annotation is not inspect.Parameter.empty
  • 判断是否有默认值:param.default is not inspect.Parameter.empty
  • param.kind 是关键:值为 Parameter.POSITIONAL_ONLY、Parameter.KEYWORD_ONLY 等,决定调用时能否传关键字参数
  • *args 对应 kind == Parameter.VAR_POSITIONAL,**kwargs 对应 Parameter.VAR_KEYWORD

inspect.signature() 在装饰器里为什么常出错

装饰器(尤其是用 @functools.wraps 包装过的)会让 inspect.signature() 返回被包装函数的签名,但若装饰器本身改变了参数逻辑(比如注入额外参数),或用了闭包/lambda,就可能报 ValueError: callable is not supported 或返回不一致的签名。

原因:某些装饰器没正确设置 __signature__ 属性,或目标对象不是标准函数(如类的 __call__ 方法、C 扩展函数)。解决方法:

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载
  • 优先用 functools.wraps(func),它会复制 __signature__
  • 手动修复签名:inspect.signature(func).replace(parameters=[...])
  • 对不可信对象加 try/except:try: sig = inspect.signature(obj) except (ValueError, TypeError): sig = inspect.Signature([])

Python 2 和 typing 模块对 signature 解析的影响

inspect.signature() 是 Python 3.5+ 引入的,Python 2 中不存在;即使在 Python 3 中,若函数用 typing 注解(如 List[str]),param.annotation 就是那个泛型类型对象,不是字符串——不能直接当 JSON 值用,也不能用 isinstance 判断。

兼容性注意点:

  • Python inspect.getfullargspec(),但它不支持 **kwargs 的类型注解,且返回的是命名元组而非对象
  • typing.Union、Optional 等在运行时是特殊对象,需用 typing.get_origin() 和 typing.get_args()(3.8+)解析
  • 第三方库(如 pydantic)可能重写 __signature__,此时 inspect.signature() 返回的是其定制结果,未必反映原始函数定义

真正麻烦的从来不是怎么取签名,而是拿到之后怎么统一处理各种 annotation 类型、怎么应对装饰器透传失败、以及跨版本时要不要 fallback —— 这些才是实际写工具链时卡住的地方。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1891

4

python能做什么
python能做什么

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

2023.07.25

5184

7

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

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

2023.07.31

1829

3

python教程
python教程

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

2023.08.03

31377

23

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

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

2023.08.04

3707

5

python eval
python eval

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

2023.08.04

3727

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2883

5

热门下载

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

精品课程

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