Method _cmd

cmd2/command_set.py:45–60

Property for child classes to access self._cmd_internal. Using this property ensures that the CommandSet has been registered and tells type checkers that self._cmd_internal is not None. Subclasses can specify their specific Cmd type during inheritance: class My

(self)

    @property
    def _cmd(self) -> CmdT:
        """Property for child classes to access self._cmd_internal.

        Using this property ensures that the CommandSet has been registered
        and tells type checkers that self._cmd_internal is not None.

        Subclasses can specify their specific Cmd type during inheritance:

            class MyCommandSet(CommandSet[MyCustomApp]):
                ...

        :raises CommandSetRegistrationError: if CommandSet is not registered.
        """
        if self._cmd_internal is None:
            raise CommandSetRegistrationError("This CommandSet is not registered")
        return self._cmd_internal

    def on_register(self, cmd: CmdT) -> None:
        """First step to registering a CommandSet, called by cmd2.Cmd.