Как кодировать комбинированные параметры argparse в python

Какой именно результат вы ищете? Мне неизвестен какой-либо стандартный синтаксис для обозначения взаимной исключительности в выводе --help, и, вероятно, ваши пользователи будут сбиты с толку, если вы его придумаете. Также я предполагаю, что argparse не поддерживает синтаксис для него (поскольку, если бы это было так, он бы уже работал).

Я предлагаю вам не усложнять и просто объяснять вашим пользователям взаимное исключение в справке для каждого из аргументов. Поэтому измените их строки справки следующим образом:

-c Package1 Package2, --compare Package1 Package2
                      Compare two packages (may not be used with -v).
-v Package, --verify Package
                      Verify Content of package (may not be used with -c).

Это предельно очевидно и достаточно лаконично.

Другой альтернативой было бы просто не упоминать об этом, и пользователь обнаружил бы, что они являются взаимоисключающими, пытаясь использовать их одновременно (argparse автоматически генерирует удобную для пользователя ошибку, такую ​​​​как «PROG: error: argument -c: not allowed with argument -v»).

Установите имя файла как позиционный аргумент, и пусть argparse установит собственное сообщение об использовании:

$ python so.py --help
usage: so.py [-h] [-c Package1 Package2 | -v Package] outFileName

Имя файла должно быть позиционным, и вы должны позволить argparse написать собственное сообщение об использовании.

Код

#!/usr/bin/python

import sys
import argparse

def main():
    description='Package Compare/Verifier tool.'
    parser = argparse.ArgumentParser(description=description,
                                     epilog='--compare and --verify are mutually exclusive')

    parser.add_argument('f',action='store',nargs=1,
                        help='File Name where result is stored.',
                        metavar="outFileName")

    group = parser.add_mutually_exclusive_group(required=False)
    group.add_argument('-c','--compare',action='store',nargs=2,dest='packageInfo',help='Compare two packages.',metavar=("Package1","Package2"))
    group.add_argument('-v','--verify',action='store',nargs=1,dest='packageName',help='Verify Content of package.',metavar='Package')

    args = parser.parse_args()

if __name__ == "__main__":
    main()

Справочное сообщение

$ python so.py --help
usage: so.py [-h] [-c Package1 Package2 | -v Package] outFileName

Package Compare/Verifier tool.

positional arguments:
  outFileName           File Name where result is stored.

optional arguments:
  -h, --help            show this help message and exit
  -c Package1 Package2, --compare Package1 Package2
                        Compare two packages.
  -v Package, --verify Package
                        Verify Content of package.

--compare and --verify are mutually exclusive

Я думаю, что основная жалоба связана с именами групп по умолчанию positional arguments и optional arguements. В help, optional arguments означает: requires a flag like -f or --file; positional arguments означает it is identified by position. Со значениями по умолчанию positionals действительно обязательны, а optionals действительно необязательны (не обязательны). Но пользователь может изменить это с помощью атрибута required, что приведет к путанице в терминологии.

Обойти это можно, задав собственные группы аргументов. Эти группы влияют на макет help, но не влияют на синтаксический анализ. Они также не влияют на строку usage.

def main():
    description='Package Compare/Verifier tool.'
    parser = argparse.ArgumentParser(usage=None,description=description)

    maingroup = parser.add_argument_group(title='required')
    maingroup.add_argument('-f','--file',nargs=1,dest='outFileName',help='File Name where result is stored.',metavar="outFileName",required=True)
    exgroup = parser.add_argument_group(title='one or the other')

    group = exgroup.add_mutually_exclusive_group(required=True)
    group.add_argument('-c','--compare',nargs=2,dest='packageInfo',help='Compare two packages.',metavar=("Package1","Package2"))
    group.add_argument('-v','--verify',nargs=1,dest='packageName',help='Verify Content of package.',metavar='Package')
    args = parser.parse_args()

производит:

usage: stack5603364.py [-h] -f outFileName (-c Package1 Package2 | -v Package)

Package Compare/Verifier tool.

optional arguments:
  -h, --help            show this help message and exit

required:
  -f outFileName, --file outFileName
                        File Name where result is stored.

one or the other:
  -c Package1 Package2, --compare Package1 Package2
                        Compare two packages.
  -v Package, --verify Package
                        Verify Content of package.

mutually_exclusive_group влияет только на строку usage.

(-c Package1 Package2 | -v Package)

отображает группу, в которой требуется один из вариантов.

[-c Package1 Package2 | -v Package]

будет необязательной группой. [] используются для обозначения необязательных (не обязательных) аргументов. Обратите внимание, как -h продолжает обозначаться.

http://bugs.python.org/issue9694 – связанная проблема с Python, автор argparse поддерживает эту argument_group подход.