Update trait refresh method to return None (#586)

* fix: Update trait `refresh` method to return `None`

* chore: Revert unnecessary change to Clean Summary Trait

* chore: Fix lint errors

* chore: Revert accidental CleanSummary changes

* chore: remove unnecessary whitespace

Author: allenporter

roborock/devices/traits/v1/clean_summary.py

@@ -14,7 +14,7 @@ class CleanSummaryTrait(CleanSummaryWithDetail, common.V1TraitMixin):
 
     command = RoborockCommand.GET_CLEAN_SUMMARY
 
-    async def refresh(self) -> Self:
+    async def refresh(self) -> None:
         """Refresh the clean summary data and last clean record.
 
         Assumes that the clean summary has already been fetched.
@@ -23,10 +23,9 @@ async def refresh(self) -> Self:
         if not self.records:
             _LOGGER.debug("No clean records available in clean summary.")
             self.last_clean_record = None
-            return self
+            return
         last_record_id = self.records[-1]
         self.last_clean_record = await self.get_clean_record(last_record_id)
-        return self
 
     @classmethod
     def _parse_type_response(cls, response: common.V1ResponseData) -> Self:

roborock/devices/traits/v1/common.py

@@ -76,15 +76,14 @@ def rpc_channel(self) -> V1RpcChannel:
             raise ValueError("Device trait in invalid state")
         return self._rpc_channel
 
-    async def refresh(self) -> Self:
+    async def refresh(self) -> None:
         """Refresh the contents of this trait."""
         response = await self.rpc_channel.send_command(self.command)
         new_data = self._parse_response(response)
         if not isinstance(new_data, RoborockBase):
             raise ValueError(f"Internal error, unexpected response type: {new_data!r}")
         _LOGGER.debug("Refreshed %s: %s", self.__class__.__name__, new_data)
         self._update_trait_values(new_data)
-        return self
 
     def _update_trait_values(self, new_data: RoborockBase) -> None:
         """Update the values of this trait from another instance."""

roborock/devices/traits/v1/device_features.py

@@ -1,5 +1,4 @@
 from dataclasses import fields
-from typing import Self
 
 from roborock.data import AppInitStatus, RoborockProductNickname
 from roborock.device_features import DeviceFeatures
@@ -13,7 +12,7 @@ class DeviceFeaturesTrait(DeviceFeatures, common.V1TraitMixin):
 
     command = RoborockCommand.APP_GET_INIT_STATUS
 
-    def __init__(self, product_nickname: RoborockProductNickname, cache: Cache) -> None:
+    def __init__(self, product_nickname: RoborockProductNickname, cache: Cache) -> None:  # pylint: disable=super-init-not-called
         """Initialize MapContentTrait."""
         self._nickname = product_nickname
         self._cache = cache
@@ -22,7 +21,7 @@ def __init__(self, product_nickname: RoborockProductNickname, cache: Cache) -> N
         for field in fields(self):
             setattr(self, field.name, False)
 
-    async def refresh(self) -> Self:
+    async def refresh(self) -> None:
         """Refresh the contents of this trait.
 
         This will use cached device features if available since they do not
@@ -32,12 +31,11 @@ async def refresh(self) -> Self:
         cache_data = await self._cache.get()
         if cache_data.device_features is not None:
             self._update_trait_values(cache_data.device_features)
-            return self
+            return
         # Save cached device features
-        device_features = await super().refresh()
-        cache_data.device_features = device_features
+        await super().refresh()
+        cache_data.device_features = self
         await self._cache.set(cache_data)
-        return device_features
 
     def _parse_response(self, response: common.V1ResponseData) -> DeviceFeatures:
         """Parse the response from the device into a MapContentTrait instance."""

roborock/devices/traits/v1/home.py

@@ -158,7 +158,7 @@ async def _build_home_map_info(self) -> tuple[dict[int, CombinedMapInfo], dict[i
             home_map_info[map_info.map_flag] = combined_map_info
         return home_map_info, home_map_content
 
-    async def refresh(self) -> Self:
+    async def refresh(self) -> None:
         """Refresh current map's underlying map and room data, updating cache as needed.
 
         This will only refresh the current map's data and will not populate non
@@ -171,7 +171,7 @@ async def refresh(self) -> Self:
             # then we'll fall through below to refresh the current map only.
             try:
                 await self.discover_home()
-                return self
+                return
             except RoborockDeviceBusy:
                 _LOGGER.debug("Cannot refresh home data while device is busy cleaning")
 
@@ -189,7 +189,6 @@ async def refresh(self) -> Self:
         await self._update_current_map(
             map_flag, combined_map_info, new_map_content, update_cache=self._discovery_completed
         )
-        return self
 
     @property
     def home_map_info(self) -> dict[int, CombinedMapInfo] | None:

roborock/devices/traits/v1/network_info.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import logging
-from typing import Self
 
 from roborock.data import NetworkInfo
 from roborock.devices.cache import Cache
@@ -25,20 +24,20 @@ class NetworkInfoTrait(NetworkInfo, common.V1TraitMixin):
 
     command = RoborockCommand.GET_NETWORK_INFO
 
-    def __init__(self, device_uid: str, cache: Cache) -> None:
+    def __init__(self, device_uid: str, cache: Cache) -> None:  # pylint: disable=super-init-not-called
         """Initialize the trait."""
         self._device_uid = device_uid
         self._cache = cache
         self.ip = ""
 
-    async def refresh(self) -> Self:
+    async def refresh(self) -> None:
         """Refresh the network info from the cache."""
 
         cache_data = await self._cache.get()
         if cache_data.network_info and (network_info := cache_data.network_info.get(self._device_uid)):
             _LOGGER.debug("Using cached network info for device %s", self._device_uid)
             self._update_trait_values(network_info)
-            return self
+            return
 
         # Load from device if not in cache
         _LOGGER.debug("No cached network info for device %s, fetching from device", self._device_uid)
@@ -48,8 +47,6 @@ async def refresh(self) -> Self:
         cache_data.network_info[self._device_uid] = self
         await self._cache.set(cache_data)
 
-        return self
-
     def _parse_response(self, response: common.V1ResponseData) -> NetworkInfo:
         """Parse the response from the device into a NetworkInfo."""
         if not isinstance(response, dict):

tests/devices/traits/v1/test_rooms.py

@@ -48,11 +48,11 @@ async def test_refresh_rooms_trait(
     assert not rooms_trait.rooms
 
     # Load the room mapping information
-    refreshed_trait = await rooms_trait.refresh()
+    await rooms_trait.refresh()
 
     # Verify the room mappings are now populated
-    assert refreshed_trait.rooms
-    rooms = refreshed_trait.rooms
+    assert rooms_trait.rooms
+    rooms = rooms_trait.rooms
     assert len(rooms) == 3
 
     assert rooms[0].segment_id == 16