Совместная эксклюзивная группа Python argparse

Ответ 1

add_mutually_exclusive_group не делает целую группу взаимоисключающей. Это делает опции внутри группы взаимоисключающими.

То, что вы ищете, это подкоманды. Вместо prog [-a xxxx | [-b yyy -c zzz]], у вас будет:

prog 
  command 1 
    -a: ...
  command 2
    -b: ...
    -c: ...

Чтобы вызвать с помощью первого набора аргументов:

prog command_1 -a xxxx

Чтобы вызвать второй набор аргументов:

prog command_2 -b yyyy -c zzzz

Вы также можете установить аргументы вспомогательной команды как позиционные.

prog command_1 xxxx

Вид вроде git или svn:

git commit -am
git merge develop

Рабочий пример

# create the top-level parser
parser = argparse.ArgumentParser(prog='PROG')
parser.add_argument('--foo', action='store_true', help='help for foo arg.')
subparsers = parser.add_subparsers(help='help for subcommand')

# create the parser for the "command_1" command
parser_a = subparsers.add_parser('command_1', help='command_1 help')
parser_a.add_argument('a', type=str, help='help for bar, positional')

# create the parser for the "command_2" command
parser_b = subparsers.add_parser('command_2', help='help for command_2')
parser_b.add_argument('-b', type=str, help='help for b')
parser_b.add_argument('-c', type=str, action='store', default='', help='test')

Проверить его

>>> parser.print_help()
usage: PROG [-h] [--foo] {command_1,command_2} ...

positional arguments:
  {command_1,command_2}
                        help for subcommand
    command_1           command_1 help
    command_2           help for command_2

optional arguments:
  -h, --help            show this help message and exit
  --foo                 help for foo arg.
>>>

>>> parser.parse_args(['command_1', 'working'])
Namespace(a='working', foo=False)
>>> parser.parse_args(['command_1', 'wellness', '-b x'])
usage: PROG [-h] [--foo] {command_1,command_2} ...
PROG: error: unrecognized arguments: -b x

Удачи.

Ответ 2

В то время как ответ Джонатана отлично подходит для сложных вариантов, есть очень простое решение, которое будет работать для простых случаев, например. 1 исключает 2 других варианта, таких как

command [- a xxx | [ -b yyy | -c zzz ]] 

или даже как в исходном вопросе:

pro [-a xxx | [-b yyy -c zzz]]

Вот как я это сделаю:

parser = argparse.ArgumentParser()

# group 1 
parser.add_argument("-q", "--query", help="query", required=False)
parser.add_argument("-f", "--fields", help="field names", required=False)

# group 2 
parser.add_argument("-a", "--aggregation", help="aggregation",
                    required=False)

Я использую здесь опции, предоставленные оболочке командной строки для запроса mongodb. Экземпляр collection может либо вызвать метод aggregate, либо метод find с дополнительными аргументами query и fields, поэтому вы видите, почему первые два аргумента совместимы, а последний - нет.

Итак, теперь я запускаю parser.parse_args() и проверяю его содержимое:

args = parser().parse_args()

print args.aggregation
if args.aggregation and (args.query or args.fields):
    print "-a and -q|-f are mutually exclusive ..."
    sys.exit(2)

Конечно, этот маленький взлом работает только для простых случаев, и для кошмаров можно было бы проверить все возможные варианты, если у вас есть много взаимоисключающих опций и групп. В этом случае вы должны разбить свои параметры в командных группах, как предположил Джонатан.

Ответ 3

Существует патч python (в разработке), который позволит вам сделать это.
http://bugs.python.org/issue10984

Идея состоит в том, чтобы позволить перекрывать взаимоисключающие группы. Поэтому usage может выглядеть так:

pro [-a xxx | -b yyy] [-a xxx | -c zzz]

Изменение кода argparse, чтобы вы могли создать две группы, такие как это была легкая часть. Изменение кода форматирования usage требует записи пользовательского HelpFormatter.

В argparse, группы действий не влияют на синтаксический анализ. Это всего лишь инструмент форматирования help. В help взаимоисключающие группы влияют только на строку usage. При анализе parser использует взаимоисключающие группы для создания словаря потенциальных конфликтов (a не может встречаться с b или c, b не может произойти с a и т.д.)., а затем вызывает ошибку, если возникает конфликт.

Без этого патча argparse я считаю, что ваш лучший выбор - проверить пространство имен, созданное parse_args самостоятельно (например, если оба a и b имеют значения небезопасности) и поднимите собственную ошибку. Вы даже можете использовать собственный механизм анализа парсера.

parser.error('custom error message')