Merge branch 'dev' into xml_set_fanspeed

Author: edenhaus

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: "actions/checkout@v4"
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
-        uses: actions/setup-python@v5.1.1
+        uses: actions/setup-python@v5.2.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
           cache: "pip"
@@ -45,7 +45,7 @@ jobs:
       - uses: "actions/checkout@v4"
       - name: Set up Python ${{ matrix.python-version }}
         id: python
-        uses: actions/setup-python@v5.1.1
+        uses: actions/setup-python@v5.2.0
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip"

.github/workflows/python-publish.yml

@@ -23,7 +23,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v5.1.1
+        uses: actions/setup-python@v5.2.0
         with:
           python-version: "3.12"
 

.pre-commit-config.yaml

@@ -11,7 +11,7 @@ default_language_version:
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.6
+    rev: v0.6.3
     hooks:
       - id: ruff
         args:

deebot_client/commands/xml/__init__.py

@@ -10,12 +10,14 @@
 from .error import GetError
 from .fan_speed import GetFanSpeed, SetFanSpeed
 from .pos import GetPos
+from .stats import GetCleanSum
 
 if TYPE_CHECKING:
     from .common import XmlCommand
 
 __all__ = [
     "GetChargeState",
+    "GetCleanSum",
     "GetError",
     "GetFanSpeed",
     "SetFanSpeed",

deebot_client/commands/xml/stats.py

@@ -0,0 +1,40 @@
+"""CleanSum command module."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from deebot_client.events import TotalStatsEvent
+from deebot_client.message import HandlingResult
+
+from .common import XmlCommandWithMessageHandling
+
+if TYPE_CHECKING:
+    from xml.etree.ElementTree import Element
+
+    from deebot_client.event_bus import EventBus
+
+
+class GetCleanSum(XmlCommandWithMessageHandling):
+    """GetCleanSum command."""
+
+    name = "GetCleanSum"
+
+    @classmethod
+    def _handle_xml(cls, event_bus: EventBus, xml: Element) -> HandlingResult:
+        """Handle xml message and notify the correct event subscribers.
+
+        :return: A message response
+        """
+        if xml.attrib.get("ret") != "ok":
+            return HandlingResult.analyse()
+
+        if (
+            (area := xml.attrib.get("a"))
+            and (lifetime := xml.attrib.get("l"))
+            and (count := xml.attrib.get("c"))
+        ):
+            event_bus.notify(TotalStatsEvent(int(area), int(lifetime), int(count)))
+            return HandlingResult.success()
+
+        return HandlingResult.analyse()

requirements-test.txt

@@ -1,9 +1,9 @@
-mypy==1.11.1
+mypy==1.11.2
 pre-commit==3.8.0
 pycountry==24.6.1
-pylint==3.2.6
+pylint==3.2.7
 pytest==8.3.2
-pytest-asyncio==0.23.8
+pytest-asyncio==0.24.0
 pytest-cov==5.0.0
 pytest-docker-fixtures==1.3.19
 pytest-timeout==2.3.1

tests/commands/xml/test_stats.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import pytest
+
+from deebot_client.command import CommandResult
+from deebot_client.commands.xml import GetCleanSum
+from deebot_client.events import TotalStatsEvent
+from deebot_client.message import HandlingState
+from tests.commands import assert_command
+
+from . import get_request_xml
+
+if TYPE_CHECKING:
+    from deebot_client.events.base import Event
+
+
+@pytest.mark.parametrize(
+    ("area", "lifetime", "count", "expected_event"),
+    [
+        (1000, 20, 30, TotalStatsEvent(1000, 20, 30)),
+    ],
+)
+async def test_get_clean_sum(
+    area: int, lifetime: int, count: int, expected_event: Event
+) -> None:
+    json = get_request_xml(f"<ctl ret='ok' a='{area}' l='{lifetime}' c='{count}' />")
+    await assert_command(GetCleanSum(), json, expected_event)
+
+
+@pytest.mark.parametrize(
+    "xml",
+    ["<ctl ret='error'/>", "<ctl ret='ok' a='34' />"],
+    ids=["error", "error"],
+)
+async def test_get_clean_sum_error(xml: str) -> None:
+    json = get_request_xml(xml)
+    await assert_command(
+        GetCleanSum(),
+        json,
+        None,
+        command_result=CommandResult(HandlingState.ANALYSE_LOGGED),
+    )