Skip to main content
Version: 1.2.2

SerializedMessage

TypeSource

SerializedMessage(
    "/is_syncsdata": Literal[True],
    "/type": Literal["GroupedMessage"],
    type: Literal["str", "warning", "error"],
    data: Sequence[str],
)

SerializedMessage is a TypedDict.

The serialized message is returned by GroupedMessage.

This method is used for exchanging the messages in different modes, including:

  • multi-processing.
  • file
  • web-based exchanging.

The messages are serialized as a JSON-compatible dictionary.

Keywords​

KeywordTypeRequired
Description
/is_syncsdataLiteral[True]Internal value. It is always True. Used for validating whether the provided data is from this syncstream package.
/typeLiteral["GroupedMessage"]Internal value. It is always "GroupedMessage". Used for validating the type of the data.
typeLiteral["str", "warning", "error"]The type of the message data.
dataSequence[str]The message data content. It is always a sequence of strings.