uiprotect 0.10.1__tar.gz → 0.12.0__tar.gz

{uiprotect-0.10.1 → uiprotect-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiprotect
-Version: 0.10.1
+Version: 0.12.0
 Summary: Python API for Unifi Protect (Unofficial)
 Home-page: https://github.com/uilibs/uiprotect
 License: MIT

{uiprotect-0.10.1 → uiprotect-0.12.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uiprotect"
-version = "0.10.1"
+version = "0.12.0"
 description = "Python API for Unifi Protect (Unofficial)"
 authors = ["UI Protect Maintainers <ui@koston.org>"]
 license = "MIT"

{uiprotect-0.10.1 → uiprotect-0.12.0}/src/uiprotect/data/bootstrap.py

@@ -18,7 +18,7 @@ except ImportError:
     from pydantic import PrivateAttr, ValidationError  # type: ignore[assignment]
 
 from ..exceptions import ClientError
-from ..utils import utc_now
+from ..utils import normalize_mac, utc_now
 from .base import (
     RECENT_EVENT_MAX,
     ProtectBaseObject,
@@ -41,7 +41,6 @@ from .types import EventType, FixSizeOrderedDict, ModelType
 from .user import Group, User
 from .websocket import (
     WSAction,
-    WSJSONPacketFrame,
     WSPacket,
     WSSubscriptionMessage,
 )
@@ -169,6 +168,10 @@ class ProtectDeviceRef(ProtectBaseObject):
     id: str
 
 
+_ModelType_NVR_value = ModelType.NVR.value
+_ModelType_Event_value = ModelType.EVENT.value
+
+
 class Bootstrap(ProtectBaseObject):
     auth_user_id: str
     access_key: str
@@ -223,7 +226,7 @@ class Bootstrap(ProtectBaseObject):
                 items[item["id"]] = item
                 data["idLookup"][item["id"]] = ref
                 if "mac" in item:
-                    cleaned_mac = item["mac"].lower().replace(":", "")
+                    cleaned_mac = normalize_mac(item["mac"])
                     data["macLookup"][cleaned_mac] = ref
             data[key] = items
 
@@ -309,8 +312,7 @@ class Bootstrap(ProtectBaseObject):
 
     def get_device_from_mac(self, mac: str) -> ProtectAdoptableDeviceModel | None:
         """Retrieve a device from MAC address."""
-        mac = mac.lower().replace(":", "").replace("-", "").replace("_", "")
-        ref = self.mac_lookup.get(mac)
+        ref = self.mac_lookup.get(normalize_mac(mac))
         if ref is None:
             return None
 
@@ -375,7 +377,7 @@ class Bootstrap(ProtectBaseObject):
         elif (
             isinstance(obj, ProtectAdoptableDeviceModel)
             and obj.model is not None
-            and obj.model.value in ModelType.bootstrap_models()
+            and obj.model.value in ModelType.bootstrap_models_set()
         ):
             key = obj.model.value + "s"
             if not self.api.ignore_unadopted or (
@@ -384,7 +386,7 @@ class Bootstrap(ProtectBaseObject):
                 getattr(self, key)[obj.id] = obj
                 ref = ProtectDeviceRef(model=obj.model, id=obj.id)
                 self.id_lookup[obj.id] = ref
-                self.mac_lookup[obj.mac.lower().replace(":", "")] = ref
+                self.mac_lookup[normalize_mac(obj.mac)] = ref
         else:
             _LOGGER.debug("Unexpected bootstrap model type for add: %s", obj.model)
             return None
@@ -400,23 +402,19 @@ class Bootstrap(ProtectBaseObject):
             new_obj=obj,
         )
 
-    def _process_remove_packet(
-        self,
-        packet: WSPacket,
-        data: dict[str, Any] | None,
-    ) -> WSSubscriptionMessage | None:
-        model = packet.action_frame.data.get("modelKey")
-        device_id = packet.action_frame.data.get("id")
+    def _process_remove_packet(self, packet: WSPacket) -> WSSubscriptionMessage | None:
+        model: str | None = packet.action_frame.data.get("modelKey")
         devices = getattr(self, f"{model}s", None)
 
         if devices is None:
             return None
 
+        device_id: str = packet.action_frame.data["id"]
         self.id_lookup.pop(device_id, None)
         device = devices.pop(device_id, None)
         if device is None:
             return None
-        self.mac_lookup.pop(device.mac.lower().replace(":", ""), None)
+        self.mac_lookup.pop(normalize_mac(device.mac), None)
 
         self._create_stat(packet, None, False)
         return WSSubscriptionMessage(
@@ -486,12 +484,11 @@ class Bootstrap(ProtectBaseObject):
 
         key = f"{model_type}s"
         devices = getattr(self, key)
-        if action["id"] in devices:
-            if action["id"] not in devices:
-                raise ValueError(
-                    f"Unknown device update for {model_type}: { action['id']}",
-                )
-            obj: ProtectModelWithId = devices[action["id"]]
+        action_id: str = action["id"]
+        if action_id in devices:
+            if action_id not in devices:
+                raise ValueError(f"Unknown device update for {model_type}: {action_id}")
+            obj: ProtectModelWithId = devices[action_id]
             data = obj.unifi_dict_to_dict(data)
             old_obj = obj.copy()
             obj = obj.update_from_dict(deepcopy(data))
@@ -514,7 +511,7 @@ class Bootstrap(ProtectBaseObject):
                 if is_recent:
                     obj.set_alarm_timeout()
 
-            devices[action["id"]] = obj
+            devices[action_id] = obj
 
             self._create_stat(packet, data, False)
             return WSSubscriptionMessage(
@@ -526,8 +523,8 @@ class Bootstrap(ProtectBaseObject):
             )
 
         # ignore updates to events that phase out
-        if model_type != ModelType.EVENT.value:
-            _LOGGER.debug("Unexpected %s: %s", key, action["id"])
+        if model_type != _ModelType_Event_value:
+            _LOGGER.debug("Unexpected %s: %s", key, action_id)
         return None
 
     def process_ws_packet(
@@ -536,51 +533,40 @@ class Bootstrap(ProtectBaseObject):
         models: set[ModelType] | None = None,
         ignore_stats: bool = False,
     ) -> WSSubscriptionMessage | None:
-        if models is None:
-            models = set()
-
-        if not isinstance(packet.action_frame, WSJSONPacketFrame):
-            _LOGGER.debug(
-                "Unexpected action frame format: %s",
-                packet.action_frame.payload_format,
-            )
-
-        if not isinstance(packet.data_frame, WSJSONPacketFrame):
-            _LOGGER.debug(
-                "Unexpected data frame format: %s",
-                packet.data_frame.payload_format,
-            )
-
+        """Process a WS packet."""
         action, data = self._get_frame_data(packet)
-        if action["newUpdateId"] is not None:
-            self.last_update_id = action["newUpdateId"]
+        new_update_id: str = action["newUpdateId"]
+        if new_update_id is not None:
+            self.last_update_id = new_update_id
 
-        if action["modelKey"] not in ModelType.values_set():
-            _LOGGER.debug("Unknown model type: %s", action["modelKey"])
+        model_key: str = action["modelKey"]
+        if model_key not in ModelType.values_set():
+            _LOGGER.debug("Unknown model type: %s", model_key)
             self._create_stat(packet, None, True)
             return None
 
-        if len(models) > 0 and ModelType(action["modelKey"]) not in models:
+        if models and ModelType(model_key) not in models:
             self._create_stat(packet, None, True)
             return None
 
-        if action["action"] == "remove":
-            return self._process_remove_packet(packet, data)
+        action_action: str = action["action"]
+        if action_action == "remove":
+            return self._process_remove_packet(packet)
 
-        if data is None or len(data) == 0:
+        if not data:
             self._create_stat(packet, None, True)
             return None
 
         try:
-            if action["action"] == "add":
+            if action_action == "add":
                 return self._process_add_packet(packet, data)
-
-            if action["action"] == "update":
-                if action["modelKey"] == ModelType.NVR.value:
+            if action_action == "update":
+                if model_key == _ModelType_NVR_value:
                     return self._process_nvr_update(packet, data, ignore_stats)
+
                 if (
-                    action["modelKey"] in ModelType.bootstrap_models_set()
-                    or action["modelKey"] == ModelType.EVENT.value
+                    model_key in ModelType.bootstrap_models_set()
+                    or model_key == _ModelType_Event_value
                 ):
                     return self._process_device_update(
                         packet,
@@ -588,13 +574,12 @@ class Bootstrap(ProtectBaseObject):
                         data,
                         ignore_stats,
                     )
-                _LOGGER.debug(
-                    "Unexpected bootstrap model type deviceadoptedfor update: %s",
-                    action["modelKey"],
-                )
         except (ValidationError, ValueError) as err:
             self._handle_ws_error(action, err)
 
+        _LOGGER.debug(
+            "Unexpected bootstrap model type deviceadoptedfor update: %s", model_key
+        )
         self._create_stat(packet, None, True)
         return None
 
@@ -605,7 +590,7 @@ class Bootstrap(ProtectBaseObject):
         else:
             try:
                 model_type = ModelType(action["modelKey"])
-                device_id = action["id"]
+                device_id: str = action["id"]
                 task = asyncio.create_task(self.refresh_device(model_type, device_id))
                 self._refresh_tasks.add(task)
                 task.add_done_callback(self._refresh_tasks.discard)

{uiprotect-0.10.1 → uiprotect-0.12.0}/src/uiprotect/data/websocket.py

@@ -7,6 +7,7 @@ import enum
 import struct
 import zlib
 from dataclasses import dataclass
+from functools import cache, cached_property
 from typing import TYPE_CHECKING, Any
 
 import orjson
@@ -62,6 +63,7 @@ class BaseWSPacketFrame:
         raise NotImplementedError
 
     @staticmethod
+    @cache
     def klass_from_format(format_raw: int) -> type[BaseWSPacketFrame]:
         payload_format = ProtectWSPayloadFormat(format_raw)
 
@@ -174,13 +176,15 @@ class WSJSONPacketFrame(BaseWSPacketFrame):
 
 
 class WSPacket:
+    """Class to handle a unifi protect websocket packet."""
+
     _raw: bytes
     _raw_encoded: str | None = None
 
     _action_frame: BaseWSPacketFrame | None = None
     _data_frame: BaseWSPacketFrame | None = None
 
-    def __init__(self, data: bytes):
+    def __init__(self, data: bytes) -> None:
         self._raw = data
 
     def decode(self) -> None:
@@ -190,7 +194,7 @@ class WSPacket:
             self._action_frame.length,
         )
 
-    @property
+    @cached_property
     def action_frame(self) -> BaseWSPacketFrame:
         if self._action_frame is None:
             self.decode()
@@ -200,7 +204,7 @@ class WSPacket:
 
         return self._action_frame
 
-    @property
+    @cached_property
     def data_frame(self) -> BaseWSPacketFrame:
         if self._data_frame is None:
             self.decode()
@@ -220,6 +224,8 @@ class WSPacket:
         self._action_frame = None
         self._data_frame = None
         self._raw_encoded = None
+        self.__dict__.pop("data_frame", None)
+        self.__dict__.pop("action_frame", None)
 
     @property
     def raw_base64(self) -> str:

{uiprotect-0.10.1 → uiprotect-0.12.0}/src/uiprotect/utils.py

@@ -624,3 +624,9 @@ def clamp_value(value: float, step_size: float) -> float:
     """Clamps value to multiples of step size."""
     ratio = 1 / step_size
     return int(value * ratio) / ratio
+
+
+@lru_cache(maxsize=1024)
+def normalize_mac(mac: str) -> str:
+    """Normalize MAC address."""
+    return mac.lower().replace(":", "").replace("-", "").replace("_", "")