cmd2.exceptions

Bases: Exception

For when a command has a failed bad enough to skip post command hooks, but not bad enough to print to the user.

Bases: SkipPostcommandHooks

A SkipPostcommandHooks exception for when a command fails to parse its arguments.

Normally argparse raises a SystemExit exception in these cases. To avoid stopping the command loop, catch the SystemExit and raise this instead. If you still need to run post command hooks after parsing fails, just return instead of raising an exception.

Bases: Exception

For when an error occurs while a CommandSet is being added or removed from a cmd2 application.

Bases: 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

Initialize CompletionError instance.

36
37
38
39
40
41
42
43
44
45

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)

apply_style = apply_style

Bases: Exception

Normally all unhandled exceptions raised during commands get printed to the user.

This class is used to wrap an exception that should be raised instead of printed.

Initialize PassThroughException instance.

54
55
56
57
58
59
60

def __init__(self, *args: Any, wrapped_ex: BaseException) -> None:
    """Initialize PassThroughException instance.

    :param wrapped_ex: the exception that will be raised.
    """
    self.wrapped_ex = wrapped_ex
    super().__init__(*args)

wrapped_ex = wrapped_ex

Bases: Exception

Raised when shlex fails to parse a command line string in StatementParser.

Bases: SystemExit

Custom exception class for use with the py command.

Bases: Exception

Custom exception class for handling behavior when the user just presses .

Bases: Exception

Raised when more input is required to complete a multiline statement.

Bases: Exception

Raised when a macro fails to resolve (e.g., insufficient arguments).

Bases: Exception

Custom exception class for when redirecting or piping output fails.