将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()方法。