### 如何使用 Python 的 `argparse` 模块添加命令行输入参数 Python 中的 `argparse` 是一个用于解析命令行选项的标准库模块。它允许开发者定义程序支持哪些命令行参数以及这些参数的行为。 #### 定义基本 ArgumentParser 对象 创建一个 `ArgumentParser` 实例时，可以通过传递描述字符串来提供帮助信息[^2]： ```python import argparse parser = argparse.ArgumentParser(description="这是一个测试 argparse 模块功能的小例子") ``` #### 添加命令行参数 通过调用 `add_argument()` 方法向解析器添加参数。以下是几个常见的配置方式： - **可选参数** 默认情况下，带有前缀 `-` 或者 `--` 的参数被认为是可选参数。例如，下面的例子展示了如何添加一个名为 `--foo` 的可选参数，并设置其为必需项[^1]： ```python parser.add_argument('--foo', required=True, help='这是 foo 参数的帮助文档') ``` 运行此脚本时不指定 `--foo` 将会抛出错误提示该参数是必需的。 - **位置参数** 如果不希望参数以前置短横线开头，则可以直接将其作为位置参数传入。这种类型的参数总是被视作必需的除非另有声明[^3]: ```python parser.add_argument('bar', type=int, help='这是一个整数型的位置参数 bar') ``` 这里我们还指定了数据类型 (`type`) 和帮助消息 (`help`) 来增强用户体验。 #### 解析已定义的参数 当所有的必要参数都已经被添加到解析器之后，就可以利用 `.parse_args()` 函数获取实际传来的值并存储在一个叫做 `Namespace` 的对象里： ```python args = parser.parse_args() print(args.foo) # 输出用户提供的 --foo 值 print(args.bar) # 输出用户提供的 bar 值 (如果存在的话) ``` 完整的示例代码如下所示: ```python import argparse def main(): parser = argparse.ArgumentParser(description="演示如何使用 argparse 处理命令行参数") # 添加各种形式的参数 parser.add_argument('-v', '--verbose', action='store_true', help='启用详细模式') parser.add_argument('--foo', required=True, help='必须提供的 foo 参数') parser.add_argument('bar', type=int, help='另一个强制性的整数值') args = parser.parse_args() if args.verbose: print("Verbose mode enabled.") print(f"Foo parameter value: {args.foo}") print(f"Bar parameter value: {args.bar}") if __name__ == "__main__": main() ``` 上述脚本接受两个主要参数：一个是标记开关式的布尔变量 `--verbose`；另外还有分别代表不同含义但同样重要的 `--foo` 字符串和 `bar` 整形数字。 ---