Getting argparse documentation as string

Question

I am using argparse to create an ipython magic. The library is nicely printing some documentation when calling parser.print_doc(). However, is there a way to get the documentation as a string instead, so that I can attach it to __doc__ of my ipython cell?

Here is an example of what I want to do:

@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())
        […]

Alasdair · Accepted Answer · 2016-05-18 08:59:03Z

1

I think you're looking for the format_help() method.

answered May 18, 2016 at 8:59

Alasdair

310k59 gold badges605 silver badges534 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Getting argparse documentation as string

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related