讲师中心 微信公众号
AI工具推荐 视频效率加速

如何使用Python的inspect模块动态分析类的方法签名?

陌静大大_2961

陌静大大_2961

发布时间:2026-08-10 08:28:59

|

553人浏览过

|

来源于php中文网

原创

直接调用 inspect.signature() 获取可调用对象的完整签名,返回 Signature 对象,含参数名、类型注解、默认值和 kind;需传入已绑定方法或函数对象,避免未绑定描述符,并注意装饰器、继承及动态属性带来的干扰。

如何使用python的inspect模块动态分析类的方法签名?

怎么用 inspect.signature() 提取方法参数信息

直接调用 inspect.signature() 获取绑定方法或函数对象的签名,它返回一个 Signature 对象,包含所有参数名、类型注解、默认值和 kind(如 POSITIONAL_ONLY、KEYWORD_ONLY 等)。注意:必须传入**可调用对象本身**,不是字符串名,也不是未绑定的类方法(比如 MyClass.method 在未实例化时会报 ValueError: callable() is not supported for this type)。

常见错误是传入 getattr(cls, 'method') 后直接丢给 signature() —— 这在类方法未绑定时可能失效。稳妥做法是先获取实例方法(如 obj.method)或用 inspect.getattr_static() 配合 inspect.Signature.from_callable()。

  • 对实例方法:直接用 inspect.signature(obj.method)
  • 对类方法(@classmethod):用 inspect.signature(cls.method) 可行,但需确保 cls.method 是可调用的(Python 3.7+ 支持)
  • 对静态方法(@staticmethod):同普通函数,inspect.signature(cls.static_method) 即可
  • 若遇到 ValueError: no signature found,大概率是传入了描述符(如未绑定的普通实例方法),此时改用 inspect.signature(getattr(obj, 'method'))

如何处理带 self 或 cls 的绑定参数

inspect.signature() 默认返回完整签名,包括 self 或 cls。如果只想看用户实际传入的参数(即去掉第一个隐式参数),不能靠手动切片——因为某些方法可能是 @staticmethod 或 @property,没有隐式参数;也可能用了 *args/**kwargs。正确方式是遍历 signature.parameters.values() 并过滤掉 kind == inspect.Parameter.POSITIONAL_ONLY 且名字为 'self' 或 'cls' 的项,但更健壮的做法是结合 inspect.isfunction() 和 inspect.ismethod() 判断调用上下文。

  • 判断是否为绑定方法:inspect.ismethod(func) 返回 True 时,通常第一个参数是隐式的
  • 判断是否为普通函数:inspect.isfunction(func) 返回 True 时,无隐式参数
  • 别依赖参数名硬匹配 'self' —— 有人写成 's' 或 'instance',应以 kind 和绑定状态为准
  • 用 list(signature.parameters.keys())[1:] if inspect.ismethod(func) else list(signature.parameters.keys()) 是常见但有风险的写法,仅适用于标准命名场景

为什么 inspect.getfullargspec() 有时比 signature() 更可靠

对于老旧代码、C 扩展函数、或某些动态生成的方法(如用 types.FunctionType 构造但没设 __annotations__),inspect.signature() 可能返回不完整信息甚至抛 ValueError;而 inspect.getfullargspec() 基于函数的 __code__ 属性,兼容性更强,能稳定拿到 args、varargs、varkw、defaults、kwonlyargs、kwonlydefaults 和 annotations。

python-pro
python-pro

高级 Python 特性、异步编程、性能调优、静态类型、内存管理、Python 内部机制及生态库方面的专家。

下载

立即学习“Python免费学习笔记(深入)”;

  • getfullargspec() 不支持 functools.partial 包装后的函数,signature() 可以
  • getfullargspec() 返回的是命名元组,字段名固定,适合做结构化解析;signature() 返回对象更灵活但需理解 Parameter 类型
  • 若目标是生成文档或做参数校验,优先用 signature();若只是快速读取形参列表且兼容 Python 3.5+,getfullargspec() 更省心
  • 两者都对 lambda 函数有效,但 getfullargspec() 对 lambda 的 annotations 字段恒为空 dict

动态分析时容易忽略的继承与装饰器干扰

类方法可能被装饰器(尤其是不保留签名的装饰器)包裹,导致 signature() 返回原始包装函数的签名而非被装饰函数的。例如 @lru_cache、自定义装饰器未用 @functools.wraps 时,inspect.signature() 就会看到 wrapper(*args, **kwargs) 而非真实参数。

  • 检查 func.__wrapped__ 是否存在,存在则递归调用 inspect.signature(func.__wrapped__)
  • 用 inspect.unwrap(func) 自动剥掉多层装饰器(Python 3.5+),再传给 signature()
  • 继承链上的方法重写不会自动合并签名 —— inspect.signature(Child.method) 只返回子类定义的签名,父类注解不会“透传”
  • 若需合并父类参数注解,得手动用 inspect.getmro() 向上查找,并按 MRO 顺序合并 __annotations__,但要注意冲突处理(比如同名参数类型不一致)

真正麻烦的是带 __set_name__ 的描述符、__get__ 动态返回可调用对象的属性,或者用 __getattr__ 拦截方法访问的类——这些场景下,inspect 拿到的可能根本不是你预期的那个函数对象。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

相关专题

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

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

1671

2023.07.20

python能做什么
python能做什么

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

4164

2023.07.25

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

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

1669

2023.07.31

python教程
python教程

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

24097

2023.08.03

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

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

2947

2023.08.04

python eval
python eval

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

2987

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn