Uniform the result of read_attribute to always return a dict (#590)

Author: marcelveldt

matter_server/client/client.py

@@ -445,24 +445,26 @@ async def read_attribute(
         self,
         node_id: int,
         attribute_path: str,
-    ) -> Any:
-        """Read attribute(s) on a node."""
-        return await self.send_command(
+    ) -> dict[str, Any]:
+        """Read one or more attribute(s) on a node by specifying an attributepath."""
+        updated_values = await self.send_command(
             APICommand.READ_ATTRIBUTE,
             require_schema=4,
             node_id=node_id,
             attribute_path=attribute_path,
         )
+        if not isinstance(updated_values, dict):
+            # can happen is the server is running schema < 8
+            return {attribute_path: updated_values}
+        return cast(dict[str, Any], updated_values)
 
     async def refresh_attribute(
         self,
         node_id: int,
         attribute_path: str,
-    ) -> Any:
+    ) -> None:
         """Read attribute(s) on a node and store the updated value(s)."""
         updated_values = await self.read_attribute(node_id, attribute_path)
-        if not isinstance(updated_values, dict):
-            updated_values = {attribute_path: updated_values}
         for attr_path, value in updated_values.items():
             self._nodes[node_id].update_attribute(attr_path, value)
 

matter_server/server/device_controller.py

@@ -545,8 +545,8 @@ async def send_device_command(
     @api_command(APICommand.READ_ATTRIBUTE)
     async def read_attribute(
         self, node_id: int, attribute_path: str, fabric_filtered: bool = False
-    ) -> Any:
-        """Read a single attribute (or Cluster) on a node."""
+    ) -> dict[str, Any]:
+        """Read one or more attribute(s) on a node by specifying an attributepath."""
         if self.chip_controller is None:
             raise RuntimeError("Device Controller not initialized.")
         if (node := self._nodes.get(node_id)) is None or not node.available:
@@ -576,9 +576,7 @@ async def read_attribute(
             # update cached info in node attributes
             self._nodes[node_id].attributes.update(read_atributes)
             self._write_node_state(node_id)
-            if len(read_atributes) > 1:
-                return read_atributes
-            return read_atributes.get(attribute_path, None)
+            return read_atributes
 
     @api_command(APICommand.WRITE_ATTRIBUTE)
     async def write_attribute(