Сообщить об ошибке.

Метод add_argument_group() объекта ArgumentParser в Python

Объединение параметров командной строки в группы

Синтаксис:

import argparse

parser = argparse.ArgumentParser()
group = parser.add_argument_group(title=None, description=None)
group.add_argument(...)
...

Параметры:

  • title=None - заголовок группы параметров,
  • description=None - описание группы параметров.

Возвращаемое значение:

  • объект группы параметров.

Описание:

По умолчанию объект argparse.ArgumentParser, при отображении справочных сообщений, группирует параметры командной строки как "позиционные параметры" и "необязательные параметры".

Существует более концептуальная группировка параметров. Такие группы могут быть созданы с помощью метода parser.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

Обратите внимание, что параметры, не входящие в пользовательские группы, будут отображаться в обычных разделах "позиционные параметры" и "необязательные параметры".