FullHelpAction Class Reference

Inheritance diagram for FullHelpAction:

Public Member Functions
	print_subparsers (self, parser, prefix="")
	__call__ (self, parser, namespace, values, option_string=None)

Detailed Description

Class to recursively show help for an ArgumentParser and all it's sub_parsers

Definition at line 974 of file cli_main.py.

Member Function Documentation

__call__()

__call__	(		self,
			parser,
			namespace,
			values,
			option_string = None )

Show full help message

Definition at line 994 of file cli_main.py.

    def __call__(self, parser, namespace, values, option_string=None):
        """Show full help message"""
        # run in pager because amount of options will be looong
        with Pager(f"{parser.prog} {option_string}"):
            parser.print_help()
            self.print_subparsers(parser)
            parser.exit()
 
 

print_subparsers()

print_subparsers	(		self,
			parser,
			prefix = "" )

Print help message for given parser and call again for all sub parsers

Definition at line 977 of file cli_main.py.

    def print_subparsers(self, parser, prefix=""):
        """Print help message for given parser and call again for all sub parsers"""
        # 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 save than sorry
        for subparsers_action in subparsers_actions:
            # get all subparsers and print help
            for choice, subparser in subparsers_action.choices.items():
                print()
                print(f"Command '{prefix}{choice}'")
                print(subparser.format_help())
 
                self.print_subparsers(subparser, prefix=f"{prefix}{choice} ")
 

---

The documentation for this class was generated from the following file:

• framework/scripts/conditions_db/cli_main.py