uiprotect 1.19.3__py3-none-any.whl → 1.20.0__py3-none-any.whl

uiprotect/__init__.py

@@ -4,10 +4,26 @@ from __future__ import annotations
 
 from .api import ProtectApiClient
 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,
+    make_value_getter,
+)
 
 __all__ = [
     "Invalid",
     "NotAuthorized",
     "NvrError",
     "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",
+    "make_required_getter",
 ]

uiprotect/utils.py

@@ -17,11 +17,12 @@ from copy import deepcopy
 from datetime import datetime, timedelta, timezone, tzinfo
 from decimal import Decimal
 from enum import Enum
-from functools import cache, lru_cache
+from functools import cache, lru_cache, partial
 from hashlib import sha224
 from http.cookies import Morsel
 from inspect import isclass
 from ipaddress import IPv4Address, IPv6Address, ip_address
+from operator import attrgetter
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, TypeVar, Union, overload
 from uuid import UUID
@@ -619,3 +620,57 @@ def clamp_value(value: float, step_size: float) -> float:
 def normalize_mac(mac: str) -> str:
     """Normalize MAC address."""
     return mac.lower().replace(":", "").replace("-", "").replace("_", "")
+
+
+_SENTINEL = object()
+
+
+def get_nested_attr(attrs: tuple[str, ...], obj: Any) -> Any:
+    """Fetch a nested attribute."""
+    value = obj
+    for key in attrs:
+        if (value := getattr(value, key, _SENTINEL)) is _SENTINEL:
+            return None
+    return value.value if isinstance(value, Enum) else value
+
+
+def get_nested_attr_as_bool(attrs: tuple[str, ...], obj: Any) -> bool:
+    """Fetch a nested attribute as a bool."""
+    value = obj
+    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
+
+
+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)
+
+
+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 partial(get_nested_attr, tuple(ufp_value.split(".")))
+
+
+def make_enabled_getter(ufp_enabled: str) -> Callable[[T], bool]:
+    """Return a function to get a value from a Protect device."""
+    if "." not in ufp_enabled:
+        return attrgetter(ufp_enabled)
+    return partial(get_nested_attr, tuple(ufp_enabled.split(".")))
+
+
+def make_required_getter(ufp_required_field: str) -> Callable[[T], bool]:
+    """Return a function to get a value from a Protect device."""
+    if "." not in ufp_required_field:
+        return partial(get_top_level_attr_as_bool, ufp_required_field)
+    return partial(get_nested_attr_as_bool, tuple(ufp_required_field.split(".")))

{uiprotect-1.19.3.dist-info → uiprotect-1.20.0.dist-info}/METADATA

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

{uiprotect-1.19.3.dist-info → uiprotect-1.20.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-uiprotect/__init__.py,sha256=llnQNtiBfwQG8IkQXovvFz4LZeFjrJx7XdmmUhu3a9E,289
+uiprotect/__init__.py,sha256=UdpRSSLSy7pdDfTKf0zRIfy6KRGt_Jv-fMzYWgibbG4,686
 uiprotect/__main__.py,sha256=C_bHCOkv5qj6WMy-6ELoY3Y6HDhLxOa1a30CzmbZhsg,462
 uiprotect/api.py,sha256=SvAni2arXGtP8HzvTljKNLclSfzpRL03RaEF8o1o6K4,65561
 uiprotect/cli/__init__.py,sha256=sSLW9keVQOkgFcMW18HTDjRrt9sJ0KWjn9DJDA6f9Pc,8658
@@ -28,10 +28,10 @@ uiprotect/release_cache.json,sha256=NamnSFy78hOWY0DPO87J9ELFCAN6NnVquv8gQO75ZG4,
 uiprotect/stream.py,sha256=McV3XymKyjn-1uV5jdQHcpaDjqLS4zWyMASQ8ubcyb4,4924
 uiprotect/test_util/__init__.py,sha256=d2g7afa0LSdixQ0kjEDYwafDFME_UlW2LzxpamZ2BC0,18556
 uiprotect/test_util/anonymize.py,sha256=f-8ijU-_y9r-uAbhIPn0f0I6hzJpAkvJzc8UpWihObI,8478
-uiprotect/utils.py,sha256=NXMLqQFiTP1rHAyNK179jWgj2O0RpUCWljaLLgg8q4M,18143
+uiprotect/utils.py,sha256=3SJFF8qs1Jz8t3mD8qwc1hFSocolFjdXI_v4yVlC7o4,20088
 uiprotect/websocket.py,sha256=JHI_2EZeRPqPyQopsBZS0dr3tu0HaTiqeLazfBXhW_8,7339
-uiprotect-1.19.3.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
-uiprotect-1.19.3.dist-info/METADATA,sha256=wwNTlD0-tf7_gRV0ORwawfuyUw5olAq8q6aadEwvXa4,10983
-uiprotect-1.19.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-uiprotect-1.19.3.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
-uiprotect-1.19.3.dist-info/RECORD,,
+uiprotect-1.20.0.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
+uiprotect-1.20.0.dist-info/METADATA,sha256=2tR-i6s0-c1E1PzpEfVbFq9V9jA2RjilNdhywYM9NW0,10983
+uiprotect-1.20.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+uiprotect-1.20.0.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
+uiprotect-1.20.0.dist-info/RECORD,,