Method disable_command

cmd2/cmd2.py:5641–5698

Disable a command and replace its functions with disabled versions. :param command: the command being disabled :param message_to_print: what to print when this command is run or help is called on it while disabled The variable cmd2.COMMAND_NAME can

(self, command: str, message_to_print: str)

        del self.disabled_categories[category]

    def disable_command(self, command: str, message_to_print: str) -> None:
        """Disable a command and replace its functions with disabled versions.

        :param command: the command being disabled
        :param message_to_print: what to print when this command 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 command is already disabled, then return
        if command in self.disabled_commands:
            return

        # Make sure this is an actual command
        command_func = self.get_command_func(command)
        if command_func is None:
            raise AttributeError(f"'{command}' does not refer to a command")

        command_func_name = constants.COMMAND_FUNC_PREFIX + command

        help_func_name = constants.HELP_FUNC_PREFIX + command
        help_func = getattr(self, help_func_name, None)

        completer_func_name = constants.COMPLETER_FUNC_PREFIX + command
        completer_func = getattr(self, completer_func_name, None)

        # Add the disabled command record
        self.disabled_commands[command] = DisabledCommand(
            command_func=command_func,
            help_func=help_func,
            completer_func=completer_func,
        )

        # Replace command and help functions to report the disabled message
        message_to_print = message_to_print.replace(constants.COMMAND_NAME, command)
        new_cmd_func = functools.partial(
            self._report_disabled_command_usage,
            message_to_print=message_to_print,
        )

        # Ensure the replacement function identifies as the original for introspection
        functools.update_wrapper(new_cmd_func, command_func)
        setattr(self, command_func_name, new_cmd_func)

        new_help_func = functools.partial(
            self._report_disabled_command_usage,
            message_to_print=message_to_print,
        )
        if help_func is not None:
            functools.update_wrapper(new_help_func, help_func)
        setattr(self, help_func_name, new_help_func)

        # Replace completer with a function that returns nothing
        new_completer_func = functools.partial(self._disabled_completer)
        if completer_func is not None:
            functools.update_wrapper(new_completer_func, completer_func)
        setattr(self, completer_func_name, new_completer_func)