argparse —— 命令行选项、参数和子命令解析器

本文链接：https://blog.csdn.net/weixin_48697962/article/details/125810733

一.概述

argparse是一个Python模块：命令行选项、参数和子命令解析器。
argparse模块可以让人轻松地编写出用户友好的命令行接口。程序定义它所需要的参数，然后argparse 可以从 sys.argv 中解析出那些参数。 argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

可以把argparse的使用简化成以下四个步骤：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument()
parser.parse_args()

上面四个步骤解释如下：

首先导入该模块；

然后创建一个解析对象；

然后向该对象中添加你要关注的命令行参数和选项，每一个add_argument方法对应一个你要关注的参数或选项；

最后调用parse_args()方法进行解析；解析成功之后即可使用。使用parse_args()解析添加的参数，返回一个args对象。

二、详解

1、ArgumentParser 对象

class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], 
      formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, 
      argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)

prog - 程序的名称（默认：sys.argv[0]）
usage - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）
description - 在参数帮助文档之前显示的文本（默认值：无）
epilog - 在参数帮助文档之后显示的文本（默认值：无）
parents - 一个 ArgumentParser 对象的列表，它们的参数也应包含在内
formatter_class - 用于自定义帮助文档输出格式的类
prefix_chars - 可选参数的前缀字符集合（默认值：'-'）
fromfile_prefix_chars - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值：None）
argument_default - 参数的全局默认值（默认值： None）
conflict_handler - 解决冲突选项的策略（通常是不必要的）
add_help - 为解析器添加一个 -h/--help 选项（默认值： True）
allow_abbrev - 如果缩写是无歧义的，则允许缩写长选项（默认值：True）
exit_on_error - 决定当错误发生时是否让 ArgumentParser 附带错误信息退出。 (默认值: True)

2、add_argument() 方法：添加参数

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type]
               [, choices][, required][, help][, metavar][, dest])

name or flags - 一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo。以-开头。【注意-会被解析为_】
action - 命令行遇到参数时的动作，默认值是 store，store_const，表示赋值为const。【action='store_true'，指触发action时为真，不触发为假；也就是说，只要运行时该变量有传参就将该变量设为True】
nargs - 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数
const - 被一些 action 和 nargs 选择所需求的常数。
const- action 和 nargs 所需要的常量值。
default - 当参数未在命令行中出现时使用的默认值（不指定参数时的默认值）
type - 参数类型，如int。
choices - 用来选择输入参数的范围。例如choice = [1, 5, 10], 表示输入参数只能为1,5 或10。
required-可选参数是否可以省略 (仅针对可选参数)。
help - 用来描述这个选项的作用，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息。
metavar-在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称。
dest - 用来指定参数的位置。