Method _macro_list

cmd2/cmd2.py:4173–4208

List macros.

(self, args: argparse.Namespace)

    @as_subcommand_to("macro", "list", _build_macro_list_parser, help="list macros")
    def _macro_list(self, args: argparse.Namespace) -> None:
        """List macros."""
        self.last_result = {}  # dict[macro_name, macro_value]

        tokens_to_quote = (*constants.REDIRECTION_TOKENS, *self.statement_parser.terminators)

        to_list = (
            utils.remove_duplicates(args.names)
            if args.names
            else sorted(
                self.macros,
                key=utils.DEFAULT_STR_SORT_KEY,
            )
        )

        not_found: list[str] = []
        for name in to_list:
            if name not in self.macros:
                not_found.append(name)
                continue

            # Quote redirection and terminator tokens for the 'macro create' command
            tokens = shlex_split(self.macros[name].value)
            command = tokens[0]
            command_args = tokens[1:]
            utils.quote_specific_tokens(command_args, tokens_to_quote)

            val = command
            if command_args:
                val += " " + " ".join(command_args)

            self.poutput(f"macro create {name} {val}")
            self.last_result[name] = val

        for name in not_found:
            self.perror(f"Macro '{name}' not found")

    def complete_help_command(self, text: str, line: str, begidx: int, endidx: int) -> Completions:
        """Completes the command argument of help."""