Class HelpApp

tests/test_cmd2.py:1307–1345

Class for testing custom help_* methods which override docstring help.

class HelpApp(cmd2.Cmd):
    """Class for testing custom help_* methods which override docstring help."""

    DEFAULT_CATEGORY = "My Default Category."
    MISC_HEADER = "Various topics found here."

    def __init__(self, *args, **kwargs) -> None:
        super().__init__(*args, **kwargs)
        self.doc_leader = "I now present you with a list of help topics."

    def do_squat(self, arg) -> None:
        """This docstring help will never be shown because the help_squat method overrides it."""

    def help_squat(self) -> None:
        self.stdout.write("This command does diddly squat...\n")

    def do_edit(self, arg) -> None:
        """This overrides the edit command and does nothing."""

    # This command has no help text
    def do_no_help(self, arg) -> None:
        pass

    def do_multiline_docstr(self, arg) -> None:
        """This documentation
        is multiple lines
        and there are no
        tabs
        """

    def help_physics(self):
        """A miscellaneous help topic."""
        self.poutput("Here is some help on physics.")

    parser_cmd_parser = cmd2.Cmd2ArgumentParser(description="This is the description.")

    @cmd2.with_argparser(parser_cmd_parser)
    def do_parser_cmd(self, args) -> None:
        """This is the docstring."""


@pytest.fixture