如何从父解析器获取 argparse 子解析器（检查默认值）

Question

假设我创建了一个带有参数默认值的解析器，然后给它一个带有参数默认值的子解析器。

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从上面创建并返回父解析器，但不能直接访问子解析器。

我怎样才能打印出子解析器参数的默认值？或者分别获取每个子解析器的句柄？

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

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

似乎没有从任何更多的属性或方法，parser._subparsers或parser可能显示的默认值。

总体问题是：当您只有父解析器的句柄时，如何以编程方式访问子解析器默认值？

Answer 1

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

a = parser.add_argument(...)

add_argument创建一个Action对象（或实际上是一个取决于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.defaultAction的属性。

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

我没怎么用过这个parser._subparsers属性。查看parser.add_subparsers方法我发现它实际上是一个argument_group. Argument_groups 主要是一种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>

本_defaults的_subparsers实际上是相同的字典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类。