Python argparse互斥组

Question 1

我需要的是：

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")

谢谢！

Question 2

add_mutually_exclusive_group不会使整个组互斥。它使组内的选项互斥。

您正在寻找的是子命令。而不是编[-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

祝好运。

Question 3

虽然乔纳森（Jonathan）的答案对于复杂选项来说是完全可以的，但有一个非常简单的解决方案将适用于简单情况，例如，一个选项排除了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)

当然，这个小技巧仅适用于简单的情况，如果您有许多互斥的选项和组，那么检查所有可能的选项将成为噩梦。在这种情况下，您应该像乔纳森（Jonathan）建议的那样将您的选择分成多个命令组。

Question 4

有一个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')