Method disable_category

cmd2/cmd2.py:5700–5720

Disable an entire category of commands. :param category: the category to disable :param message_to_print: what to print when anything in this category is run or help is called on it while disabled. The variable cmd2.COMMAND_NAME can be used as a plac

(self, category: str, message_to_print: str)

        setattr(self, completer_func_name, new_completer_func)

    def disable_category(self, category: str, message_to_print: str) -> None:
        """Disable an entire category of commands.

        :param category: the category to disable
        :param message_to_print: what to print when anything in this category is run or help is called on it
                                 while disabled. The variable cmd2.COMMAND_NAME can be used as a placeholder for the name
                                 of the command being disabled.
                                 ex: message_to_print = f"{cmd2.COMMAND_NAME} is currently disabled"
        """
        # If the category is already disabled, then return
        if category in self.disabled_categories:
            return

        all_commands = self.get_all_commands()

        for command in all_commands:
            command_func = cast(BoundCommandFunc, self.get_command_func(command))
            if self._get_command_category(command_func) == category:
                self.disable_command(command, message_to_print)

        self.disabled_categories[category] = message_to_print

    def _report_disabled_command_usage(self, *_args: Any, message_to_print: str, **_kwargs: Any) -> None:
        """Report when a disabled command or its help function is run.