Python argparse 互斥组

Posted 2023-03-25

【中文标题】Python argparse 互斥组

【英文标题】：Python argparse mutual exclusive group

【发布时间】：2021-12-20 21:25:06

【问题描述】：

我需要的是：

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

谢谢！

【问题讨论】：

How to make python argparse mutually exclusive group arguments without prefix?的可能重复

正在插入，但我想提一下我的库 joffrey。让您做这个问题想要做的事情，例如，不让您使用子命令（如在接受的答案中）或自己验证所有内容（如在第二高投票的响应中）。

【参考方案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

祝你好运。

【讨论】：

我已经把它们放在一个参数组下。在这种情况下如何添加子命令？谢谢！

更新了示例代码。您不会使用组，而是使用子解析器。

但是你会怎么做 OP 最初问的？我目前有一组子命令，但其中一个子命令确实需要能够在 [[-a <val>] | [-b <val1> -c <val2>]]

之间进行选择

这不能回答问题，因为它不允许您发出“noname”命令并实现 OP 要求的 [-a xxx | [-b yyy -c zzz]]

【参考方案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 实例可以使用可选参数query 和fields 调用方法aggregate 或方法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)

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

【讨论】：

对于这种情况，我不会将其称为“黑客”，因为它看起来更易读且易于管理 - 感谢您指出！

更好的方法是使用parser.error("-a and -q ...")。这样会自动打印出完整的使用帮助。

请注意，在这种情况下，您还需要验证以下情况：（1）q 和 f 都需要在第一组是用户，（2）任何一个组是必须的。这使得“简单”的解决方案不再那么简单。所以我同意这是对手工脚本的更多破解，但不是真正的解决方案

如果您至少需要这两个选项之一，您可以将其设为独占或将 if 语句更改为 if bool(args.aggregation) is bool(args.query or args.fields):

【参考方案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 问题：bugs.python.org/issue11588 正在探索让您编写自定义独占/包含测试的方法。

没有积极的努力将这样的功能添加到argparse。进行自己的解析后测试。

【参考方案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

现在我们拥有-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。