在 Python 中，**打印一个方法（函数）的参数详情**（即其签名：参数名、类型提示、默认值、可变参数等），有多种专业、可靠的方式。以下是 **从简单到高级、覆盖交互式调试与生产脚本的 4 种权威方法**，全部附带可直接运行的代码示例和详细解释： --- ### ✅ 方法 1：`inspect.signature()` —— 最推荐！标准库、精准、无依赖 > ✅ 适用于任意可调用对象（函数、方法、类 `__init__`、`functools.partial` 等） > ✅ 输出结构化 `Signature` 对象，可遍历每个参数的 `name`, `kind`, `default`, `annotation` > ✅ 支持类型提示（PEP 484）、`*args`, `**kwargs`, `kwonly` 等所有语法 #### 🔧 示例代码： ```python import inspect def example_func( a: int, b: str = "hello", *args, c: float = 3.14, **kwargs ) -> bool: return True # 获取签名 sig = inspect.signature(example_func) print("=== 函数签名 ===") print(sig) # 👉 直接打印字符串形式（简洁） print("\n=== 逐参数详情 ===") for name, param in sig.parameters.items(): print(f"参数名: '{name}'") print(f" 类型: {param.annotation if param.annotation != inspect.Parameter.empty else 'N/A'}") print(f" 默认值: {param.default if param.default != inspect.Parameter.empty else '无'}") print(f" 类型: {param.kind}") # POSITIONAL_ONLY, KEYWORD_ONLY, VAR_POSITIONAL (*args), VAR_KEYWORD (**kwargs), etc. print() print("=== 返回值类型 ===") print(f"返回类型: {sig.return_annotation if sig.return_annotation != inspect.Parameter.empty else 'None'}") ``` #### 🖨️ 输出： ``` === 函数签名 === (a: int, b: str = 'hello', *args, c: float = 3.14, **kwargs) -> bool === 逐参数详情 === 参数名: 'a' 类型: <class 'int'> 默认值: 无 类型: POSITIONAL_OR_KEYWORD 参数名: 'b' 类型: <class 'str'> 默认值: hello 类型: POSITIONAL_OR_KEYWORD 参数名: 'args' 类型: N/A 默认值: 无 类型: VAR_POSITIONAL 参数名: 'c' 类型: <class 'float'> 默认值: 3.14 类型: KEYWORD_ONLY 参数名: 'kwargs' 类型: N/A 默认值: 无 类型: VAR_KEYWORD === 返回值类型 === 返回类型: <class 'bool'> ``` > 💡 提示：`param.kind` 是枚举值，常用值含义： > - `POSITIONAL_OR_KEYWORD`: 普通参数（如 `a`, `b`） > - `VAR_POSITIONAL`: `*args` > - `KEYWORD_ONLY`: 仅限关键字参数（`c`，因前面有 `*args`） > - `VAR_KEYWORD`: `**kwargs` --- ### ✅ 方法 2：`help()` —— 快速交互式查看（适合 REPL/Jupyter） > ✅ 一行命令，自动格式化显示 docstring + signature > ✅ 内置、无需 import，适合调试时快速扫一眼 #### 🔧 示例： ```python def greet(name: str, age: int = 25) -> str: """Say hello to a person.""" return f"Hello {name}, you are {age} years old." help(greet) ``` #### 🖨️ 输出（截取关键部分）： ``` Help on function greet in module __main__: greet(name: str, age: int = 25) -> str Say hello to a person. ``` > ⚠️ 注意：`help()` 依赖 `__doc__` 和 `__annotations__`，若函数没写 docstring 或类型提示，信息会不全。 --- ### ✅ 方法 3：`inspect.getfullargspec()` —— 兼容旧版 Python（<3.5），无类型提示 > ✅ 返回 `FullArgSpec` 命名元组：`args`, `varargs`, `varkw`, `defaults`, `kwonlyargs`, `kwonlydefaults`, `annotations` > ✅ 不依赖类型提示，兼容性最强（但不推荐新项目使用） #### 🔧 示例： ```python import inspect def legacy_func(x, y=10, *z, debug=False, **opts): pass spec = inspect.getfullargspec(legacy_func) print(spec) ``` #### 🖨️ 输出： ``` FullArgSpec( args=['x', 'y'], varargs='z', varkw='opts', defaults=(10,), kwonlyargs=['debug'], kwonlydefaults={'debug': False}, annotations={} ) ``` > ✅ 优点：字段名语义清晰（`defaults` 对应 `y=10`，`kwonlydefaults` 对应 `debug=False`） > ❌ 缺点：不包含类型提示（`annotations` 为空），Python 3.11+ 已标记为 legacy。 --- ### ✅ 方法 4：`typing.get_type_hints()` —— 单独提取并美化类型提示 > ✅ 当你**只关心类型**（比如生成 API 文档、做静态检查） > ✅ 自动解析字符串字面量（如 `"List[str]"`）、处理前向引用（`"MyClass"`） #### 🔧 示例： ```python from typing import List, Dict, Union, get_type_hints def api_endpoint( user_id: int, tags: List[str], metadata: Dict[str, Union[str, int]] = None ) -> Dict[str, bool]: ... hints = get_type_hints(api_endpoint) print("=== 类型提示 ===") for param, typ in hints.items(): print(f"{param}: {typ}") ``` #### 🖨️ 输出： ``` === 类型提示 === user_id: <class 'int'> tags: typing.List[str] metadata: typing.Dict[str, typing.Union[str, int]] return: typing.Dict[str, bool] ``` > 💡 进阶：配合 `typing_extensions` 可支持 `Annotated`, `Required`, `NotRequired` 等新特性。 --- ### 🎯 一键封装：打印任意函数的「人类可读参数报告」 ```python import inspect from typing import get_type_hints def show_signature(func): """打印函数的完整、易读参数报告""" sig = inspect.signature(func) hints = get_type_hints(func) print(f"🔧 函数: {func.__name__}") print(f"📄 文档: {func.__doc__.strip() if func.__doc__ else '(无)'}") print(f"➡️ 签名: {sig}") print("\n📋 参数详情:") for name, param in sig.parameters.items(): typ = hints.get(name, "N/A") default = param.default if param.default != inspect.Parameter.empty else "无" kind = { inspect.Parameter.POSITIONAL_ONLY: "仅位置", inspect.Parameter.POSITIONAL_OR_KEYWORD: "位置/关键字", inspect.Parameter.VAR_POSITIONAL: "*args", inspect.Parameter.KEYWORD_ONLY: "仅关键字", inspect.Parameter.VAR_KEYWORD: "**kwargs" }[param.kind] print(f" • {name:<12} [{kind:<10}] : {typ} = {default}") ret_typ = hints.get('return', 'None') print(f"\n↩️ 返回值: {ret_typ}") print("-" * 50) # ✅ 使用示例 def train_model( data_path: str, lr: float = 1e-4, epochs: int = 10, device: str = "cuda", verbose: bool = True ) -> dict: """Train a deep learning model.""" return {"status": "done"} show_signature(train_model) ``` --- ### ✅ 总结对比表 | 方法 | 是否推荐 | 优点 | 缺点 | 适用场景 | |------|----------|------|------|-----------| | `inspect.signature()` | ✅✅✅ **强烈推荐** | 精准、结构化、支持全部 Python 参数语法、含类型提示 | 需手动遍历 | 所有场景（脚本/调试/文档生成） | | `help()` | ✅✅ | 一行命令、带 docstring、格式美观 | 信息较粗、不可编程提取 | Jupyter/REPL 快速查看 | | `inspect.getfullargspec()` | ⚠️ 仅兼容旧代码 | 兼容 Python 3.0+、字段名直观 | 无类型提示、已 legacy | 维护老项目 | | `get_type_hints()` | ✅✅ | 专注类型、支持字符串前向引用 | 仅类型，无默认值/参数顺序 | 类型检查、API 文档 | ---