argparse.ArgumentParser()

1 简介

argparse是python用于解析命令行参数和选项的标准模块，用于代替已经过时的optparse模块。argparse模块的作用是用于解析命令行参数。

有些程序需要用到解析命令行参数，在终端窗口(ubuntu是终端窗口，windows是命令行窗口)输入训练的参数和选项。

 

2 使用方法

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

1：import argparse

2：parser = argparse.ArgumentParser()

3：parser.add_argument()

4：parser.parse_args()

上面四个步骤解释如下：首先导入该模块；然后创建一个解析对象；然后向该对象中添加你要关注的命令行参数和选项，每一个add_argument方法对应一个你要关注的参数或选项；最后调用parse_args()方法进行解析；解析成功之后即可使用。

 

3 argparse模块官方文档

argparse是一个Python模块：命令行选项、参数和子命令解析器

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

 

使用流程

　　1. 创建解析器

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

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

　　2. 添加参数

　　　(1). parser.add_argument('integers', metavar='N', type=int, nargs='+', help = 'an integer for the accumulator')

　　　给一个ArgumentParser添加程序阐述信息是通过调用add_arguement()方法完成的。

　　3. 解析参数

　　　(1). >>>parser.parse_args(['--sum', '7', '-1', '42' ])

　　　2 Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])

　　ArgumentParser通过parse_args()方法解析参数

 

ArgumentParser对象

prog - 程序的名称(默认: sys.argv[0]，prog猜测是programma的缩写)

usage - 描述程序用途的字符串(默认值：从添加到解析器的参数生成)

description - 在参数帮助文档之后显示的文本 (默认值:无)

 

add_argument()方法

name or flags - 一个命名或者一个选项字符串的列表

action - 表示该选项要执行的操作

default - 当参数未在命令行中出现时使用的值

dest - 用来指定参数的位置

type - 为参数类型，例如int

choices - 用来选择输入参数的范围。例如choice = [1, 5, 10], 表示输入参数只能为1,5 或10

help - 用来描述这个选项的作用