子命令中选项的 argparse 冲突解决程序将关键字参数转换为位置参数

Posted 2023-03-25

【中文标题】子命令中选项的 argparse 冲突解决程序将关键字参数转换为位置参数

【英文标题】：argparse conflict resolver for options in subcommands turns keyword argument into positional argument

【发布时间】：2014-11-07 05:52:08

【问题描述】：

我有一个 Python 脚本，它运行两个接受相同选项的子命令，--config。我想创建第三个子命令，它可以按顺序一起运行前两个子命令。

使用 argparse，我为每个子命令创建了一个子解析器，以及第三个子解析器，其父级是两个子命令。澄清一下：

subcommand1 = subparsers.add_parser('subcommand1')
subcommand1.add_argument('--config', help="The config")

subcommand2 = subparsers.add_parser('subcommand2')
subcommand2.add_argument('--config', help="The config")

wrappercommand = subparsers.add_parser('wrappercommand', 
                                       parents=[subcommand1, subcommand2], 
                                       conflict_handler='resolve')

当我运行 wrappercommand 或 subcommand2 时，一切正常。但是，subcommand1 中断，输出如下：

$ run_command.py subcommand1 --config path_to_config.ini

usage: run_command.py subcommand1 config 

optional arguments:
  help                  show this help message and exit
  config                The config

看起来 argparse 已将关键字 arg（“--config”）转换为位置关键字（“config”）。这是 argparse 解决冲突选项时的预期行为吗？

【问题讨论】：

你能发布完整的解析代码吗？参数是否应该是helper？

打错字了 - 应该是 'help="The config"'。

【参考方案1】：

我认为您将这个冲突处理程序推向了无意和未经测试的领域。通常parents 是不被使用的独立解析器。它们只是Actions 的来源。与-h 相关的冲突由add_help=False 处理。

作为背景：使用默认的conflict_handler（错误），您在创建wrappercommand 子解析器时会收到错误消息：

argparse.ArgumentError: argument -h/--help: conflicting option string(s): -h, --help

在添加一些add_help=False 之后，你仍然会得到：

argparse.ArgumentError: argument --config: conflicting option string(s): --config

resolve 冲突处理程序将错误消息替换为某种“解决方案”。下面的脚本演示了正在发生的事情。

resolve 处理程序删除了 option_strings 的 subcommand1 操作，同时保留操作。实际上，它把两者都变成了位置。因为help 有nargs=0，所以它总是运行。因此，帮助显示。

_handle_conflict_resolve 的目的是删除第一个参数的证据，因此可以添加新参数。当冲突是由两个具有相同选项字符串的add_argument 命令产生时，这可以正常工作。但是这里的冲突是由两个父母的“复制”行为产生的。但是父操作是通过引用复制的，因此“子”的更改最终会影响“父”。

一些可能的解决方案：

直接将参数添加到wrappercommand。这个parents 机制只是将来自父母的参数添加到孩子。它不会按顺序“运行”父母。

编写自己的_handle_conflict_... 函数以正确解决冲突。

删除冲突，这样您就可以使用parents 而无需使用resolve 处理程序。

---

我已针对此示例提交了错误报告 http://bugs.python.org/issue22401：

parent1 = argparse.ArgumentParser(add_help=False)
parent1.add_argument('--config')
parent2 = argparse.ArgumentParser(add_help=False)
parent2.add_argument('--config')

parser = argparse.ArgumentParser(parents=[parent1,parent2],
    conflict_handler='resolve')

def foo(parser):
    print [(id(a), a.dest, a.option_strings) for a in parser._actions]

foo(parent1)
foo(parent2)
foo(parser)

产生：

[(3077384012L, 'config', [])]
[(3076863628L, 'config', ['--config'])]
[(3076864428L, 'help', ['-h', '--help']), (3076863628L, 'config', ['--config'])]

注意parent1 缺少的option_strings，以及其他两个匹配的id。parent1 不能再次用作父级或解析器。

---

argparse - Combining parent parser, subparsers and default values 另一种情况是，通过引用复制父级的操作会产生复杂性（在更改默认值时）。

【讨论】：

谢谢，您的回答在所有方面都是正确的。我将不使用parents 机制将选项直接添加到子解析器中。