Argparse Python用法解析

• argparse — 命令行选项、参数和子命令解析器 官方文档

argparse是一个Python库，用于编写用户友好的命令行接口，程序定义它需要的参数，然后 argparse 将弄清如何从 sys.argv 解析出那些参数。 argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

简单实例：

# py文件
import argparse   #调用模块
#必须加载的类
parser = argparse.ArgumentParser(description='Process some integers.')
#添加参数
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')
#解析参数
args = parser.parse_args()
print(args.accumulate(args.integers))


# 命令行
$ python prog.py -h      #argparse自动生成的帮助
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

optional arguments:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

• Step1: 创建一个解析器

使用argparse的第一步是创建一个ArgumentParser对象，ArgumentParser对象包含将命令行解析成python数据类型所需要的全部信息。

parser =  argparse.ArgumentParser(description='Process some integers.')

说明：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)

创建一个新的ArgumentParser对象，所有的参数都应当最为关键字参数传入，参数总结如下：

参数	说明
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）

• Step2: 添加参数

给一个ArgumentParser添加程序参数信息是通过调用add_argument()方法完成的。通常，这些调用指定ArgumentParser如何获取命令行字符串并将其转换为对象。

parse.add_argument('--sum', dest='accumulate', action='store_const', const=sum, default=max,
help='sum the integers(default:find the max)')

说明：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’, etc.
nargs	命令行参数应当消耗的数目	若不提供则由action决定消耗参数数目
const	被一些 action 和 nargs 选择所需求的但不从命令行读取的常数	使用store_const append_const时须给出
default	当参数未在命令行中出现时使用的值	默认None
type	命令行参数(默认被当作字符)应当被转换成的类型
choices	可用的参数的容器	使得检查更方便的检查一个范围的值
required	此命令行选项是否可省略 （仅选项可用）
help	一个此选项作用的简单描述
metavar	- 在使用方法消息中使用的参数值示例
dest	被添加到 parse_args() 所返回对象上的属性名

• Step3: 解析参数

ArgumentParser通过parse_args()方法解析参数。它将检查命令行，把每个参数转换为适当的类型然后调用相应的操作。

parser.parse_args()

参考：

[1] argparse官方文档
[2] argparse.ArgumentParser()用法解析