使用 Python 的 inspect 模块获取函数参数名称与值
在 Python 编程中，有时候我们需要获取函数的参数以及对应的值。此时，可以借助 Python 内置的 inspect 模块来实现。这篇文章将指导你逐步完成这个任务。
整体流程
我们可以把整个过程分为以下几步：
| 步骤 | 描述 |
|---|---|
| 1 | 定义一个简单的函数 |
| 2 | 使用 inspect 模块获取函数的参数信息 |
| 3 | 获取并输出参数名称与对应的值 |
下面是对应的流程图：
flowchart TD
A(定义函数) --> B(获取参数信息)
B --> C(输出参数名称与值)
步骤详解
步骤 1：定义一个简单的函数
我们可以先定义一个简单的函数，该函数会有几个参数。示例代码如下：
def sample_function(a, b=2, *args, **kwargs):
"""
一个示例函数。
a: 必须参数
b: 默认参数
args: 可变位置参数
kwargs: 可变关键字参数
"""
pass
- 这里我们定义了一个
sample_function，它有一个必选参数a、一个默认参数b，以及两个可变参数*args和**kwargs。
步骤 2：使用 inspect 模块获取函数的参数信息
接下来，我们引入 inspect 模块，获取参数名称和信息：
import inspect
# 获取函数的参数信息
signature = inspect.signature(sample_function)
print("函数参数信息:")
print(signature)
- 首先，使用
import inspect导入inspect模块。 - 然后，使用
inspect.signature()获取sample_function的签名对象（包含参数信息）。 - 最后，输出函数的参数信息。
步骤 3：获取并输出参数名称与对应的值
接下来，我们将解析函数参数并打印它们的名称与默认值：
# 获取每个参数的名称和默认值
for param in signature.parameters.values():
name = param.name # 参数名称
default = param.default # 默认值
# 打印参数及其默认值
if default is param.empty: # 如果没有默认值，用一个占位符表示
print(f"参数: {name}, 默认值: 无")
else:
print(f"参数: {name}, 默认值: {default}")
- 通过
signature.parameters获取参数的字典，然后遍历它。 - 对于每一个参数，我们获取其名称和默认值。如果参数没有默认值，使用
param.empty进行判断并输出相应的提示。
完整代码示例
将以上步骤结合在一起，我们可以得到以下完整的代码：
import inspect
def sample_function(a, b=2, *args, **kwargs):
"""
一个示例函数。
a: 必须参数
b: 默认参数
args: 可变位置参数
kwargs: 可变关键字参数
"""
pass
# 获取函数的参数信息
signature = inspect.signature(sample_function)
# 获取每个参数的名称和默认值
for param in signature.parameters.values():
name = param.name # 参数名称
default = param.default # 默认值
# 打印参数及其默认值
if default is param.empty: # 如果没有默认值，用一个占位符表示
print(f"参数: {name}, 默认值: 无")
else:
print(f"参数: {name}, 默认值: {default}")
结尾
通过以上步骤，你已经掌握了如何使用 Python 的 inspect 模块获取函数的参数名称与对应的值。这对于调试与文档生成等任务来说非常有帮助。希望这篇文章能帮助到你，让你在编程的道路上更加顺利！如果你有任何疑问，请随时提问。
