如何从父解析器获取argparse子解析器(以检查默认值)

时间:2017-04-28 20:32:13

标签: python parsing arguments argparse subparsers

假设我创建了一个带有参数默认值的解析器,然后给它一个subparser,其中包含一个参数的默认值。

In [1]: parser = argparse.ArgumentParser(description='test')

In [2]: parser.add_argument("--test", dest="test", default="hello")
Out[2]: _StoreAction(option_strings=['--test'], dest='test', nargs=None, const=None, default='hello', type=None, choices=None, help=None, metavar=None)

In [3]: parser.get_default("test")
Out[3]: 'hello'

In [4]: subparsers = parser.add_subparsers(dest="command")

In [5]: parser_other = subparsers.add_parser("other")

In [6]: parser_other.add_argument("--other-test", dest="other_test", default="world")
Out[6]: _StoreAction(option_strings=['--other-test'], dest='other_test', nargs=None, const=None, default='world', type=None, choices=None, help=None, metavar=None)

In [7]: parser_other.get_default("other_test")
Out[7]: 'world'

这一切都很好。但是假设我有一个函数可以从上面创建并返回父解析器parser,但没有直接访问subparser。

如何打印subparser参数的默认值?或者分别处理每个subparser?

In [8]: parser._subparsers._defaults
Out[8]: {}

In [9]: parser._subparsers.get_default("other_test")  # is None

parser._subparsersparser似乎没有任何可能显示默认值的属性或方法。

整体问题是:当你只有父解析器的句柄时,如何以编程方式访问subparser默认值?

2 个答案:

答案 0 :(得分:3)

你做对了。但也许我可以解释一些细节。

a = parser.add_argument(...)

add_argument创建一个Action对象(实际上是一个子类,具体取决于action参数)。您可以在自己的环境中保存指向该对象的指针。但该行动也在parse._actions列表中收集。那就是parser如何跟踪其论点。

阅读_actions应该始终是安全的。修改它可能会破坏解析器。 argument_groups可以访问该列表。

subparsers = parser.add_subparsers(dest="command")

add_argument的专用版本,用于创建和返回argparse._SubParsersAction个对象。 subparsers就是那个对象。如前面的答案所述,您可以通过搜索正确的子类在_actions列表中找到它。 (对于主解析器,subparsers只是另一个位置参数。)

subparsers维护自己的parsers专用字典,可以作为choices属性访问。主解析器没有这些子解析器的任何记录。

parser_other = subparsers.add_parser("other")

创建一个解析器,将其放在choices映射中,并返回一个供您自己使用的引用(使用add_argument等)。每个子解析器都有自己的_actions列表。 (和它自己的_defaults)。

查看get_defaults方法的代码:

def get_default(self, dest):
    for action in self._actions:
        if action.dest == dest and action.default is not None:
            return action.default
    return self._defaults.get(dest, None)

它使用_actions属性。并查看Action的action.default属性。

self._defaults是由parser.set_defaults方法更新的字典。该方法还将其参数复制到相关的Action对象。如果get_defaults是与特定操作无关的默认值之一,dest会检查parser._subparsershttps://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.set_defaults

我还没有使用parser.add_subparsers属性。查看argument_group方法,我发现它实际上是help。 Argument_groups主要是In [22]: parser = argparse.ArgumentParser() In [23]: sp = parser.add_subparsers(title='subparsers', dest='cmd') In [24]: sp1 = sp.add_parser('cmd1') In [25]: sp2 = sp.add_parser('cmd2') In [26]: parser.print_help() usage: ipython3 [-h] {cmd1,cmd2} ... optional arguments: -h, --help show this help message and exit subparsers: {cmd1,cmd2} In [28]: [a.dest for a in parser._actions] Out[28]: ['help', 'cmd'] In [29]: parser._action_groups Out[29]: [<argparse._ArgumentGroup at 0xaf86bf2c>, <argparse._ArgumentGroup at 0xaf86bdcc>, <argparse._ArgumentGroup at 0xac99fa6c>] In [30]: [g.title for g in parser._action_groups] Out[30]: ['positional arguments', 'optional arguments', 'subparsers'] In [31]: parser._subparsers Out[31]: <argparse._ArgumentGroup at 0xac99fa6c> 工具,用于对帮助热线进行分组。解析器对象与其argument_groups之间的关系有点棘手,可能不是您想要使用的东西。

这是一个例子,有更多(太多)细节:

_defaults

_subparsers的{​​{1}}实际上是与parser._defaults相同的字典

In [32]: parser.set_defaults(extra='foobar')
In [33]: parser._defaults
Out[33]: {'extra': 'foobar'}
In [34]: parser._subparsers._defaults
Out[34]: {'extra': 'foobar'}

parser._subparsers._actions也与parser._actions相同。但该组确实维护了自己的列表操作(在帮助显示中使用)。

In [35]: parser._subparsers._group_actions
Out[35]: [_SubParsersAction(option_strings=[], dest='cmd', nargs='A...', const=None, 
    default=None, type=None, choices=OrderedDict([...]), help=None, metavar=None)]

因此,您可以使用parser._subparsers._group_actions[0]查找subparsers操作对象,而不是搜索parsers._actions列表。

In [37]: parser._subparsers._group_actions[0].choices
Out[37]: 
OrderedDict([('cmd1',
              ArgumentParser(prog='ipython3 cmd1', usage=None, description=None,...)),
             ('cmd2',
              ArgumentParser(prog='ipython3 cmd2', usage=None, description=None,...))])

第二个想法,parser._subparsers._group_actions可能没那么有用。如果你没有给它一个特殊的标题,那么它与所有位置参数的参数组parser._positionals相同。因此,您仍然需要验证_SubParsersAction类。

答案 1 :(得分:1)

基于this answer,看起来可以按如下方式完成:

subparsers = [
    subparser 
    for action in parser._actions 
    if isinstance(action, argparse._SubParsersAction) 
    for _, subparser in action.choices.items()
]

然后

subparsers[0].get_default("other_test")

按预期打印"world"