uiprotect 1.19.2__tar.gz → 1.20.0__tar.gz

{uiprotect-1.19.2 → uiprotect-1.20.0}/PKG-INFO

@@ -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 → uiprotect-1.20.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uiprotect"
-version = "1.19.2"
+version = "1.20.0"
 description = "Python API for Unifi Protect (Unofficial)"
 authors = ["UI Protect Maintainers <ui@koston.org>"]
 license = "MIT"
@@ -41,7 +41,7 @@ orjson = ">=3.9.15"
 packaging = ">=23"
 pillow = ">=10"
 platformdirs = ">=4"
-pydantic = "!=1.9.1,>=1.10.13"
+pydantic = "!=1.9.1,>=1.10.17"
 pyjwt = ">=2.6"
 yarl = ">=1.9"
 typer = ">=0.12.3"

uiprotect-1.20.0/src/uiprotect/__init__.py

@@ -0,0 +1,29 @@
+"""Unofficial UniFi Protect Python API and Command Line Interface."""
+
+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-1.19.2 → uiprotect-1.20.0}/src/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-1.19.2 → uiprotect-1.20.0}/src/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-1.19.2 → uiprotect-1.20.0}/src/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-1.19.2 → uiprotect-1.20.0}/src/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-1.19.2 → uiprotect-1.20.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 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-1.19.2 → uiprotect-1.20.0}/src/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-1.19.2 → uiprotect-1.20.0}/src/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-1.19.2 → uiprotect-1.20.0}/src/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/src/uiprotect/__init__.py

@@ -1,13 +0,0 @@
-"""Unofficial UniFi Protect Python API and Command Line Interface."""
-
-from __future__ import annotations
-
-from .api import ProtectApiClient
-from .exceptions import Invalid, NotAuthorized, NvrError
-
-__all__ = [
-    "Invalid",
-    "NotAuthorized",
-    "NvrError",
-    "ProtectApiClient",
-]