+def decode_message(data: bytes) ‑> dict
+Decode a message from raw bytes.
@staticmethod
+@abstractmethod
+def decode_message(data: bytes) -> dict:
+ """
+ Decode a message from raw bytes.
+ """
+ pass # pragma: no cover
def encode_message(message: dict) ‑> bytes
Protocol:
closedecode_messagedrainis_connectedsend_messageProtocol:
closedecode_messagedrainencode_messageis_connectedP
abortclosedecode_messagedrainencode_messageis_connectedModule server.protocol.protocol
"""
pass # pragma: no cover
+ @staticmethod
+ @abstractmethod
+ def decode_message(data: bytes) -> dict:
+ """
+ Decode a message from raw bytes.
+ """
+ pass # pragma: no cover
+
def is_connected(self) -> bool:
"""
Return whether or not the connection is still alive
@@ -238,6 +246,14 @@ Ancestors
"""
pass # pragma: no cover
+ @staticmethod
+ @abstractmethod
+ def decode_message(data: bytes) -> dict:
+ """
+ Decode a message from raw bytes.
+ """
+ pass # pragma: no cover
+
def is_connected(self) -> bool:
"""
Return whether or not the connection is still alive
@@ -370,6 +386,24 @@ Subclasses
Static methods
+
+def decode_message(data: bytes) ‑> dict
+-
+
Decode a message from raw bytes.
+
+
+Expand source code
+
+@staticmethod
+@abstractmethod
+def decode_message(data: bytes) -> dict:
+ """
+ Decode a message from raw bytes.
+ """
+ pass # pragma: no cover
+
+
def encode_message(message: dict) ‑> bytes
abortclosedecode_messagedrainencode_messageis_connectedModule server.protocol.qdatastream
return QDataStreamProtocol.pack_message(json_encoder.encode(message))
- async def read_message(self):
- """
- Read a message from the stream
-
- # Errors
- Raises `IncompleteReadError` on malformed stream.
- """
- try:
- length, *_ = struct.unpack("!I", await self.reader.readexactly(4))
- block = await self.reader.readexactly(length)
- except IncompleteReadError as e:
- if self.reader.at_eof() and not e.partial:
- raise DisconnectedError()
- # Otherwise reraise
- raise
-
- pos, action = self.read_qstring(block)
+ @staticmethod
+ def decode_message(data: bytes) -> dict:
+ _, action = QDataStreamProtocol.read_qstring(data)
if action in ("PING", "PONG"):
return {"command": action.lower()}
message = json.loads(action)
try:
- for part in self.read_block(block):
+ for part in QDataStreamProtocol.read_block(data):
try:
message_part = json.loads(part)
if part != action:
@@ -143,6 +129,24 @@ Module server.protocol.qdatastream
pass
return message
+ async def read_message(self):
+ """
+ Read a message from the stream
+
+ # Errors
+ Raises `IncompleteReadError` on malformed stream.
+ """
+ try:
+ length, *_ = struct.unpack("!I", await self.reader.readexactly(4))
+ block = await self.reader.readexactly(length)
+ except IncompleteReadError as e:
+ if self.reader.at_eof() and not e.partial:
+ raise DisconnectedError()
+ # Otherwise reraise
+ raise
+
+ return QDataStreamProtocol.decode_message(block)
+
PING_MSG = QDataStreamProtocol.pack_message("PING")
PONG_MSG = QDataStreamProtocol.pack_message("PONG")
@@ -239,6 +243,27 @@ Classes
return QDataStreamProtocol.pack_message(json_encoder.encode(message))
+ @staticmethod
+ def decode_message(data: bytes) -> dict:
+ _, action = QDataStreamProtocol.read_qstring(data)
+ if action in ("PING", "PONG"):
+ return {"command": action.lower()}
+
+ message = json.loads(action)
+ try:
+ for part in QDataStreamProtocol.read_block(data):
+ try:
+ message_part = json.loads(part)
+ if part != action:
+ message.update(message_part)
+ except (ValueError, TypeError):
+ if "legacy" not in message:
+ message["legacy"] = []
+ message["legacy"].append(part)
+ except (KeyError, ValueError):
+ pass
+ return message
+
async def read_message(self):
"""
Read a message from the stream
@@ -255,24 +280,7 @@ Classes
# Otherwise reraise
raise
- pos, action = self.read_qstring(block)
- if action in ("PING", "PONG"):
- return {"command": action.lower()}
-
- message = json.loads(action)
- try:
- for part in self.read_block(block):
- try:
- message_part = json.loads(part)
- if part != action:
- message.update(message_part)
- except (ValueError, TypeError):
- if "legacy" not in message:
- message["legacy"] = []
- message["legacy"].append(part)
- except (KeyError, ValueError):
- pass
- return message
+ return QDataStreamProtocol.decode_message(block)
Protocol:
closedecode_messagedrainis_connectedsend_messageserver.protocol.simple_jsonProtocol: