Class AsyncAlert

cmd2/cmd2.py:307–320

Contents of an asynchronous alert which display while user is at prompt. :param msg: an optional message to be printed above the prompt. :param prompt: an optional string to dynamically replace the current prompt. :ivar timestamp: monotonic creation time of the alert. If an alert was c

@dataclass(kw_only=True)
class AsyncAlert:
    """Contents of an asynchronous alert which display while user is at prompt.

    :param msg: an optional message to be printed above the prompt.
    :param prompt: an optional string to dynamically replace the current prompt.

    :ivar timestamp: monotonic creation time of the alert. If an alert was created
                     before the current prompt was rendered, its prompt data is ignored
                     to avoid a stale display, but its msg data will still be displayed.
    """

    msg: str | None = None
    prompt: str | None = None
    timestamp: float = field(default_factory=time.monotonic, init=False)


@dataclass