`argparse.ArgumentParser` 是 Python 的标准库模块 `argparse` 中的一个核心类，用于解析命令行选项、参数及子命令。它能够自动生成帮助信息，并发出错误消息。以下是关于其构造函数及其常用方法的详细说明。 ### 构造函数：`ArgumentParser` #### 初始化参数： 1. **prog**: (str) - 程序名称，默认是从 sys.argv[0] 获取。你可以在这里显式地设置程序名。 2. **usage**: (str or None) - 描述命令行用法字符串，如果不指定则会从添加到此 ArgumentParser 实例的所有动作生成默认的帮助文本。 3. **description**: (str or None) - 对于该脚本功能的一段简短描述，在 --help 消息中显示之前的部分。 4. **epilog**: (str or None) - 显示在 help 文档末尾的文字内容，通常用来解释更多细节或提供示例等附加资料。 5. **parents**: ([ArgumentParser]) - 允许复用其他 parser 定义好的参数配置项列表。这对于创建共享某些选项的多个 parser 很有帮助。 6. **formatter_class**: (Formatter class) - 控制如何格式化帮助文档输出风格，默认是 argparse.HelpFormatter. 7. **prefix_chars**: (str) - 告诉 ArgumentParser 需要识别哪些字符作为前缀（如 `-`），以便将它们后面的单词视为标志位而非位置参数。 8. **fromfile_prefix_chars**: (str or None) - 如果设置了这个属性并指定了文件路径的话，那么可以从给定的文本文件里加载额外的 CLI 参数。 9. **argument_default**: (any type of object) - 设置所有参数的全局默认值，除非另有定义；一般较少使用。 10. **allow_abbrev**: (bool) - 是否允许缩写命令行开关，默认 True 表示支持像 '-v' 这样的简化形式匹配更长版本 '--version'. 11. **conflict_handler**: ('error'|'resolve') - 决策机制处理重复选项冲突的情况，解决办法要么抛出异常要么覆盖旧有的选择。 例子: ```python import argparse parser = argparse.ArgumentParser( prog='MyProgram', usage=None, description='This program does something useful.', epilog='For more information, see the official documentation.', parents=[], formatter_class=argparse.ArgumentDefaultsHelpFormatter, prefix_chars='-/', fromfile_prefix_chars='@', argument_default=None, allow_abbrev=True, conflict_handler='error' ) ``` ### 添加参数的方法：`add_argument()` 接下来我们看看如何向 ArgumentParser 实例添加具体的参数。这是一个非常重要的方法，决定了您的应用程序将会接受什么样的外部输入。 基本语法如下所示： ```python parser.add_argument(...arguments...) ``` 常用的几个关键参数包括但不限于以下几个方面： - **name / flags** : 标志符(`flags`)表示您想要使用的命令行开关的形式，比如 `'--foo'`, `'-f'`. 名称(`name`)是在没有前置连字符的情况下直接使用的唯一标识符，例如 `positional`. - **action** : 触发的动作类型，可以是 store, store_const, store_true/store_false, append, count 等不同类型的操作行为. - **nargs** : 数量指示器，确定预期有多少个数值应当与此特定参数关联起来。可能取值有 '?' 单一可选参数; '*' 零或多参数集合; '+' 至少有一个及以上连续出现的对象数组等等. - **const** : action 被触发时所存储常数，主要用于 store_const 动作. - **default** : 若未接收到对应的实际值，则返回的默认结果. - **type** : 强制转换传入的数据类型为指定格式的功能, 如 int,float 等基础数据类型. - **choices** : 提供一组合法的选择范围内的枚举值，只有当实际提供的参数属于这一组范围内才有效. - **required** : bool 类型标记是否必须提供该参数. - **help** : 给用户看的帮助信息，会在 --help 下显示出来辅助理解用途. - **metavar** : 出现在帮助文字里的替代元变量符号代表此参数. - **dest** : 将参数保存进最终 Namespace 对象中的目标属性名. 实例演示： ```python # 定义一个简单的命令行工具来获取用户的年龄和城市 parser.add_argument('--age', type=int, required=True, help='Your age.') parser.add_argument('-c','--city', default='Beijing', choices=['Beijing', 'Shanghai'], help='The city you live in.') args = parser.parse_args() print(f"You are {args.age} years old and living in {args.city}") ``` 这里 `-c/--city` 是带有一系列可用城市的下拉菜单式的参数，而 `--age` 则是一个整数类型的必要字段。最后通过调用 `.parse_args()` 解析之后就能得到包含已提交信息的新建 args 变量了！ ---