python——argparse

argparse是python用于解析命令行参数和选项的标准模块，类似于linux中的ls指令，后面可以跟着不同的参数选项以实现不同的功能，argparse就可以解析命令行然后执行相应的操作。

argparse 使用

使用argparse 配置命令行参数时，需要三步：

1. 创建 ArgumentParser() 对象
2. 调用 add_argument() 方法添加参数
3. 使用 parse_args() 解析添加的参数

parser = argparse.ArgumentParser()   ### 必写项

parser.add_argument("-p", "--port",
dest='port',
default="/dev/ttyUSB0",
help="serial port where the MCU is connected to.")

parser.add_argument("-v", "--version",
dest='version',
action='store_true',
help="show the version number of this program and exit.")

args = parser.parse_args()   ### 必写项

某些情况下，你想将参数按照功能进行概念分组，以便用户方便使用，比如写操作的参数作为一个组，读操作的参数作为一个组，可以使用

ArgumentParser.add_argument_group(title=None, description=None) 定义一个组。
 parser = argparse.ArgumentParser()   ### 必写项
##创建4个分组
 info_group = parser.add_argument_group('Device information')
 read_group = parser.add_argument_group('Read and compare functions')
#添加参数到这些分组
info_group.add_argument('--info')
read_group.add_argument（'--read'）

args = parser.parse_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)

参数：

description - 命令行帮助的开始文字，大部分情况下，我们只会用到这个参数

epilog - 命令行帮助的结尾文字

prog - (default: sys.argv[0])程序的名字，一般不需要修改，另外，如果你需要在help中使用到程序的名字，可以使用%(prog)s

prefix_chars - 命令的前缀，默认是-，例如-f/–file。有些程序可能希望支持/f这样的选项，可以使用prefix_chars=”/”

fromfile_prefix_chars - (default: None)如果你希望命令行参数可以从文件中读取，就可能用到。例如，如果fromfile_prefix_chars=’@’,命令行参数中有一个为”@args.txt”，args.txt的内容会作为命令行参数

add_help - 是否增加-h/-help选项 (default: True)，一般help信息都是必须的，所以不用设置啦。

parents - 类型是list，如果这个parser的一些选项跟其他某些parser的选项一样，可以用parents来实现继承，例如parents=[parent_parser]

三个允许的值： # class argparse.RawDescriptionHelpFormatter 直接输出description和epilog的原始形式（不进行自动换行和消除空白的操作） # class argparse.RawTextHelpFormatter 直接输出description和epilog以及add_argument中的help字符串的原始形式（不进行自动换行和消除空白的操作） # class argparse.ArgumentDefaultsHelpFormatter 在每个选项的帮助信息后面输出他们对应的缺省值，如果有设置的话。这个最常用吧！

argument_default - (default: None)设置一个全局的选项的缺省值，一般每个选项单独设置，所以这个参数用得少，不细说

usage - (default: generated)如果你需要修改usage的信息（usage: PROG [-h] [–foo [FOO]] bar [bar …]），那么可以修改这个，一般不要修改。

conflict_handler - 不建议使用。这个在极端情况下才会用到，主要是定义两个add_argument中添加的选项的名字发生冲突时怎么处理，默认处理是抛出异常。
 

2.ArgumentParser对象add_argument()方法

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

参数

    name or flags：传递给add_argument() 的第一个参数因此必须是一个标记序列或者一个简单的参数名字

    action：指出应该如何处理命令行参数（支持的操作：’store’ ，’store_const’，’store_true’，’store_false’，’append’，’append_const’，’count’，’help’，’version’）

    nargs：将一个动作与不同数目的命令行参数关联在一起（支持的值：N,’?’,’*’,’+’）

    const：用于保存常量值，它们不是从命令行读入但是是ArgumentParser 的动作所要求的

    default：其默认值为None，指出如果命令行参数没有出现时它们应该是什么值

    type：允许任意必要的类型检查并作类型转换

    choices：某些命令行参数应该从一个受限的集合中选择

    required：如果要使得选项是必需的，可以指定True作为required=关键字参数的值给add_argument()

    help：包含参数简短描述的字符串

    metavar：默认情况下，对于位置参数直接使用dest的值，对于可选参数则将dest的值变为大写。注意metavar只会改变显示出来的名字parse_args() 对象中属性的名字仍然由dest的值决定。

    dest ：对于位置参数的动作，dest 通常作为第一个参数提供给add_argument()，对于可选参数的动作，dest的动作通常从选项字符串推导出来，如： ArgumentParser生成的dest的值是将第一个长的选项字符串前面的–字符串去掉。如果没有提供长选项字符串，dest的获得则是将第一个短选项字符串前面的-字符去掉 。任何内部的-将被转换为字符以确保字符串是合法的属性名字。（即对于可选参数，先找长的选项字符串，再找短选项字符串，并且内部的-会被转换为字符。）

# ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest]) 
# add_argument的参数是比较复杂的。。。 
# name or flags - 指定参数的形式，想写几个写几个，不过我们一般就写两个，一个短参数，一个长参数，看下面的例子"-f", "--file" 
# 可选的选项，位置不固定，想怎么写就怎么写，默认是可选的 
parser.add_argument("-f", "--file", help="test test test") 
# 位置固定的选项，例如"prog i_am_bar"，这样子的话，i_am_bar就是bar选项的值啦，默认是必须有的 
parser.add_argument("bar", help="test test test") 
# nargs - 指定这个参数后面的value有多少个，例如，我们希望使用-n 1 2 3 4，来设置n的值为[1, 2, 3, 4] 
parser.add_argument("-n", "--num", nargs="+", type=int) 
# 这里nargs="+"表示，如果你指定了-n选项，那么-n后面至少要跟一个参数，+表示至少一个,?表示一个或0个,*0个或多个， 
# default - 如果命令行没有出现这个选项，那么使用default指定的默认值 
parser.add_argument("+g", "++gold", help="test test test", default="test_gold")#需要prefix_chars包含"+" 
# type - 如果希望传进来的参数是指定的类型（例如 float, int or file等可以从字符串转化过来的类型），可以使用 
parser.add_argument("-x", type=int) 
# choices - 设置参数值的范围，如果choices中的类型不是字符串，记得指定type哦 
parser.add_argument("-y", choices=['a', 'b', 'd']) 
# required - 通常-f这样的选项是可选的，但是如果required=True那么就是必须的了 
parser.add_argument("-z", choices=['a', 'b', 'd'], required=True) 
# metavar - 参数的名字，在显示 帮助信息时才用到. 
parser.add_argument("-o", metavar="OOOOOO") 
# help - 设置这个选项的帮助信息 
# dest - 设置这个选项的值就是解析出来后放到哪个属性中 
parser.add_argument("-q", dest="world")  
args = parser.parse_args(args) # 如果你没有args参数，那么就使用sys.argv，也就是命令行参数啦。有这个参数，就方便我们调试啊 

Action类

class argparse.Action(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

parser = argparse.ArgumentParser(description = 'this is a description')
parser.add_argument('--ver', '-v', action = 'store_true', help = 'hahaha')
# 将变量以标签-值的字典形式存入args字典
args = parser.parse_args()
if args.ver:
    print("Ture")
else:
    print("False")

# required标签就是说--ver参数是必需的，并且类型为int，输入其它类型会报错
parser.add_argument('--ver', '-v', required = True, type = int)

3.ArgumentParser对象parse_args()方法

将参数字符串转换成对象并设置成命名空间的属性。返回构成的命名空间。

之前对add_argument() 的调用完全决定了创建什么对象以及如何设置。

>>> parser.add_argument('--x') 
>>> parser.add_argument('--foo')
>>> parser.parse_args(['--x', 'X'])
Namespace(foo=None, x='X')
>>> parser.add_argument('--x')
>>> parser.add_argument('--foo')
>>> agrs=parser.parse_args()
>>> args.x='X'
>>> args.foo='FOO'

选项值语法，parse_args()方法支持几种指定一个选项的值的方法：

    最简单的方法是，将选项和它的值以两个分开的参数传递

    对于长选项（名字长度超过一个字符的选项），选项和它的值还可以用一个单一的命令行参数传递，并用=分隔它们

    对于短选项（长度只有一个字符的选项），选项及其值可以连在一起

    几个短选项可以连在一起仅使用一个-前缀，只要只有最后一个选项要求有值或者都不要有值

无效参数

在解析命令行的同时，parse_args()会检查各种错误，包括有歧义的选项、不合法的类型、不合法的选项、错误的位置参数个数等等。当它遇到此类错误时，会退出并跟随用法信息一起打印出错误。

参数包含“ - ”

parse_args()方法每当用户犯了明确的错误时会努力给出错误信息，但是有些情况天生就有歧义。例如，命令行参数-1既可以是想指明一个选项也可以是想提供一个位置参数。这里parse_args()会非常小心：位置参数只有在它们看上去像负数且解析器中没有选项看上去是负数时才可以以-开始。

如果你有必须以- 开始的位置参数且不是负数，你可以插入伪参数’–’告诉parse_args()其后的所有内容都为位置参数。

参数缩写（前缀匹配）

参数不来自sys.argv

有时候可能需要ArgumentParser解析的参数不是来自sys.argv。这可以通过传递一个字符串列表给parse_args()来完成

4.class argparse.Namespace

parse_args() 默认使用的简单的类，用于创建一个保存属性的对象并返回该对象。

有时可能需要让ArgumentParser分配属性给一个已经存在的对象而不是一个新的Namespace对象。这可以通过指定namespace=关键字参数达到。