将 argparse 文档作为字符串获取

Question

我正在使用 argparse 创建一个 ipython 魔法。库在调用 parser.print_doc() 时很好地打印了一些文档。但是，有没有办法将文档作为字符串获取，以便我可以将其附加到 ipython 单元格的 __doc__？

这是我想做的一个例子：

@magics_class
class MagicClass(Magics):
    parser = argparse.ArgumentParser(description='Some description.')
    parser.add_argument('foo', nargs='*', help='Foo variables.')
    […]
    def __init__(self):
        # attach the doc from the parser to the __doc__ object of the
        # class
        self.__doc__.append(parser.get_help_as_string())
        […]

Answer 1

我认为您正在寻找 format_help() 方法。