argparse subparser monolithic help output

by

This is a bit tricky, as argparse does not expose a list of defined sub-parsers directly. But it can be done:

import argparse

# create the top-level parser
parser = argparse.ArgumentParser(prog='PROG')
parser.add_argument('--foo', action='store_true', help='foo help')
subparsers = parser.add_subparsers(help='sub-command help')

# create the parser for the "a" command
parser_a = subparsers.add_parser('a', help='a help')
parser_a.add_argument('bar', type=int, help='bar help')

# create the parser for the "b" command
parser_b = subparsers.add_parser('b', help='b help')
parser_b.add_argument('--baz', choices="XYZ", help='baz help')
# print main help
print(parser.format_help())

# retrieve subparsers from parser
subparsers_actions = [
    action for action in parser._actions 
    if isinstance(action, argparse._SubParsersAction)]
# there will probably only be one subparser_action,
# but better safe than sorry
for subparsers_action in subparsers_actions:
    # get all subparsers and print help
    for choice, subparser in subparsers_action.choices.items():
        print("Subparser '{}'".format(choice))
        print(subparser.format_help())

This example should work for python 2.7 and python 3. The example parser is from Python 2.7 documentation on argparse sub-commands.

The only thing left to do is adding a new argument for the complete help, or replacing the built in -h/--help.

More Related Contents:

  1. Parsing boolean values with argparse
  2. How can I pass a list as a command-line argument with argparse?
  3. Simple argparse example wanted: 1 argument, 3 results
  4. Python argparse mutual exclusive group
  5. Can’t get argparse to read quoted string with dashes in it?
  6. Argparse optional positional arguments?
  7. How to insert newlines on argparse help text?
  8. Python argparse – Add argument to multiple subparsers
  9. Argparse: Required argument ‘y’ if ‘x’ is present
  10. How do you write tests for the argparse portion of a python module?
  11. Python argparse ignore unrecognised arguments
  12. Python Argparse conditionally required arguments
  13. Argparse with required subparser
  14. How to parse multiple nested sub-commands using python argparse?
  15. Display help message with Python argparse when script is called without any arguments
  16. How to open file using argparse?
  17. Argparse – do not catch positional arguments with `nargs`.
  18. Setting options from environment variables when using argparse
  19. Accepting a dictionary as an argument with argparse and python [duplicate]
  20. Conditional command line arguments in Python using argparse
  21. argparse – disable same argument occurrences
  22. Python argparse command line flags without arguments
  23. Customize argparse help message
  24. type=dict in argparse.add_argument()
  25. Python argparse: Is there a way to specify a range in nargs?
  26. argparse argument order
  27. argparse subcommands with nested namespaces
  28. How can I constrain a value parsed with argparse (for example, restrict an integer to positive values)?
  29. Call function based on argparse
  30. Using the same option multiple times in Python’s argparse

Leave a Comment