openpectus.protocol.messages

Attributes

RpcErrorMessage
RpcStatusMessage

Classes

MessageBase	Base class for protocol messages for both REST and WebSocket communication.
SuccessMessage	Indicates operation success
ErrorMessage	Returned whenever an error occurs
ProtocolErrorMessage	Returned whenever an error occurs

Module Contents

class openpectus.protocol.messages.MessageBase(/, **data)

Bases: pydantic.BaseModel

Base class for protocol messages for both REST and WebSocket communication.

These inherit from pydantic BaseModel to support automatic (de-)serialization when sent over fastapi_websocket_pubsub. Additionally they support automatic openapi schema generation for use with REST.

Unfortunately, for websocket rpc, (de-)serialization is not automatic but is handled using the openpectus.protocol.serialization module.

Parameters:

data (Any)

version: int = 0

Protocol is currently unversioned. This field is included to support future versioning.

__str__()

Return type:

str

class openpectus.protocol.messages.SuccessMessage(/, **data)

Bases: MessageBase

Indicates operation success

Parameters:

data (Any)

class openpectus.protocol.messages.ErrorMessage(/, **data)

Bases: MessageBase

Returned whenever an error occurs

Parameters:

data (Any)

message: str | None = None

exception_message: str | None = None

caller_error: bool = False

__str__()

Return type:

str

class openpectus.protocol.messages.ProtocolErrorMessage(/, **data)

Bases: ErrorMessage

Returned whenever an error occurs

Parameters:

data (Any)

protocol_msg: str

__str__()

Return type:

str

openpectus.protocol.messages.RpcErrorMessage

openpectus.protocol.messages.RpcStatusMessage