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

怎么用 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() 判断调用上下文。
快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。
- 判断是否为绑定方法:
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。
-
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 拿到的可能根本不是你预期的那个函数对象。
Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!










