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

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', dest="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(subcommand='command_1', 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

祝你好运。

Answer 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")
parser.add_argument("-f", "--fields", help="field names")

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

我在这里使用为命令行包装器提供的选项来查询 mongodb。 collection实例可以使用可选参数query和fields调用方法aggregate或find方法，因此您会看到为什么前两个参数兼容而最后一个参数不兼容。

所以现在我运行parser.parse_args()并检查它的内容：

args = parser.parse_args()

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

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

Answer 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')

Answer 4

如果您不想要子解析器，目前可以使用互斥组来完成，但公平警告，它涉及访问私有变量，因此使用它需要您自担风险。 这个想法是您希望-a与-b和-c互斥，但-b和-c不希望彼此互斥

import argparse
p = argparse.ArgumentParser()

# first set up a mutually exclusive group for a and b
g1 = p.add_mutually_exclusive_group()
arg_a = g1.add_argument('-a')  # save this _StoreAction for later
g1.add_argument('-b')

# now set up a second group for a and c 
g2 = p.add_mutually_exclusive_group()
g2.add_argument('-c')
g2._group_actions.append(arg_a)  # this is the magic/hack

现在我们有了-c和-b独有的-a 。

a = p.parse_args(['-a', '1'])
# a.a = 1, a.b = None, a.c = None

a = p.parse_args(['-a', '1', '-b', '2'])
# usage: prog.py [-h] [-a A | -b B] [-c C]
# prog.py: error: argument -b: not allowed with argument -a

请注意，它确实弄乱了帮助消息，但您可能会覆盖它，或者只是忽略它，因为您拥有所需的功能，无论如何这可能更重要。

如果您想确保我们是否使用 b 和 c 中的任何一个，我们必须同时使用它们，然后在实例化互斥组时只需添加required=True关键字 arg。