Python argparse互斥组

Question

我需要的是：

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

谢谢！

Answer 1

有一个python补丁（正在开发中）允许您这样做。
http://bugs.python.org/issue10984

这样做的目的是允许相互排斥的群体重叠。所以usage看起来像：

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

更改argparse代码，以便可以创建两个组，这是最简单的部分。更改usage格式代码需要编写自定义HelpFormatter。

在argparse中，动作组不影响解析。它们只是一个格式化工具。在help中，互斥组只影响usage行。解析时，parser使用互斥组构造潜在冲突的字典（a不能与b或c一起出现，b不能与a等一起出现），然后在发生冲突时引发错误。

如果没有argparse补丁，我认为最好的选择是自己测试由parse_args生成的名称空间（例如，如果a和b都有非默认值），并引发自己的错误。甚至可以使用解析器自己的错误机制。

parser.error('custom error message')

Answer 2

虽然Jonathan's answer对于复杂的选项来说非常好，但是对于简单的情况，有一个非常简单的解决方案，例如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，也可以调用具有可选参数query和fields的方法find，因此您可以看到前两个参数兼容而最后一个参数不兼容的原因

现在我运行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)

当然，这个小技巧只适用于简单的情况，如果你有许多相互排斥的选项和组，那么检查所有可能的选项将成为一场噩梦。在这种情况下，你应该打破你的选择，以命令组，如乔纳森建议。

Answer 3

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

你要找的是subcommands。而不是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

祝你好运。