argparse (python) 是否支持互斥的参数组？

Question

如果我有参数 '-a', '-b', '-c', '-d' 以及 add_mutually_exclusive_group() 函数，我的程序将必须只使用其中之一。有没有办法将其结合起来，以便程序只接受 '-a 999 -b 999' 或 '-c 999 -d 999' ？

编辑：添加一个简单的程序以提高清晰度：

>>> parser = argparse.ArgumentParser()
>>> group = parser.add_mutually_exclusive_group()
>>> group.add_argument('-a')
>>> group.add_argument('-b')
>>> group.add_argument('-c')
>>> group.add_argument('-d')

然后仅 ./app.py -a | ./app.py -b | ./app.py -c |可以调用./app.py -d。是否可以将 argparse 分组为排除组，以便只有 ./app.py -a .. -b .. | ./app.py -c .. -d .. 被调用吗？

Answer 1

子解析器？

与unhammer的答案类似，但具有更多的用户控制权。注意：我还没有实际测试过这个方法，但它在理论上应该可以工作并且具有 python 的功能。

您可以创建两个解析器，每个解析器对应两个组，并使用条件来执行互斥部分。本质上仅使用 argparse 进行部分参数解析。使用这种方法，您也可以超越 unhammer 答案的限制。

# Python 3
import argparse

try:
    parser = argparse.ArgumentParser()
    parser.add_argument('-a')
    parser.add_argument('-b')
    args = parser.parse_args
except argparse.ArgumentError:
    parser = argparse.ArgumentParser()
    parser.add_argument('-c')
    parser.add_argument('-d')
    args = parser.parse_args

Answer 2

编辑：没关系。因为 argparse 做出了一个可怕的选择，即在调用 group.add_argument 时必须创建一个选项。那不会是我的设计选择。如果您非常需要此功能，可以尝试使用 ConflictsOptionParser 来实现：

# exclusivegroups.py
import conflictsparse

parser = conflictsparse.ConflictsOptionParser()
a_opt = parser.add_option('-a')
b_opt = parser.add_option('-b')
c_opt = parser.add_option('-c')
d_opt = parser.add_option('-d')

import itertools
compatible_opts1 = (a_opt, b_opt)
compatible_opts2 = (c_opt, d_opt)
exclusives = itertools.product(compatible_opts1, compatible_opts2)
for exclusive_grp in exclusives:
    parser.register_conflict(exclusive_grp)


opts, args = parser.parse_args()
print "opts: ", opts
print "args: ", args

因此，当我们调用它，我们可以看到我们得到了想要的效果。

$ python exclusivegroups.py -a 1 -b 2
opts:  {'a': '1', 'c': None, 'b': '2', 'd': None}
args:  []
$ python exclusivegroups.py -c 3 -d 2
opts:  {'a': None, 'c': '3', 'b': None, 'd': '2'}
args:  []
$ python exclusivegroups.py -a 1 -b 2 -c 3
Usage: exclusivegroups.py [options]

exclusivegroups.py: error: -b, -c are incompatible options.

警告消息不会告知您 '-a' 和 '-b' 与 '-c' 不兼容，但是可以制作更合适的错误消息。下面是较旧的错误答案。

旧编辑： [此编辑是错误的，但如果 argparse 以此方式工作，这不是一个完美的世界吗？] 我之前的回答实际上是不正确的，您应该能够通过为每个互斥选项指定一组来使用 argparse 来完成此操作。我们甚至可以使用 itertools 来概括该过程。这样我们就不必显式地输入所有组合：

import itertools
compatible_opts1 = ('-a', '-b')
compatible_opts2 = ('-c', '-d')
exclusives = itertools.product(compatible_opts1, compatible_opts2)
for exclusive_grp in exclusives:
    group = parser.add_mutually_exclusive_group()
    group.add_argument(exclusive_grp[0])
    group.add_argument(exclusive_grp[1])

Answer 3

@hpaulj 评论中引用的 argparse 增强请求在九年多后仍然开放，因此我认为其他人可能会从我刚刚发现的解决方法中受益。根据增强请求中的此评论，我发现我能够向两个添加一个选项使用此语法的不同互斥组：

#!/usr/bin/env python                                                                                                                                                                     
import argparse
import os
import sys

def parse_args():
    parser = argparse.ArgumentParser(
        formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )

    parser.add_argument("-d", "--device", help="Path to UART device", default="./ttyS0")

    mutex_group1 = parser.add_mutually_exclusive_group()
    mutex_group2 = parser.add_mutually_exclusive_group()

    mutex_group1.add_argument(
        "-o",
        "--output-file",
        help="Name of output CSV file",
        default="sensor_data_sent.csv",
    )

    input_file_action = mutex_group1.add_argument(
        "-i", "--input-file", type=argparse.FileType("r"), help="Name of input CSV file"
    )

    # See: https://bugs.python.org/issue10984#msg219660
    mutex_group2._group_actions.append(input_file_action)

    mutex_group2.add_argument(
        "-t",
        "--time",
        type=int,
        help="How long to run, in seconds (-1 = loop forever)",
        default=-1,
    )

    # Add missing ']' to usage message
    usage = parser.format_usage()
    usage = usage.replace('usage: ', '')
    usage = usage.replace(']\n', ']]\n')
    parser.usage = usage

    return parser.parse_args()


if __name__ == "__main__":
    args = parse_args()
    print("Args parsed successfully...")
    sys.exit(0)

这对于我的目的来说已经足够好了：

$ ./fake_sensor.py -i input.csv -o output.csv                                                                                                                                             
usage: fake_sensor.py [-h] [-d DEVICE] [-o OUTPUT_FILE | [-i INPUT_FILE | -t TIME]]
fake_sensor.py: error: argument -o/--output-file: not allowed with argument -i/--input-file

$ ./fake_sensor.py -i input.csv -t 30         
usage: fake_sensor.py [-h] [-d DEVICE] [-o OUTPUT_FILE | [-i INPUT_FILE | -t TIME]]
fake_sensor.py: error: argument -t/--time: not allowed with argument -i/--input-file

$ ./fake_sensor.py -i input.csv
Args parsed successfully...

$ ./fake_sensor.py -o output.csv
Args parsed successfully...

$ ./fake_sensor.py -o output.csv -t 30
Args parsed successfully...

当然，访问 argparse 的私有成员相当脆弱，所以我可能不会在生产代码中使用这种方法。另外，精明的读者可能会注意到使用消息具有误导性，因为它意味着 -o 和 -i 可以一起使用，但它们不能一起使用（！）但是，我我仅使用此脚本进行测试，因此我并不过分担心。 （我认为，“真正”修复使用消息将需要更多的时间来完成这项任务，但如果您知道对此的巧妙技巧，请发表评论。）

Answer 4

我自己偶然发现了这个问题。从我对 argparse 文档的阅读来看，似乎没有一种简单的方法可以在 argparse 中实现这一目标。我考虑过使用 parse_known_args，但这很快就相当于编写 argparse 的专用版本；-)

也许需要一份错误报告。同时，如果你愿意让你的用户做一点额外的输入，你可以用子组来伪造它（比如 git 和 svn 的参数如何工作），例如，

    subparsers = parser.add_subparsers()
    p_ab = subparsers.add_parser('ab')
    p_ab.add_argument(...)

    p_cd = subparsers.add_parser('cd')
    p_cd.add_argument(...)

不理想，但至少它给你带来了 argparse 的好处没有太多丑陋的黑客行为。我最终取消了开关，只使用带有所需子参数的子解析器操作。