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

# 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

祝你好运。

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和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建议的命令组。

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

Python argparse互斥组

3 个答案:

工作示例

测试