python argparse.ArgumentParser().add_argument

<think>我们正在讨论Python的argparse模块，特别是add_argument方法的使用。根据引用[1][2][3][4]，我们可以总结如下： add_argument()方法用于向ArgumentParser对象添加命令行参数或选项。它允许我们指定参数的名称、类型、默认值、帮助信息等。 基本语法： ```python parser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest]) ``` 参数说明（常用）： - `name or flags`：位置参数名（如'arg1'）或选项字符串（如'-f', '--foo'）。 - `action`：参数触发时的动作，如'store'（默认，存储值）、'store_const'（存储const指定的值）、'store_true'（存储True，若出现）、'append'（将多次出现的值存储为列表）等。 - `nargs`：应该读取的命令行参数个数，可以是整数、'?'（0或1个）、'*'(0或多个)、'+'(1或多个)。 - `const`：某些action和nargs选项需要的常量值。 - `default`：参数默认值。 - `type`：参数类型（如int, float, str等）。 - `choices`：参数允许的值（容器类型，如[1,2,3]）。 - `required`：选项是否必须（仅用于选项参数，如'-f'）。 - `help`：参数的帮助信息。 - `metavar`：在帮助信息中显示的参数名称（对位置参数默认是参数名，对选项参数默认是大写的选项字符串）。 - `dest`：解析结果中属性的名称（默认情况下，对于位置参数是参数名，对于选项参数是去掉前缀的长选项名）。 示例（引用[4]）： ```python import argparse # 创建解析器 parser = argparse.ArgumentParser(description='Full Example.') # 添加参数 parser.add_argument('--foo', type=int, help='An integer argument') parser.add_argument('--bar', type=str, help='A string argument') parser.add_argument('--flag', action='store_true', help='A boolean flag') # 解析参数 args = parser.parse_args() # 使用参数 print(f"Foo: {args.foo}") print(f"Bar: {args.bar}") print(f"Flag: {args.flag}") ``` 运行示例： ```bash $ python script.py --foo 42 --bar hello --flag ``` 输出： ``` Foo: 42 Bar: hello Flag: True ``` 注意： - 位置参数（如引用[1]中的'arg1'）不需要前缀，直接按顺序给出。 - 选项参数（如'--arg2'或'-a'）可以按任意顺序给出。 §§相关问题§§ 1. 如何使一个参数接受多个值？ 2. 如何设置互斥参数？ 3. 如何添加子命令（类似git add, git commit）？ 4. 如何自定义参数的处理逻辑？</think>### Python argparse.ArgumentParser add_argument方法详解 `argparse.ArgumentParser.add_argument()` 是 Python 标准库中用于定义命令行参数的核心方法。它允许你指定脚本接受哪些参数，以及如何解析这些参数[^2]。以下是详细使用方法： #### 基本语法 ```python parser.add_argument(name_or_flags, action=None, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None) ``` #### 主要参数说明 1. **位置参数 vs 选项参数** - 位置参数（无前缀）： ```python parser.add_argument('filename') # 用法: script.py data.txt ``` - 选项参数（带`-`或`--`）： ```python parser.add_argument('-o', '--output') # 用法: script.py -o result.txt ``` 2. **常用参数详解** - `type`：指定参数类型（默认字符串） ```python parser.add_argument('--num', type=int) # 自动转换为整数 ``` - `default`：设置默认值 ```python parser.add_argument('--verbose', default=False) ``` - `help`：添加帮助文档 ```python parser.add_argument('--input', help='输入文件路径') ``` - `required`：标记必需参数 ```python parser.add_argument('--config', required=True) ``` - `choices`：限制可选值 ```python parser.add_argument('--color', choices=['red', 'green', 'blue']) ``` 3. **特殊操作类型** - 布尔标志（无需值）： ```python parser.add_argument('--debug', action='store_true') # 存在则为True ``` - 计数参数： ```python parser.add_argument('-v', action='count') # -v → 1, -vv → 2 ``` - 列表参数： ```python parser.add_argument('--files', nargs='+') # 接受多个值 ``` #### 完整示例 ```python import argparse # 1. 创建解析器 parser = argparse.ArgumentParser(description='文件处理工具') # 2. 添加参数 parser.add_argument('input_file', help='输入文件名') parser.add_argument('-o', '--output', default='output.txt', help='输出文件名') parser.add_argument('--size', type=int, choices=[1, 2, 4], default=1) parser.add_argument('--verbose', action='store_true', help='显示详细日志') # 3. 解析参数 args = parser.parse_args() # 4. 使用参数 print(f"处理文件: {args.input_file}") print(f"输出到: {args.output}") if args.verbose: print("详细模式已启用") ``` 运行示例： ```bash $ python script.py data.txt -o result.txt --verbose ``` #### 最佳实践 1. 为所有参数添加`help`描述 2. 对数值参数始终指定`type` 3. 使用`--`前缀的选项参数更易读 4. 通过`metavar`自定义帮助信息中的参数名 ```python parser.add_argument('--ratio', metavar='R', type=float) ```