Method get

cmd2/cmd2.py:266–297

Return a given method's parser or None if the method is not argparse-based. If the parser does not yet exist, it will be created.

(self, command_method: BoundCommandFunc)

        return bool(parser)

    def get(self, command_method: BoundCommandFunc) -> Cmd2ArgumentParser | None:
        """Return a given method's parser or None if the method is not argparse-based.

        If the parser does not yet exist, it will be created.
        """
        full_method_name = self._fully_qualified_name(command_method)
        if not full_method_name:
            return None

        if full_method_name not in self._parsers:
            if not command_method.__name__.startswith(COMMAND_FUNC_PREFIX):
                return None
            command = command_method.__name__[len(COMMAND_FUNC_PREFIX) :]

            parser_builder = getattr(command_method, constants.CMD_ATTR_ARGPARSER, None)
            if parser_builder is None:
                return None

            parent = self._cmd.find_commandset_for_command(command) or self._cmd
            parser = self._cmd._build_parser(parent, parser_builder)

            # To ensure accurate usage strings, recursively update 'prog' values
            # within the parser to match the command name.
            parser.update_prog(command)

            # If the description has not been set, then use the method docstring if one exists
            if parser.description is None and command_method.__doc__:
                parser.description = strip_doc_annotations(command_method.__doc__)

            self._parsers[full_method_name] = parser

        return self._parsers.get(full_method_name)

    def remove(self, command_method: BoundCommandFunc) -> None:
        """Remove a given method's parser if it exists."""