### Python `inspect.signature` 方法的使用 #### 方法概述 `inspect.signature` 是 Python 的内置模块 `inspect` 提供的一个方法，用于返回指定可调用对象（callable）的签名信息。通过这个方法，可以获得关于函数定义的各种细节，例如参数名称、默认值、位置参数/关键字参数的区别等。 此方法适用于任何支持调用的对象，包括普通的函数、lambda 表达式、类构造器以及其他实现了 `__call__` 方法的对象[^2]。 --- #### 返回值说明 `inspect.signature(callable)` 返回的是一个 `Signature` 对象，该对象包含了目标 callable 的所有参数及其元数据。可以通过遍历 `Signature.parameters` 属性来访问这些参数的信息。 每个参数是一个 `Parameter` 对象，具有以下主要属性： - **name**: 参数的名字。 - **default**: 如果存在，则表示参数的默认值；如果不存在，默认为 `<class 'inspect._empty'>`。 - **kind**: 描述参数类型的枚举值，可能取值有： - `POSITIONAL_ONLY`: 只能作为位置参数传递。 - `POSITIONAL_OR_KEYWORD`: 支持按位置或关键词传入。 - `VAR_POSITIONAL`: 可变长度的位置参数（*args）。 - `KEYWORD_ONLY`: 关键字专用参数（位于 `/` 和 `*` 后面）。 - `VAR_KEYWORD`: 可变长度的关键字参数（**kwargs）。[^3] --- #### 示例代码 下面展示如何使用 `inspect.signature`： ```python import inspect def example_function(a, b, /, c=10, *, d=10, **kwargs): return a + b + c + d # 获取函数的签名 sig = inspect.signature(example_function) print("Function Signature:", sig) # 输出整个签名字符串 for param_name, param in sig.parameters.items(): print(f"Parameter Name: {param_name}") print(f"\tDefault Value: {param.default}") print(f"\tKind: {param.kind}\n") ``` 运行上述代码会得到如下输出： ``` Function Signature: (a, b, /, c=10, *, d=10, **kwargs) Parameter Name: a Default Value: <class 'inspect._empty'> Kind: POSITIONAL_ONLY Parameter Name: b Default Value: <class 'inspect._empty'> Kind: POSITIONAL_ONLY Parameter Name: c Default Value: 10 Kind: POSITIONAL_OR_KEYWORD Parameter Name: d Default Value: 10 Kind: KEYWORD_ONLY Parameter Name: kwargs Default Value: <class 'inspect._empty'> Kind: VAR_KEYWORD ``` --- #### 应用场景 1. 动态分析函数接口：在框架设计中，可以根据函数签名自动生成文档或验证输入参数。 2. 调试工具：帮助开发者快速理解复杂函数的参数结构。 3. 自动化测试：基于签名生成测试案例，覆盖不同组合的参数情况。[^4] --- #### 注意事项 - 不同版本的 Python 中，某些行为可能会有所变化，请确保查阅对应版本的官方文档。 - 非常规定义的函数（如 C 扩展中的函数），可能无法完全解析其签名信息。[^5] ---