argparse命令行解析模块

argparse命令行解析模块

一个可执行文件或者脚本都可以接受参数。

ls -l /etc
# /etc 是位置参数
# -l 是短选项
# /etc对应的是位置参数 -l对应的是选项参数

• 参数分类：
  1. 位置参数：参数放在那里，就要对应一个参数位置。
  2. 选项参数：必须通过前面是-的短选项或者--长选项，开头的字符串，后面字符才算选项参数，当然选项后面也可以没有参数。

argparse模块中的ArgumentParser对象

• 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]的basename
  • usage #str类型，描述程序使用情况的字符串。默认值为None，表示由添加到程序使用参数的字符串生成。
  • description #str类型。程序的描述信息
  • epilog #str类型。参数help之后显示的文本信息。
  • parents #list类型。ArgumentParser对象中使用的参数组成的列表。默认值为[]空列表
  • formatter_class #class。自定义帮助输出的类。
  • prefix_chars #前缀参数的字符集合。默认值为"-"
  • fromfile_prefix_chars #附加参数的前缀文件的一组字符
  • argument_default #参数的全局默认值，默认值为None
  • confict_handler #解决冲突选项的策略，通常不需要设置。
  • add_help #是否自动为解析器增加-h和–help选项，默认值为True
  • allow_abbrev #允许长选项被缩写 默认值为：True
• 简单示例：

import argparse
parser = argparse.ArgumentParser() #获得一个参数解析器
args = parser.parse_args("") #分析参数 注意：如果是控制台允许可以将参数“”去掉，接受控制台传入
parser.print_help() #打印帮助

执行结果为：

1. argparse不仅仅帮助做了参数解析，还会自动帮助生成帮助信息。尤其是usage,可以看到现在定义的参数是否是自己想要的。

ArgumentParser对象常用方法

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

  • name or flags # 参数名称 例如-f,–foo

  • action #命令行中遇到此参数后采取的基本操作类型

    • action可选值为如下：都是str类型。
    • “store” #默认操作，表示添加的参数用来存储一个值。

      >>> parser = argparse.ArgumentParser()
      >>> parser.add_argument('--foo')
      >>> parser.parse_args('--foo 1'.split())
      Namespace(foo='1')
      

    • “store_const” #需要结合const来使用表示参数，如果用户传入了指定的参数，那么参数对应的值九尾const指定的值。

      >>> parser = argparse.ArgumentParser()
      >>> parser.add_argument('--foo', action='store_const', const=42)
      >>> parser.parse_args(['--foo'])
      Namespace(foo=42)
      

    • “store_true” #用户指定了参数。那么参数对应的值就为True，否则为False
    • “store_false” #用户指定了参数。那么参数对应的值就为False,否则为True

      >>> parser = argparse.ArgumentParser()
      >>> parser.add_argument('--foo', action='store_true')
      >>> parser.add_argument('--bar', action='store_false')
      >>> parser.add_argument('--baz', action='store_false')
      >>> parser.parse_args('--foo --bar'.split())
      Namespace(foo=True, bar=False, baz=