【Python】argparse - 命令行选项、参数和子命令解析器

• 一. 介绍
• 二. API
  • 2.1 位置参数
  • 2.2 可选参数
  • 2.3 短参数
  • 2.4 冗长参数
    • 2.4.1 不定参数
    • 2.4.2 计数参数
  • 2.5 区间参数
  • 2.6 互斥参数
  • 2.7 nargs 值类型
  • 2.8 Action 值类型
  • 2.9 const 参数类型
  • 2.10 choices 参数类型
  • 2.11 metavar 参数类型
  • 2.12 dest 参数类型
• 三. 说明与引用
• 四. 参考

一. 介绍

argparse 模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数，然后 argparse 将弄清如何从 sys.argv 解析出那些参数。

argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

二. API

定义单个的命令行参数应当如何解析。每个形参都在下面有它自己更多的描述，长话短说有：

name or flags - 一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo。
action - 当参数在命令行中出现时使用的动作基本类型。
nargs - 命令行参数应当消耗的数目。
const - 被一些 action 和 nargs 选择所需求的常数。
default - 当参数未在命令行中出现时使用的值。
type - 命令行参数应当被转换成的类型。
choices - 可用的参数的容器。
required - 此命令行选项是否可省略(仅选项可用)。
help - 一个此选项作用的简单描述。
metavar - 在使用方法消息中使用的参数值示例。
dest - 被添加到 parse_args() 所返回对象上的属性名。

常用参数类型有如下几种:

*name_or_flags
action
nargs
const
default
type
choices
required
help
metavar
dest
version
**kwargs

2.1 位置参数

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
args = parser.parse_args()

2.2 可选参数

import argparse

parser = argparse.ArgumentParser()
parser.add_argument<