Use orjson (#1194)

Author: edenhaus

deebot_client/commands/json/common.py

@@ -4,10 +4,11 @@
 
 from abc import ABC, abstractmethod
 from datetime import UTC, datetime
-import json
 from types import MappingProxyType
 from typing import TYPE_CHECKING, Any
 
+import orjson
+
 from deebot_client.command import (
     Command,
     CommandMqttP2P,
@@ -85,15 +86,15 @@ class JsonCommandMqttP2P(JsonCommand, CommandMqttP2P, ABC):
     @classmethod
     def create_from_mqtt(cls, payload: str | bytes | bytearray) -> CommandMqttP2P:
         """Create a command from the mqtt data."""
-        payload_json = json.loads(payload)
+        payload_json = orjson.loads(payload)
         data = payload_json["body"]["data"]
         return cls._create_from_mqtt(data)
 
     def handle_mqtt_p2p(
         self, event_bus: EventBus, response_payload: str | bytes | bytearray
     ) -> None:
         """Handle response received over the mqtt channel "p2p"."""
-        response = json.loads(response_payload)
+        response = orjson.loads(response_payload)
         self._handle_mqtt_p2p(event_bus, response)
 
     @abstractmethod

deebot_client/commands/json/map/__init__.py

@@ -2,10 +2,11 @@
 
 from __future__ import annotations
 
-import json
 from types import MappingProxyType
 from typing import TYPE_CHECKING, Any
 
+import orjson
+
 from deebot_client.commands.json.common import JsonCommandWithMessageHandling
 from deebot_client.events import (
     MapSetEvent,
@@ -233,7 +234,7 @@ def _handle_subsets(
         :return: A message response
         """
         # subset is based64 7z compressed
-        subsets = json.loads(decompress_base64_data(data["subsets"]).decode())
+        subsets = orjson.loads(decompress_base64_data(data["subsets"]).decode())
 
         match map_type := data["type"]:
             case MapSetType.ROOMS:

deebot_client/message.py

@@ -6,9 +6,10 @@
 from dataclasses import dataclass, field
 from enum import IntEnum, auto
 import functools
-import json
 from typing import TYPE_CHECKING, Any, final
 
+import orjson
+
 from deebot_client.events import FirmwareEvent
 from deebot_client.util import verify_required_class_variables_exists
 
@@ -185,7 +186,7 @@ def _handle(
         data = message
         if not isinstance(message, dict):
             try:
-                data = json.loads(message)
+                data = orjson.loads(message)
             except Exception:
                 _LOGGER.debug(
                     "Could not decode message %s payload %s as JSON",

pyproject.toml

@@ -30,6 +30,7 @@ dependencies = [
     "aiomqtt>=2.0.0,<3.0",
     "cachetools>=5.0.0,<7.0",
     "defusedxml>=0.7.1",
+    "orjson>=3.11.3",
 ]
 version = "0.0.0"
 
@@ -149,7 +150,7 @@ required-imports = ["from __future__ import annotations"]
 ]
 
 [tool.ruff.lint.flake8-tidy-imports.banned-api]
-"svg.Path".msg = "Use map.Path instead"
+"json".msg = "Use orjson instead"
 
 
 [tool.ruff.lint.mccabe]

scripts/check_for_similar_models.py

@@ -3,13 +3,13 @@
 from __future__ import annotations
 
 import asyncio
-import json
 import logging
 import os
 from pathlib import Path
 import time
 
 import aiohttp
+import orjson
 
 from deebot_client.api_client import ApiClient
 from deebot_client.authentication import Authenticator, create_rest_config
@@ -22,7 +22,7 @@ def _save_file(name: str, data: dict[str, list[str]]) -> None:
     path = Path("similarity_output")
     path.mkdir(exist_ok=True)
     with path.joinpath(name).open("w") as f:
-        f.write(json.dumps(data, indent=4))
+        f.write(orjson.dumps(data, option=orjson.OPT_INDENT_2).decode("utf-8"))
 
 
 def _add_models_by_similarity(models: list[str]) -> None:

tests/commands/json/__init__.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
 from collections.abc import Sequence
-import json
 from typing import TYPE_CHECKING, Any
 from unittest.mock import Mock, call
 
+import orjson
 from testfixtures import LogCapture
 
 from deebot_client.event_bus import EventBus
@@ -94,13 +94,13 @@ async def assert_set_command(
             "msg": "fail",
         }
     )
-    command.handle_mqtt_p2p(event_bus, json.dumps(json_data))
+    command.handle_mqtt_p2p(event_bus, orjson.dumps(json_data))
     event_bus.notify.assert_called_once_with(firmware_event)
 
     event_bus.reset_mock()
     # Success
     data, firmware_event = get_message_json(get_success_body())
-    command.handle_mqtt_p2p(event_bus, json.dumps(data))
+    command.handle_mqtt_p2p(event_bus, orjson.dumps(data))
     if not isinstance(expected_get_command_events, Sequence):
         expected_events = [firmware_event, expected_get_command_events]
     else:
@@ -109,7 +109,7 @@ async def assert_set_command(
     event_bus.notify.assert_has_calls([call(x) for x in expected_events])
     assert event_bus.notify.call_count == len(expected_events)
 
-    payload = json.dumps({"body": {"data": args}})
+    payload = orjson.dumps({"body": {"data": args}})
     mqtt_command = command.create_from_mqtt(payload)
     assert mqtt_command == command
 

tests/mqtt_util.py

@@ -4,10 +4,11 @@
 
 import asyncio
 import datetime
-import json
 from typing import TYPE_CHECKING
 from unittest.mock import MagicMock, Mock
 
+import orjson
+
 from deebot_client.event_bus import EventBus
 from deebot_client.mqtt_client import MqttClient, SubscriberInfo
 
@@ -27,9 +28,7 @@ async def verify_subscribe(
     expected_called: bool,
 ) -> None:
     command = "test"
-    data = json.dumps({"test": str(datetime.datetime.now(tz=datetime.UTC))}).encode(
-        "utf-8"
-    )
+    data = orjson.dumps({"test": str(datetime.datetime.now(tz=datetime.UTC))})
     api = device_info.api
     topic = f"iot/atr/{command}/{api['did']}/{api['class']}/{api['resource']}/j"
     await test_client.publish(topic, data)

tests/test_command.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
-import json
 import logging
 from types import MappingProxyType
 from typing import TYPE_CHECKING, Any
 
 from aiohttp import ClientTimeout
+import orjson
 import pytest
 
 from deebot_client.command import Command, InitParam
@@ -80,7 +80,7 @@ def test_CommandMqttP2P_create_from_mqtt_error(
     data: dict[str, str], expected: str
 ) -> None:
     with pytest.raises(DeebotError, match=expected):
-        _TestCommand.create_from_mqtt(json.dumps({"body": {"data": data}}))
+        _TestCommand.create_from_mqtt(orjson.dumps({"body": {"data": data}}))
 
 
 def test_CommandMqttP2P_create_from_mqtt_additional_fields(

tests/test_device.py

@@ -2,10 +2,10 @@
 
 import asyncio
 from collections.abc import Callable
-import json
 from typing import TYPE_CHECKING
 from unittest.mock import Mock, patch
 
+import orjson
 import pytest
 
 from deebot_client.command import Command, DeviceCommandResult
@@ -46,7 +46,7 @@ def json_battery_message_payload(expected_version: str | None = "1.8.2") -> str:
         "header": header,
         "body": {"data": {"value": 100, "isLow": 0}},
     }
-    return json.dumps(data)
+    return orjson.dumps(data).decode("utf-8")
 
 
 def xml_battery_message_payload() -> str:

tests/test_mqtt_client.py

@@ -2,14 +2,14 @@
 
 import asyncio
 import datetime
-import json
 import logging
 import ssl
 from typing import TYPE_CHECKING, Any
 from unittest.mock import DEFAULT, MagicMock, Mock, patch
 
 from aiomqtt import Client, Message, MqttError as AioMqttError
 from cachetools import TTLCache
+import orjson
 import pytest
 
 from deebot_client.commands.json.battery import GetBattery
@@ -97,7 +97,7 @@ async def _publish_p2p(
     *,
     is_request: bool,
 ) -> bytes:
-    data_bytes = json.dumps(data).encode("utf-8")
+    data_bytes = orjson.dumps(data)
     if is_request:
         topic = f"iot/p2p/{command_name}/test/test/test/{device_info['did']}/{device_info['class']}/{device_info['resource']}/q/{request_id}/{data_type}"
     else: