【Python】argparse

参考1
参考2
官方连接
argparse 模块是 Python 内置的一个用于命令项选项与参数解析的模块，argparse 模块可以让人轻松编写用户友好的命令行接口。通过在程序中定义好我们需要的参数，然后 argparse 将会从 sys.argv 解析出这些参数。argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。[parse:解析]

初始化

import argparse
import sys
parse1=argparse.ArgumentParser()
parse2=argparse.ArgumentParser(description=‘description’)# 可以添加描述，\
# 这个参数简要描述这个程度做什么以及怎么做。在帮助消息中，\
# 这个描述会显示在命令行用法字符串和各种参数的帮助消息之间。

添加参数

示例：

# 在parse1中添加参数
parse1.add_argument('--dataset', default='cifar10', type=str)
parse1.add_argument('--eval', action='store_true', help='Perform evaluation only')

函数原型

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；
append-将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
append_const-将参数规范中定义的一个值保存到一个列表；
count-存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析；
nargs - 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
const - action 和 nargs 所需要的常量值。
default - 不指定参数时的默认值。
type - 命令行参数应该被转换成的类型。
choices - 参数可允许的值的一个容器。
required - 可选参数是否可以省略 (仅针对可选参数)。
help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

解析参数

• args = parse1.parse_args(args=[])
• args, remaining = parse1.parse_known_args()