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() 方法接受可用於自定義此顯示的 title 和 description 參數：

>>> 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。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。