当前位置: 首页>>代码示例 >>用法及示例精选 >>正文


Python argparse.ArgumentParser.add_argument_group用法及代码示例


用法:

ArgumentParser.add_argument_group(title=None, description=None)

默认情况下,当显示帮助消息时,ArgumentParser 将 命令行 参数分组为 “positional arguments” 和 “optional arguments”。当参数的概念分组比这个默认分组更好时,可以使用 add_argument_group() 方法创建适当的组:

>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> group = parser.add_argument_group('group')
>>> group.add_argument('--foo', help='foo help')
>>> group.add_argument('bar', help='bar help')
>>> parser.print_help()
usage: PROG [--foo FOO] bar

group:
  bar    bar help
  --foo FOO  foo help

add_argument_group() 方法返回一个参数组对象,该对象具有 add_argument() 方法,就像常规的 ArgumentParser 一样。将参数添加到组时,解析器将其视为普通参数,但将参数显示在单独的组中以获取帮助消息。 add_argument_group() 方法接受可用于自定义此显示的 titledescription 参数:

>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> group1 = parser.add_argument_group('group1', 'group1 description')
>>> group1.add_argument('foo', help='foo help')
>>> group2 = parser.add_argument_group('group2', 'group2 description')
>>> group2.add_argument('--bar', help='bar help')
>>> parser.print_help()
usage: PROG [--bar BAR] foo

group1:
  group1 description

  foo    foo help

group2:
  group2 description

  --bar BAR  bar help

请注意,不在您的用户定义组中的任何参数都将返回到通常的 “positional arguments” 和 “optional arguments” 部分。

相关用法


注:本文由纯净天空筛选整理自python.org大神的英文原创作品 argparse.ArgumentParser.add_argument_group。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。