uiprotect 4.1.0__tar.gz → 5.0.0__tar.gz

{uiprotect-4.1.0 → uiprotect-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiprotect
-Version: 4.1.0
+Version: 5.0.0
 Summary: Python API for Unifi Protect (Unofficial)
 Home-page: https://github.com/uilibs/uiprotect
 Author: UI Protect Maintainers
@@ -21,6 +21,7 @@ Requires-Dist: aiofiles (>=23)
 Requires-Dist: aiohttp (>=3.9.0)
 Requires-Dist: aioshutil (>=1.3)
 Requires-Dist: async-timeout (>=3.0.1)
+Requires-Dist: convertertools (>=0.5.0)
 Requires-Dist: dateparser (>=1.1.0)
 Requires-Dist: orjson (>=3.9.15)
 Requires-Dist: packaging (>=23)

{uiprotect-4.1.0 → uiprotect-5.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uiprotect"
-version = "4.1.0"
+version = "5.0.0"
 description = "Python API for Unifi Protect (Unofficial)"
 authors = ["UI Protect Maintainers <ui@koston.org>"]
 readme = "README.md"
@@ -45,10 +45,11 @@ pydantic = "!=1.9.1,>=1.10.17"
 pyjwt = ">=2.6"
 yarl = ">=1.9"
 typer = ">=0.12.3"
+convertertools = ">=0.5.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.0"
-pytest-cov = "^3.0"
+pytest = ">=7,<9"
+pytest-cov = ">=3,<6"
 aiosqlite = ">=0.20.0"
 asttokens = "^2.4.1"
 pytest-asyncio = "^0.23.7"
@@ -56,7 +57,7 @@ pytest-benchmark = "^4.0.0"
 pytest-sugar = "^1.0.0"
 pytest-timeout = "^2.3.1"
 pytest-xdist = "^3.6.1"
-types-aiofiles = "^23.2.0.20240403"
+types-aiofiles = ">=23.2.0.20240403,<25.0.0.0"
 types-dateparser = "^1.2.0.20240420"
 mypy = "^1.10.0"
 
@@ -145,6 +146,7 @@ ignore = [
     "D106", # Missing docstring in public nested class
     "UP007", # typer needs Optional syntax
     "UP038", # Use `X | Y` in `isinstance` is slower
+    "S603", #  check for execution of untrusted input
 ]
 select = [
     "B",   # flake8-bugbear

{uiprotect-4.1.0 → uiprotect-5.0.0}/src/uiprotect/__init__.py

@@ -7,7 +7,6 @@ from .exceptions import Invalid, NotAuthorized, NvrError
 from .utils import (
     get_nested_attr,
     get_nested_attr_as_bool,
-    get_top_level_attr,
     get_top_level_attr_as_bool,
     make_enabled_getter,
     make_required_getter,
@@ -21,7 +20,6 @@ __all__ = [
     "ProtectApiClient",
     "get_nested_attr",
     "get_nested_attr_as_bool",
-    "get_top_level_attr",
     "get_top_level_attr_as_bool",
     "make_value_getter",
     "make_enabled_getter",

{uiprotect-4.1.0 → uiprotect-5.0.0}/src/uiprotect/data/base.py

@@ -11,6 +11,7 @@ from ipaddress import IPv4Address
 from typing import TYPE_CHECKING, Any, NamedTuple, TypeVar
 from uuid import UUID
 
+from convertertools import pop_dict_set_if_none, pop_dict_tuple
 from pydantic.v1 import BaseModel
 from pydantic.v1.fields import SHAPE_DICT, SHAPE_LIST, PrivateAttr
 
@@ -551,10 +552,7 @@ class ProtectModel(ProtectBaseObject):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-
-        if "modelKey" in data and data["modelKey"] is None:
-            del data["modelKey"]
-
+        pop_dict_set_if_none(data, {"modelKey"})
         return data
 
 
@@ -955,13 +953,10 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-        for key in (
-            "wiredConnectionState",
-            "wifiConnectionState",
-            "bluetoothConnectionState",
-        ):
-            if key in data and data[key] is None:
-                del data[key]
+        pop_dict_set_if_none(
+            data,
+            {"wiredConnectionState", "wifiConnectionState", "bluetoothConnectionState"},
+        )
         return data
 
     @classmethod
@@ -1072,10 +1067,7 @@ class ProtectMotionDeviceModel(ProtectAdoptableDeviceModel):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-
-        if "lastMotionEventId" in data:
-            del data["lastMotionEventId"]
-
+        pop_dict_tuple(data, ("lastMotionEventId",))
         return data
 
     @property

{uiprotect-4.1.0 → uiprotect-5.0.0}/src/uiprotect/data/bootstrap.py

@@ -10,6 +10,7 @@ from datetime import datetime
 from typing import TYPE_CHECKING, Any
 
 from aiohttp.client_exceptions import ServerDisconnectedError
+from convertertools import pop_dict_set, pop_dict_tuple
 from pydantic.v1 import PrivateAttr, ValidationError
 
 from ..exceptions import ClientError
@@ -230,9 +231,7 @@ class Bootstrap(ProtectBaseObject):
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
 
-        for key in ("events", "captureWsStats", "macLookup", "idLookup"):
-            if key in data:
-                del data[key]
+        pop_dict_tuple(data, ("events", "captureWsStats", "macLookup", "idLookup"))
         for model_type in ModelType.bootstrap_models_types_set:
             attr = model_type.devices_key  # type: ignore[attr-defined]
             if attr in data and isinstance(data[attr], dict):
@@ -385,8 +384,7 @@ class Bootstrap(ProtectBaseObject):
         ignore_stats: bool,
     ) -> WSSubscriptionMessage | None:
         if ignore_stats:
-            for key in STATS_KEYS.intersection(data):
-                del data[key]
+            pop_dict_set(data, STATS_KEYS)
         # nothing left to process
         if not data:
             return None
@@ -435,8 +433,7 @@ class Bootstrap(ProtectBaseObject):
                 model_type, IGNORE_DEVICE_KEYS
             )
 
-        for key in remove_keys.intersection(data):
-            del data[key]
+        pop_dict_set(data, remove_keys)
 
         # nothing left to process
         if not data and not is_ping_back:
@@ -447,7 +444,7 @@ class Bootstrap(ProtectBaseObject):
         if action_id not in devices:
             # ignore updates to events that phase out
             if model_type is not ModelType.EVENT:
-                _LOGGER.debug("Unexpected %s: %s", key, action_id)
+                _LOGGER.debug("Unexpected %s: %s", model_type, action_id)
             return None
 
         obj = devices[action_id]

{uiprotect-4.1.0 → uiprotect-5.0.0}/src/uiprotect/data/devices.py

@@ -12,6 +12,7 @@ from ipaddress import IPv4Address
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Literal, cast
 
+from convertertools import pop_dict_set_if_none, pop_dict_tuple
 from pydantic.v1.fields import PrivateAttr
 
 from ..exceptions import BadRequest, NotAuthorized, StreamError
@@ -341,10 +342,7 @@ class ISPSettings(ProtectBaseObject):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-
-        if "focusMode" in data and data["focusMode"] is None:
-            del data["focusMode"]
-
+        pop_dict_set_if_none(data, {"focusMode"})
         return data
 
 
@@ -611,10 +609,7 @@ class StorageStats(ProtectBaseObject):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-
-        if "rate" in data and data["rate"] is None:
-            del data["rate"]
-
+        pop_dict_set_if_none(data, {"rate"})
         return data
 
 
@@ -1053,21 +1048,21 @@ class Camera(ProtectMotionDeviceModel):
                 ]
 
         data = super().unifi_dict(data=data, exclude=exclude)
-        for key in (
-            "lastRingEventId",
-            "lastSmartDetect",
-            "lastSmartAudioDetect",
-            "lastSmartDetectEventId",
-            "lastSmartAudioDetectEventId",
-            "lastSmartDetects",
-            "lastSmartAudioDetects",
-            "lastSmartDetectEventIds",
-            "lastSmartAudioDetectEventIds",
-            "talkbackStream",
-        ):
-            if key in data:
-                del data[key]
-
+        pop_dict_tuple(
+            data,
+            (
+                "lastRingEventId",
+                "lastSmartDetect",
+                "lastSmartAudioDetect",
+                "lastSmartDetectEventId",
+                "lastSmartAudioDetectEventId",
+                "lastSmartDetects",
+                "lastSmartAudioDetects",
+                "lastSmartDetectEventIds",
+                "lastSmartAudioDetectEventIds",
+                "talkbackStream",
+            ),
+        )
         if "lcdMessage" in data and data["lcdMessage"] is None:
             data["lcdMessage"] = {}
 
@@ -2783,15 +2778,16 @@ class Sensor(ProtectAdoptableDeviceModel):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-        for key in (
-            "lastMotionEventId",
-            "lastContactEventId",
-            "lastValueEventId",
-            "lastAlarmEventId",
-            "extremeValueDetectedAt",
-        ):
-            if key in data:
-                del data[key]
+        pop_dict_tuple(
+            data,
+            (
+                "lastMotionEventId",
+                "lastContactEventId",
+                "lastValueEventId",
+                "lastAlarmEventId",
+                "extremeValueDetectedAt",
+            ),
+        )
         return data
 
     @property

{uiprotect-4.1.0 → uiprotect-5.0.0}/src/uiprotect/data/nvr.py

@@ -16,6 +16,7 @@ from uuid import UUID
 import aiofiles
 import orjson
 from aiofiles import os as aos
+from convertertools import pop_dict_set_if_none, pop_dict_tuple
 from pydantic.v1.fields import PrivateAttr
 
 from ..exceptions import BadRequest, NotAuthorized
@@ -145,11 +146,7 @@ class EventThumbnailAttributes(ProtectBaseObject):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-
-        for key in DELETE_KEYS_THUMB.intersection(data):
-            if data[key] is None:
-                del data[key]
-
+        pop_dict_set_if_none(data, DELETE_KEYS_THUMB)
         return data
 
 
@@ -171,10 +168,7 @@ class EventDetectedThumbnail(ProtectBaseObject):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-
-        if "name" in data and data["name"] is None:
-            del data["name"]
-
+        pop_dict_set_if_none(data, {"name"})
         return data
 
 
@@ -309,11 +303,7 @@ class Event(ProtectModelWithId):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-
-        for key in DELETE_KEYS_EVENT.intersection(data):
-            if data[key] is None:
-                del data[key]
-
+        pop_dict_set_if_none(data, DELETE_KEYS_EVENT)
         return data
 
     @property
@@ -632,30 +622,29 @@ class UOSDisk(ProtectBaseObject):
             data["estimate"] /= 1000
 
         if "state" in data and data["state"] == "nodisk":
-            delete_keys = [
-                "action",
-                "ata",
-                "bad_sector",
-                "estimate",
-                "firmware",
-                "healthy",
-                "life_span",
-                "model",
-                "poweronhrs",
-                "progress",
-                "reason",
-                "rpm",
-                "sata",
-                "serial",
-                "tempature",
-                "temperature",
-                "threshold",
-                "type",
-            ]
-            for key in delete_keys:
-                if key in data:
-                    del data[key]
-
+            pop_dict_tuple(
+                data,
+                (
+                    "action",
+                    "ata",
+                    "bad_sector",
+                    "estimate",
+                    "firmware",
+                    "healthy",
+                    "life_span",
+                    "model",
+                    "poweronhrs",
+                    "progress",
+                    "reason",
+                    "rpm",
+                    "sata",
+                    "serial",
+                    "tempature",
+                    "temperature",
+                    "threshold",
+                    "type",
+                ),
+            )
         return data
 
     @property
@@ -739,10 +728,7 @@ class SystemInfo(ProtectBaseObject):
         exclude: set[str] | None = None,
     ) -> dict[str, Any]:
         data = super().unifi_dict(data=data, exclude=exclude)
-
-        if data is not None and "ustorage" in data and data["ustorage"] is None:
-            del data["ustorage"]
-
+        pop_dict_set_if_none(data, {"ustorage"})
         return data
 
 

{uiprotect-4.1.0 → uiprotect-5.0.0}/src/uiprotect/test_util/__init__.py

@@ -359,7 +359,7 @@ class SampleDataGenerator:
         length = int((motion_event["end"] - motion_event["start"]) / 1000)
         if self.anonymize:
             run(
-                split(  # noqa: S603
+                split(
                     BLANK_VIDEO_CMD.format(
                         length=length,
                         filename=self.output_folder / f"{filename}.mp4",

{uiprotect-4.1.0 → uiprotect-5.0.0}/src/uiprotect/utils.py

@@ -634,7 +634,7 @@ def get_nested_attr(attrs: tuple[str, ...], obj: Any) -> Any:
     for key in attrs:
         if (value := getattr(value, key, _SENTINEL)) is _SENTINEL:
             return None
-    return value.value if isinstance(value, Enum) else value
+    return value
 
 
 def get_nested_attr_as_bool(attrs: tuple[str, ...], obj: Any) -> bool:
@@ -643,25 +643,18 @@ def get_nested_attr_as_bool(attrs: tuple[str, ...], obj: Any) -> bool:
     for key in attrs:
         if (value := getattr(value, key, _SENTINEL)) is _SENTINEL:
             return False
-    return bool(value.value if isinstance(value, Enum) else value)
-
-
-def get_top_level_attr(attr: str, obj: Any) -> Any:
-    """Fetch a top level attribute."""
-    value = getattr(obj, attr)
-    return value.value if isinstance(value, Enum) else value
+    return bool(value)
 
 
 def get_top_level_attr_as_bool(attr: str, obj: Any) -> Any:
     """Fetch a top level attribute as a bool."""
-    value = getattr(obj, attr)
-    return bool(value.value if isinstance(value, Enum) else value)
+    return bool(getattr(obj, attr))
 
 
 def make_value_getter(ufp_value: str) -> Callable[[T], Any]:
     """Return a function to get a value from a Protect device."""
     if "." not in ufp_value:
-        return partial(get_top_level_attr, ufp_value)
+        return attrgetter(ufp_value)
     return partial(get_nested_attr, tuple(ufp_value.split(".")))