argparse 互斥组-IT科技

摘要：问题描述：我需要的是：pro [-a xxx | [-b yyy -c zzz]] 我尝试了这个但是没有用：group= parser.add_argument_group('Model 2') group_ex = group.add_mutually_exclusive_group() group_ex....

问题描述：

我需要的是：

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

解决方案 1：

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

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

祝你好运。

解决方案 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实例可以调用方法或带有可选参数和的aggregate方法，因此您会看到为什么前两个参数兼容而最后一个参数不兼容。find`query`fields

现在我运行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 建议的那样将选项分成命令组。

解决方案 3：

如果您不需要子解析器，目前可以使用互斥组来完成此操作，但请注意，它涉及访问私有变量，因此请自行承担风险。这个想法是您希望与和-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

现在我们已经拥有和的-a独家经营权。-c`-b`

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。