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

时间:2014-09-13 00:20:41

标签: python argparse

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

使用argparse,我为每个子命令创建了一个subparser,以及第三个subparser,其父项是两个子命令。只是为了澄清:

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时,一切正常。但是,子命令1中断,将其作为输出:

$ 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解决冲突选项时的预期行为吗?

1 个答案:

答案 0 :(得分:3)

我认为你正在将这个冲突处理程序推入无意识和未经测试的领域。通常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,同时保留了操作。实际上,它变成了位置。由于helpnargs=0,因此它始终会运行。因此,帮助显示。

_handle_conflict_resolve的意图是删除第一个参数的证据,因此可以添加新参数。当两个带有相同选项字符串的add_argument命令产生冲突时,这很好。但在这里,冲突是由“复制”而产生的。 2个父母的行动。但是父母的行为是通过引用复制的,所以“孩子”的变化就会发生变化。最终会影响到父母'。

一些可能的解决方案:

  • 直接将参数添加到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'])]

请注意option_strings缺少parent1,其他2. id的匹配parent1不能再次用作父项或解析器。< / p>


argparse - Combining parent parser, subparsers and default values 另一种情况是,通过引用复制父母的行为会产生复杂情况(在更改默认值时)。