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

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}')
输出中 c 的 kind 是 KEYWORD_ONLY,而 b 是 POSITIONAL_OR_KEYWORD —— 这直接影响调用时能否用位置传参。忽略 kind 直接按顺序拼调用字符串,很容易在 *args 后出现参数错位。
立即学习“Python免费学习笔记(深入)”;
-
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 固定的参数:
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>
对绑定方法: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 提示会失效。


















