uiprotect 1.19.2__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/cli/base.py

@@ -14,11 +14,6 @@ from ..data import NVR, ProtectAdoptableDeviceModel, ProtectBaseObject
 from ..exceptions import BadRequest, NvrError, StreamError
 from ..utils import run_async
 
-try:
-    from pydantic.v1 import ValidationError
-except ImportError:
-    from pydantic import ValidationError  # type: ignore[assignment]
-
 T = TypeVar("T")
 
 OPTION_FORCE = typer.Option(False, "-f", "--force", help="Skip confirmation prompt")

uiprotect/data/base.py

@@ -11,6 +11,9 @@ from ipaddress import IPv4Address
 from typing import TYPE_CHECKING, Any, ClassVar, TypeVar
 from uuid import UUID
 
+from pydantic.v1 import BaseModel
+from pydantic.v1.fields import SHAPE_DICT, SHAPE_LIST, PrivateAttr
+
 from ..exceptions import BadRequest, ClientError, NotAuthorized
 from ..utils import (
     asyncio_timeout,
@@ -34,17 +37,6 @@ from .websocket import (
     WSPacketFrameHeader,
 )
 
-try:
-    from pydantic.v1 import BaseModel
-    from pydantic.v1.fields import SHAPE_DICT, SHAPE_LIST, PrivateAttr
-except ImportError:
-    from pydantic import BaseModel  # type: ignore[assignment, no-redef]
-    from pydantic.fields import (  # type: ignore[attr-defined, assignment, no-redef]
-        SHAPE_DICT,
-        SHAPE_LIST,
-        PrivateAttr,
-    )
-
 if TYPE_CHECKING:
     from asyncio.events import TimerHandle
 

uiprotect/data/bootstrap.py

@@ -10,11 +10,7 @@ from datetime import datetime
 from typing import TYPE_CHECKING, Any
 
 from aiohttp.client_exceptions import ServerDisconnectedError
-
-try:
-    from pydantic.v1 import PrivateAttr, ValidationError
-except ImportError:
-    from pydantic import PrivateAttr, ValidationError  # type: ignore[assignment]
+from pydantic.v1 import PrivateAttr, ValidationError
 
 from ..exceptions import ClientError
 from ..utils import normalize_mac, utc_now

uiprotect/data/devices.py

@@ -12,10 +12,7 @@ from ipaddress import IPv4Address
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Literal, cast
 
-try:
-    from pydantic.v1.fields import PrivateAttr
-except ImportError:
-    from pydantic.fields import PrivateAttr
+from pydantic.v1.fields import PrivateAttr
 
 from ..exceptions import BadRequest, NotAuthorized, StreamError
 from ..stream import TalkbackStream

uiprotect/data/nvr.py

@@ -16,6 +16,7 @@ from uuid import UUID
 import aiofiles
 import orjson
 from aiofiles import os as aos
+from pydantic.v1.fields import PrivateAttr
 
 from ..exceptions import BadRequest, NotAuthorized
 from ..utils import RELEASE_CACHE, convert_to_datetime
@@ -58,16 +59,8 @@ from .types import (
 )
 from .user import User, UserLocation
 
-try:
-    from pydantic.v1.fields import PrivateAttr
-except ImportError:
-    from pydantic.fields import PrivateAttr
-
 if TYPE_CHECKING:
-    try:
-        from pydantic.v1.typing import SetStr
-    except ImportError:
-        from pydantic.typing import SetStr  # type: ignore[assignment, no-redef]
+    from pydantic.v1.typing import SetStr
 
 
 _LOGGER = logging.getLogger(__name__)

uiprotect/data/types.py

@@ -6,18 +6,9 @@ from functools import cache, cached_property
 from typing import Any, Literal, Optional, TypeVar, Union
 
 from packaging.version import Version as BaseVersion
-
-try:
-    from pydantic.v1 import BaseModel, ConstrainedInt
-    from pydantic.v1.color import Color as BaseColor
-    from pydantic.v1.types import ConstrainedFloat, ConstrainedStr
-except ImportError:
-    from pydantic import BaseModel, ConstrainedInt  # type: ignore[assignment, no-redef]
-    from pydantic.color import Color as BaseColor  # type: ignore[assignment, no-redef]
-    from pydantic.types import (  # type: ignore[assignment, no-redef]
-        ConstrainedFloat,
-        ConstrainedStr,
-    )
+from pydantic.v1 import BaseModel, ConstrainedInt
+from pydantic.v1.color import Color as BaseColor
+from pydantic.v1.types import ConstrainedFloat, ConstrainedStr
 
 KT = TypeVar("KT")
 VT = TypeVar("VT")

uiprotect/data/user.py

@@ -6,10 +6,7 @@ from datetime import datetime
 from functools import cache
 from typing import Any
 
-try:
-    from pydantic.v1.fields import PrivateAttr
-except ImportError:
-    from pydantic.fields import PrivateAttr
+from pydantic.v1.fields import PrivateAttr
 
 from .base import ProtectBaseObject, ProtectModel, ProtectModelWithId
 from .types import ModelType, PermissionNode

uiprotect/utils.py

@@ -17,17 +17,20 @@ 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
 
 import jwt
 from aiohttp import ClientResponse
+from pydantic.v1.fields import SHAPE_DICT, SHAPE_LIST, SHAPE_SET, ModelField
+from pydantic.v1.utils import to_camel
 
 from .data.types import (
     Color,
@@ -38,18 +41,6 @@ from .data.types import (
 )
 from .exceptions import NvrError
 
-try:
-    from pydantic.v1.fields import SHAPE_DICT, SHAPE_LIST, SHAPE_SET, ModelField
-    from pydantic.v1.utils import to_camel
-except ImportError:
-    from pydantic.fields import (  # type: ignore[assignment, no-redef, attr-defined]
-        SHAPE_DICT,
-        SHAPE_LIST,
-        SHAPE_SET,
-        ModelField,
-    )
-    from pydantic.utils import to_camel  # type: ignore[assignment, no-redef]
-
 if TYPE_CHECKING:
     from uiprotect.api import ProtectApiClient
     from uiprotect.data import CoordType, Event
@@ -629,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.2.dist-info → uiprotect-1.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiprotect
-Version: 1.19.2
+Version: 1.20.0
 Summary: Python API for Unifi Protect (Unofficial)
 Home-page: https://github.com/uilibs/uiprotect
 License: MIT
@@ -27,7 +27,7 @@ Requires-Dist: orjson (>=3.9.15)
 Requires-Dist: packaging (>=23)
 Requires-Dist: pillow (>=10)
 Requires-Dist: platformdirs (>=4)
-Requires-Dist: pydantic (>=1.10.13)
+Requires-Dist: pydantic (>=1.10.17)
 Requires-Dist: pyjwt (>=2.6)
 Requires-Dist: rich (>=10)
 Requires-Dist: typer (>=0.12.3)

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

@@ -1,9 +1,9 @@
-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
 uiprotect/cli/backup.py,sha256=ZiS7RZnJGKI8TJKLW2cOUzkRM8nyTvE5Ov_jZZGtvSM,36708
-uiprotect/cli/base.py,sha256=zpTm2kyJe_GLixnv3Uadke__iRLh64AEwQzp-2hqS7g,7730
+uiprotect/cli/base.py,sha256=k-_qGuNT7br0iV0KE5F4wYXF75iyLLjBEckTqxC71xM,7591
 uiprotect/cli/cameras.py,sha256=YvvMccQEYG3Wih0Ix8tan1R1vfaJ6cogg6YKWLzMUV8,16973
 uiprotect/cli/chimes.py,sha256=XANn21bQVkestkKOm9HjxSM8ZGrRrqvUXLouaQ3LTqs,5326
 uiprotect/cli/doorlocks.py,sha256=Go_Tn68bAcmrRAnUIi4kBiR7ciKQsu_R150ubPTjUAs,3523
@@ -14,13 +14,13 @@ uiprotect/cli/nvr.py,sha256=TwxEg2XT8jXAbOqv6gc7KFXELKadeItEDYweSL4_-e8,4260
 uiprotect/cli/sensors.py,sha256=fQtcDJCVxs4VbAqcavgBy2ABiVxAW3GXtna6_XFBp2k,8153
 uiprotect/cli/viewers.py,sha256=2cyrp104ffIvgT0wYGIO0G35QMkEbFe7fSVqLwDXQYQ,2171
 uiprotect/data/__init__.py,sha256=OcfuJl2qXfHcj_mdnrHhzZ5tEIZrw8auziX5IE7dn-I,2938
-uiprotect/data/base.py,sha256=G9VIZ-ZkG83oxQbnGYrdJlrv0E6atAel90oEshmJiE8,35719
-uiprotect/data/bootstrap.py,sha256=ZieXqE0526F3iRbdJ1pRM6QclSatn_SmecfoOPS3nNg,21922
+uiprotect/data/base.py,sha256=5x4YJjs4gAHKSbHts_BV9e_OYwODRRxn5Zzm35y_KOk,35460
+uiprotect/data/bootstrap.py,sha256=aF6BJ8qgE7sEDsTKPdRXsrMsL_CTmo8Xr-TUNZjfU6I,21810
 uiprotect/data/convert.py,sha256=8h6Il_DhMkPRDPj9F_rA2UZIlTuchS3BQD24peKpk2A,2185
-uiprotect/data/devices.py,sha256=450T-8qXsFad0xNNnXwm3x53e09NT4dgqlefl7lrc2Q,110485
-uiprotect/data/nvr.py,sha256=zCEAI-rKLEpp9P63QDvJi0hGRsuv-PWGssgHw1POYeQ,47648
-uiprotect/data/types.py,sha256=8z8jIoMlfDre7Op1JAN45PLZdAE-4i3gDPSo2uymqu4,17996
-uiprotect/data/user.py,sha256=Wb-ZWSwIJbyUbfVuENtUYbuW-uftHNDcoMH85dvEjkw,7071
+uiprotect/data/devices.py,sha256=A4ambSBi36IT9Sg_88QR0t7r1TrDBjHa4yfN5cdR8-E,110412
+uiprotect/data/nvr.py,sha256=H0QIxwzQZJYGGeGhY_itb-WYqZnaQ_KcTlWTtrc-LLM,47456
+uiprotect/data/types.py,sha256=3CocULpkdTgF4is1nIEDYIlwf2EOkNNM7L4kJ7NkAwM,17654
+uiprotect/data/user.py,sha256=YvgXJKV4_y-bm0eySWz9f_ie9aR5lpVn17t9H0Pix8I,6998
 uiprotect/data/websocket.py,sha256=vnn3FUc1H3e4dvA3INGob_asbmVCaA99H1DnwDEmpdw,6709
 uiprotect/exceptions.py,sha256=kgn0cRM6lTtgLza09SDa3ZiX6ue1QqHCOogQ4qu6KTQ,965
 uiprotect/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -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=kVRJwvHP683Sjhi2pnxwCwbaRl_uMQ2qFYSvt9kpfoU,18426
+uiprotect/utils.py,sha256=3SJFF8qs1Jz8t3mD8qwc1hFSocolFjdXI_v4yVlC7o4,20088
 uiprotect/websocket.py,sha256=JHI_2EZeRPqPyQopsBZS0dr3tu0HaTiqeLazfBXhW_8,7339
-uiprotect-1.19.2.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
-uiprotect-1.19.2.dist-info/METADATA,sha256=T918SdgoHGWjrbbCtfLNB4rq6ORitfu0Unfzv5YBPBQ,10983
-uiprotect-1.19.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-uiprotect-1.19.2.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
-uiprotect-1.19.2.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,,