Взаємовиключна група Python argparse

Що мені потрібно:

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

Я спробував це, але не працює. Хтось може мені допомогти?

group= parser.add_argument_group('Model 2')
group_ex = group.add_mutually_exclusive_group()
group_ex.add_argument("-a", type=str, action = "store", default = "", help="test")
group_ex_2 = group_ex.add_argument_group("option 2")
group_ex_2.add_argument("-b", type=str, action = "store", default = "", help="test")
group_ex_2.add_argument("-c", type=str, action = "store", default = "", help="test")

Дякую!

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

Удачі.

Хоча відповідь Джонатана цілком підходить для складних варіантів, існує дуже просте рішення, яке буде працювати в простих випадках, наприклад 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)

Звичайно, цей маленький хакер працює лише для простих випадків, і це стане кошмаром перевірити всі можливі варіанти, якщо у вас є багато взаємовиключних варіантів та груп. У такому випадку вам слід розбити свої варіанти для командних груп, як запропонував Джонатан.

Існує патч для 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')