From c88de7dfcfed716e81d06775b6e7929e4e01428c Mon Sep 17 00:00:00 2001 From: Eric Lin Date: Sat, 13 Jun 2020 12:30:33 -0400 Subject: add ability to remove commands and commandsets Issue #943 --- cmd2/cmd2.py | 50 ++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 46 insertions(+), 4 deletions(-) (limited to 'cmd2/cmd2.py') diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index edf2a643..ef273d15 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -244,8 +244,8 @@ class Cmd(cmd.Cmd): shortcuts=shortcuts) # Load modular commands - self._installed_functions: List[str] = [] - self._installed_command_sets: List[CommandSet] = [] + self._installed_functions = [] # type: List[str] + self._installed_command_sets = [] # type: List[CommandSet] if command_sets: for command_set in command_sets: self.install_command_set(command_set) @@ -469,7 +469,34 @@ class Cmd(cmd.Cmd): delattr(self, attrib) raise - def install_command_function(self, cmd_name: str, cmd_func: Callable, cmd_completer: Callable, cmd_help: Callable): + def uninstall_command_set(self, cmdset: CommandSet): + """ + Uninstalls an CommandSet and unloads all associated commands + :param cmdset: CommandSet to uninstall + """ + if cmdset in self._installed_command_sets: + methods = inspect.getmembers( + cmdset, + predicate=lambda meth: inspect.ismethod(meth) and meth.__name__.startswith(COMMAND_FUNC_PREFIX)) + + for method in methods: + cmd_name = method[0][len(COMMAND_FUNC_PREFIX):] + + delattr(self, COMMAND_FUNC_PREFIX + cmd_name) + + if hasattr(self, COMPLETER_FUNC_PREFIX + cmd_name): + delattr(self, COMPLETER_FUNC_PREFIX + cmd_name) + if hasattr(self, HELP_FUNC_PREFIX + cmd_name): + delattr(self, HELP_FUNC_PREFIX + cmd_name) + + cmdset.on_unregister(self) + self._installed_command_sets.remove(cmdset) + + def install_command_function(self, + cmd_name: str, + cmd_func: Callable, + cmd_completer: Optional[Callable], + cmd_help: Optional[Callable]): """ Installs a command by passing in functions for the command, completion, and help @@ -483,7 +510,8 @@ class Cmd(cmd.Cmd): if not valid: raise ValueError("Invalid command name {!r}: {}".format(cmd_name, errmsg)) - assert getattr(self, COMMAND_FUNC_PREFIX + cmd_name, None) is None, 'Duplicate command function registered: ' + cmd_name + assert getattr(self, COMMAND_FUNC_PREFIX + cmd_name, None) is None,\ + 'Duplicate command function registered: ' + cmd_name setattr(self, COMMAND_FUNC_PREFIX + cmd_name, types.MethodType(cmd_func, self)) self._installed_functions.append(cmd_name) if cmd_completer is not None: @@ -495,6 +523,20 @@ class Cmd(cmd.Cmd): 'Duplicate command help registered: ' + HELP_FUNC_PREFIX + cmd_name setattr(self, HELP_FUNC_PREFIX + cmd_name, types.MethodType(cmd_help, self)) + def uninstall_command(self, cmd_name: str): + """ + Uninstall an installed command and any associated completer or help functions + :param cmd_name: Command to uninstall + """ + if cmd_name in self._installed_functions: + delattr(self, COMMAND_FUNC_PREFIX + cmd_name) + + if hasattr(self, COMPLETER_FUNC_PREFIX + cmd_name): + delattr(self, COMPLETER_FUNC_PREFIX + cmd_name) + if hasattr(self, HELP_FUNC_PREFIX + cmd_name): + delattr(self, HELP_FUNC_PREFIX + cmd_name) + self._installed_functions.remove(cmd_name) + def add_settable(self, settable: Settable) -> None: """ Convenience method to add a settable parameter to ``self.settables`` -- cgit v1.2.1