Class CompletionError

cmd2/exceptions.py:27–45

Raised during completion operations to report any sort of error you want printed. Example use cases: - Reading a database to retrieve a completion data set failed - A previous command line argument that determines the data set being completed is invalid

class CompletionError(Exception):
    """Raised during completion operations to report any sort of error you want printed.

    Example use cases:

    - Reading a database to retrieve a completion data set failed
    - A previous command line argument that determines the data set being completed is invalid
    """

    def __init__(self, *args: Any, apply_style: bool = True) -> None:
        """Initialize CompletionError instance.

        :param apply_style: If True, then styles.ERROR will be applied to the message text when printed.
                            Set to False in cases where the message text already has the desired style.
                            Defaults to True.
        """
        self.apply_style = apply_style

        super().__init__(*args)


class PassThroughException(Exception):  # noqa: N818