使用 Python/argparse 创建可组合/分层的命令行解析器

Question

（问题的简化形式。）我正在编写一个涉及一些 Python 组件的 API。这些可能是函数，但为了具体起见，我们假设它们是对象。我希望能够从命令行解析各种组件的选项。

from argparse import ArgumentParser

class Foo(object):
    def __init__(self, foo_options):
        """do stuff with options"""

    """..."""

class Bar(object):
    def __init__(sef, bar_options):
        """..."""

def foo_parser():
    """(could also be a Foo method)"""
    p = ArgumentParser()
    p.add_argument('--option1')
    #...
    return p

def bar_parser(): "..."

但现在我希望能够构建更大的组件：

def larger_component(options):
    f1 = Foo(options.foo1)
    f2 = Foo(options.foo2)
    b  = Bar(options.bar)
    # ... do stuff with these pieces

美好的。但是如何编写合适的解析器呢？我们可能希望像这样：

def larger_parser(): # probably need to take some prefix/ns arguments
    # general options to be overridden by p1, p2
    # (this could be done automagically or by hand in `larger_component`):
    p  = foo_parser(prefix=None,          namespace='foo')
    p1 = foo_parser(prefix='first-foo-',  namespace='foo1')
    p2 = foo_parser(prefix='second-foo-', namespace='foo2')
    b  = bar_parser()
    # (you wouldn't actually specify the prefix/namespace twice: )
    return combine_parsers([(p1, namespace='foo1', prefix='first-foo-'),
                            (p2,...),p,b])

larger_component(larger_parser().parse_args())
# CLI should accept --foo1-option1, --foo2-option1, --option1  (*)

如果您忘记了我们想要前缀（以便能够添加多个相同类型的解析器）和可能的命名空间（以便我们可以构建树结构的命名空间以反映组件的结构），这看起来有点像argparse的parents功能）。

当然，我们希望更大的组件和更大的解析器以相同的方式组合，并且传递给某个组件的命名空间对象应该始终具有相同的内部形状/命名结构。

问题似乎是argparseAPI 基本上是关于改变你的解析器，但查询它们更困难 - 如果你直接将数据类型转换为解析器，你可以只遍历这些对象。如果用户编写一堆函数来手动向解析器添加参数，我设法破解了一些有点工作的东西，但是每个add_argument调用都必须带有一个前缀，整个事情变得非常难以理解并且可能无法组合。（您可以以复制内部数据结构的某些部分为代价对此进行抽象......）。我还尝试将parser和group对象子类化......

您可以想象这可能使用更代数的 CLI 解析 API 来实现，但我认为重写argparse不是一个好的解决方案。

有没有已知/直接的方法来做到这一点？

Answer 1

一些可以帮助您构建更大的解析器的想法：

parser = argparse.ArgumentParser(...)
arg1 = parser.add_argument('--foo',...)

Now是对创建的对象的arg1引用。我建议在交互式 shell 中执行此操作并查看其属性。或者至少打印它的. 您还可以尝试修改属性。解析器“了解”的关于参数的大部分内容都包含在这些. 从某种意义上说，解析器是一个“包含”一堆“动作”的对象。Actionadd_argumentrepractions

另请参阅：

parser._actions

这是解析器的主操作列表，其中包括默认帮助以及您添加的帮助。

该parents机制将引用Action从父级复制到子级。请注意，它不会复制 Action 对象。它还重新创建参数组 - 但这些组仅用于对帮助热线进行分组。它们与解析无关。

args1, extras = parser.parse_known_args(argv, namespace)

在处理多个解析器时非常有用。有了它，每个解析器都可以处理它所知道的参数，并将其余的传递给其他解析器。尝试了解该方法的输入和输出。

我们在之前的 SO 问题中讨论过复合Namespace对象。默认argparse.Namespace类是带有方法的简单对象类repr。解析器只使用hasattr,getattr和setattr，试图尽可能地不具体。您可以构造一个更复杂的命名空间类。

带有嵌套命名空间的 argparse 子命令

您还可以自定义Action课程。这是大多数值插入命名空间的地方（尽管默认值是在其他地方设置的）。

IPython使用argparse，既用于主调用，又用于内部magic命令。它从文件构造许多参数config。因此，可以使用默认配置、自定义配置或在最后一刻通过命令行参数设置许多值。