如何在 Python 中获取函数及其参数的详细信息-Python教程-PHP中文网

如何在 Python 中获取函数及其参数的详细信息

本文介绍如何使用 inspect 模块准确获取任意函数（包括类方法）的参数签名、默认值、注解及调用规范，重点解决因误用模块属性导致的 AttributeError 问题，并对比 getfullargspec 与更现代的 signature 方法。

本文介绍如何使用 `inspect` 模块准确获取任意函数（包括类方法）的参数签名、默认值、注解及调用规范，重点解决因误用模块属性导致的 `attributeerror` 问题，并对比 `getfullargspec` 与更现代的 `signature` 方法。

在 Python 开发与调试过程中，动态探查函数接口是常见需求——例如查看参数名、默认值、类型注解、是否为关键字专属参数（* 后参数）等。但初学者常因路径错误而失败，如试图直接访问 pd.drop_duplicates（实际该方法属于 DataFrame 类，而非 pandas 模块本身），从而触发 AttributeError。

✅ 正确做法是：定位到函数/方法的真实可调用对象。对于 pandas 的 drop_duplicates，应使用 pd.DataFrame.drop_duplicates；对于自定义类方法，则需通过 ClassName.method_name 或实例绑定方式获取。

以下为完整实践方案：

1. 使用 `inspect.signature()`（推荐，Python 3.5+）

inspect.signature() 是当前最推荐的方式，返回结构清晰、语义丰富的 Signature 对象，天然支持类型注解、参数类别（POSITIONAL_ONLY, KEYWORD_ONLY 等）和返回值注解：

import inspect
import pandas as pd

# ✅ 正确获取 DataFrame.drop_duplicates 的签名
sig = inspect.signature(pd.DataFrame.drop_duplicates)
print(sig)
# 输出示例：
# (self, subset: 'Hashable | Sequence[Hashable] | None' = None,
#  *, keep: 'DropKeep' = 'first', inplace: 'bool' = False,
#  ignore_index: 'bool' = False) -> 'DataFrame | None'

你还可以遍历参数并提取关键信息：

python-pro

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

下载

for name, param in sig.parameters.items():
    print(f"参数名: {name}")
    print(f"  类型注解: {param.annotation}")
    print(f"  默认值: {param.default if param.default != inspect.Parameter.empty else '无'}")
    print(f"  参数类型: {param.kind}")

2. 使用 `inspect.getfullargspec()`（兼容旧代码）

该函数返回 FullArgSpec 命名元组，适合需要显式分离 args、defaults、kwonlyargs 等字段的场景，但不直接支持 POSITIONAL_ONLY 参数（Python 3.8+）且对注解支持较弱：

spec = inspect.getfullargspec(pd.DataFrame.drop_duplicates)
print("位置参数:", spec.args)           # ['self', 'subset']
print("默认值:", spec.defaults)         # (None,)
print("仅关键字参数:", spec.kwonlyargs) # ['keep', 'inplace', 'ignore_index']
print("仅关键字默认值:", spec.kwonlydefaults)  # {'keep': 'first', 'inplace': False, ...}
print("返回值注解:", spec.annotations.get('return'))  # 'DataFrame | None'

⚠️ 注意事项：

❌ inspect.getfullargspec 不支持 functools.partial、lambda 或某些 C 扩展函数（会抛 ValueError），此时应改用 inspect.signature()。
❌ 避免对未绑定方法（如 obj.method 未加括号）误判为普通函数——确保传入的是可调用对象本身，而非调用结果。
✅ 对于实例方法，无需创建实例即可直接访问类上的方法（如 pd.DataFrame.drop_duplicates），因其是未绑定方法（unbound method），inspect 可正常解析。

总结

方法	优势	适用场景
`inspect.signature()`	支持全部参数种类、类型注解、返回值、可迭代解析、未来兼容性好	✅ 新项目首选，调试、IDE 自动补全、API 文档生成
`inspect.getfullargspec()`	字段明确、兼容 Python 2/3 早期版本	⚠️ 维护旧代码或需精确控制 `args`/`*kwargs` 字段时