Added ability to place the command name in a disabled command message. This is useful when disabling an entire category of commands.

Author: kmvanbrunt

cmd2/cmd2.py

@@ -134,6 +134,9 @@ def __subclasshook__(cls, C):
 ALPHABETICAL_SORT_KEY = utils.norm_fold
 NATURAL_SORT_KEY = utils.natural_keys
 
+# Used as the command name placeholder in disabled command messages.
+COMMAND_NAME = "<COMMAND_NAME>"
+
 
 def categorize(func: Union[Callable, Iterable], category: str) -> None:
     """Categorize a function.
@@ -3681,7 +3684,8 @@ def disable_command(self, command: str, message_to_print: str) -> None:
                                                           help_function=getattr(self, help_func_name, None))
 
         # Overwrite the command and help functions to print the message
-        new_func = functools.partial(self._report_disabled_command_usage, message_to_print=message_to_print)
+        new_func = functools.partial(self._report_disabled_command_usage,
+                                     message_to_print=message_to_print.replace(COMMAND_NAME, command))
         setattr(self, self.cmd_func_name(command), new_func)
         setattr(self, help_func_name, new_func)
 

tests/test_cmd2.py

@@ -2280,3 +2280,11 @@ def test_disabled_command_not_in_history(disable_commands_app):
     saved_len = len(disable_commands_app.history)
     run_cmd(disable_commands_app, 'has_help_func')
     assert saved_len == len(disable_commands_app.history)
+
+def test_disabled_message_command_name(disable_commands_app, capsys):
+    message_to_print = '{} is currently disabled'.format(cmd2.cmd2.COMMAND_NAME)
+    disable_commands_app.disable_command('has_help_func', message_to_print)
+
+    run_cmd(disable_commands_app, 'has_help_func')
+    out, err = capsys.readouterr()
+    assert err.startswith('has_help_func is currently disabled')