Python Argparse - How can I add text to the default help message?

Question

I'm using python's argparse to handle parsing of arguments. I get a default help message structured like so:

usage: ProgramName [-h] ...

Description

positional arguments:
  ...

optional arguments:
  -h, --help            show this help message and exit
  ...

What I want is to add an entire new section to this message, for example:

usage: ProgramName [-h] ...

Description

positional arguments:
  ...

optional arguments:
  -h, --help            show this help message and exit
  ...

additional information:
  This will show additional information relevant to the user.
  ....

Is there a way to achieve this behavior? A solution that is supported by both python 2.7 and 3.x is preferred.

Edit: I would also rather have a solution that will add the new section / sections at the bottom of the help message.

Jundiaius · Accepted Answer · 2018-04-25 12:17:53Z

73

You can quite do it using epilog. Here is an example below:

import argparse
import textwrap
parser = argparse.ArgumentParser(
      prog='ProgramName',
      formatter_class=argparse.RawDescriptionHelpFormatter,
      epilog=textwrap.dedent('''\
         additional information:
             I have indented it
             exactly the way
             I want it
         '''))
parser.add_argument('--foo', nargs='?', help='foo help')
parser.add_argument('bar', nargs='+', help='bar help')
parser.print_help()

Result :

usage: ProgramName [-h] [--foo [FOO]] bar [bar ...]

positional arguments:
  bar          bar help

optional arguments:
  -h, --help   show this help message and exit
  --foo [FOO]  foo help

additional information:
    I have indented it
    exactly the way
    I want it

edited Apr 25, 2018 at 12:17

Jundiaius

7,9985 gold badges39 silver badges49 bronze badges

answered Apr 25, 2018 at 11:58

dbaxime

8466 silver badges3 bronze badges

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

Comments

Daniel · Accepted Answer · 2018-04-25 11:48:52Z

32

There are multiple ways in which you can add a description to your command. The recommended way is to add a module documentation at the top of your source code file as in:

""" This is the description, it will be accessible within the variable
    __doc__
"""

And then:

parser = argparse.ArgumentParser(description=__doc__)

To add text below the parameter description, use epilog, as shown in the following example taken from the documentation:

>>> parser = argparse.ArgumentParser(description='A foo that bars',  
                                     epilog="And that's how you'd foo a bar")
>>> parser.print_help() 

usage: argparse.py [-h]

A foo that bars

optional arguments:  -h, --help  show this help message and exit

And that's how you'd foo a bar

Refer to the documentation (linked above) for more information.

edited Apr 25, 2018 at 11:48

answered Apr 25, 2018 at 11:38

Daniel

12.2k9 gold badges48 silver badges75 bronze badges

4 Comments

Yoavhayun Over a year ago

Is there a way to insert it without using the description? I'm actually trying to add it at the bottom of the help message.

Daniel Over a year ago

Yes, if you open the documentation you'll see the "epilog" option right below the "description".

12431234123412341234123 Over a year ago

Doesn't work well. All formating (newlines and spaces) are ignored.

Daniel Over a year ago

That's a different issue. See stackoverflow.com/questions/3853722/…

Collectives™ on Stack Overflow

Python Argparse - How can I add text to the default help message?

2 Answers 2

Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related