Function _SubParsersAction_remove_parser

cmd2/argparse_utils.py:510–546

Remove a subparser from a subparsers group. This function is added by cmd2 as a method called ``remove_parser()`` to ``argparse._SubParsersAction`` class. To call: ``action.remove_parser(name)`` :param self: instance of the _SubParsersAction being edited :param name: name of t

(  # noqa: N802
    self: argparse._SubParsersAction,  # type: ignore[type-arg]
    name: str,
)

def _SubParsersAction_remove_parser(  # noqa: N802
    self: argparse._SubParsersAction,  # type: ignore[type-arg]
    name: str,
) -> argparse.ArgumentParser:
    """Remove a subparser from a subparsers group.

    This function is added by cmd2 as a method called ``remove_parser()``
    to ``argparse._SubParsersAction`` class.

    To call: ``action.remove_parser(name)``

    :param self: instance of the _SubParsersAction being edited
    :param name: name of the subcommand for the subparser to remove
    :return: the removed parser
    :raises ValueError: if the subcommand doesn't exist
    """
    if name not in self._name_parser_map:
        raise ValueError(f"Subcommand '{name}' does not exist")

    subparser = self._name_parser_map[name]

    # Find all names (primary and aliases) that map to this subparser
    all_names = [cur_name for cur_name, cur_parser in self._name_parser_map.items() if cur_parser is subparser]

    # Remove the help entry for this subparser. To handle the case where
    # name is an alias, we remove the action whose 'dest' matches any of
    # the names mapped to this subparser.
    for choice_action in self._choices_actions:
        if choice_action.dest in all_names:
            self._choices_actions.remove(choice_action)
            break

    # Remove all references to this subparser, including aliases.
    for cur_name in all_names:
        del self._name_parser_map[cur_name]

    return cast(argparse.ArgumentParser, subparser)


argparse._SubParsersAction.remove_parser = _SubParsersAction_remove_parser  # type: ignore[attr-defined]