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) 定义一个组。

1     info_group = parser.add_argument_group('Device information')
2     read_group = parser.add_argument_group('Read and compare functions')
3     write_group = parser.add_argument_group('Erase and write functions')
4     run_group = parser.add_argument_group('Code execution functions')

 

方法参数查找表

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)

参数:

    prog:程序的名字
    usage:默认情况下,ArgumentParser依据它包含的参数计算出帮助信息
    description:这个参数给出程序做什么以及如何工作的简短描述
    epilog:显示额外的关于程序的描述
    parents:有时候,几个解析器会共享一个共同的参数集。可以使用一个带有所有共享参数的解析器传递给ArgumentParser的parents=参数,而不用重复定义这些参数
    formatter_class:ArgumentParser对象允许通过指定一个格式化类来定制帮助信息的格式(argparse.RawDescriptionHelpFormatter、argparse.RawTextHelpFormatter、argparse.ArgumentDefaultsHelpFormatter、argparse.MetavarTypeHelpFormatter)
    prefix_chars:修改前缀符
    fromfile_prefix_chars:以任意一个给定字符开始的参数将被当做文件,并且将被这些文件包含的参数替换
    argument_default:指定一个解析器范围的参数默认值
    allow_abbrev:允许使用缩写(默认)
    conflict_handler:关于设置同一个选项具有两个动作
    add_help

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的获得则是将第一个短选项字符串前面的-字符去掉。任何内部的-将被转换为字符以确保字符串是合法的属性名字。(即对于可选参数,先找长的选项字符串,再找短选项字符串,并且内部的-会被转换为字符。)

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


3.ArgumentParser对象parse_args()方法

将参数字符串转换成对象并设置成命名空间的属性。返回构成的命名空间。
之前对add_argument() 的调用完全决定了创建什么对象以及如何设置。

选项值语法,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=关键字参数达到。


posted @ 2019-05-08 15:15  茶小绿  阅读(7556)  评论(0编辑  收藏