Convert devices list into a dictionary keyed by device ID (#2)

src/tailscale/__init__.py

@@ -1,5 +1,5 @@
 """Asynchronous client for the Tailscale API."""
-from .models import ClientConnectivity, ClientSupports, Device
+from .models import ClientConnectivity, ClientSupports, Device, Devices
 from .tailscale import (
     Tailscale,
     TailscaleAuthenticationError,
@@ -11,6 +11,7 @@
     "ClientConnectivity",
     "ClientSupports",
     "Device",
+    "Devices",
     "Tailscale",
     "TailscaleAuthenticationError",
     "TailscaleConnectionError",

src/tailscale/models.py

@@ -1,8 +1,10 @@
 """Asynchronous client for the Tailscale API."""
+from __future__ import annotations
+
 from datetime import datetime
-from typing import Any, List, Optional
+from typing import Any, Dict, List, Optional
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, validator
 
 
 class ClientSupports(BaseModel):
@@ -56,4 +58,17 @@ class Device(BaseModel):
 class Devices(BaseModel):
     """Object holding Tailscale device information."""
 
-    devices: List[Device]
+    devices: Dict[str, Device]
+
+    @validator("devices", pre=True)
+    @classmethod
+    def convert_to_dict(cls, data: list[dict]) -> dict[Any, dict]:  # noqa: F841
+        """Convert list into dict, keyed by device id.
+
+        Args:
+            data: List of dicts to convert.
+
+        Returns:
+            dict: Converted list of dicts.
+        """
+        return {device["id"]: device for device in data}

src/tailscale/tailscale.py

@@ -105,11 +105,11 @@ async def _request(
 
         return await response.json(content_type=None)
 
-    async def devices(self) -> list[Device]:
+    async def devices(self) -> dict[str, Device]:
         """Get devices information from the Tailscale API.
 
         Returns:
-            Returns a list of Tailscale devices.
+            Returns a dictionary of Tailscale devices.
         """
         data = await self._request(f"tailnet/{self.tailnet}/devices")
         return Devices.parse_obj(data).devices