uiprotect 3.8.0__py3-none-any.whl → 7.32.0__py3-none-any.whl

uiprotect/cli/events.py

@@ -4,7 +4,6 @@ from collections.abc import Callable
 from dataclasses import dataclass
 from datetime import datetime
 from pathlib import Path
-from typing import Optional
 
 import typer
 from rich.progress import Progress
@@ -43,13 +42,13 @@ ALL_COMMANDS: dict[str, Callable[..., None]] = {}
 @app.callback(invoke_without_command=True)
 def main(
     ctx: typer.Context,
-    event_id: Optional[str] = ARG_EVENT_ID,
-    start: Optional[datetime] = OPTION_START,
-    end: Optional[datetime] = OPTION_END,
-    limit: Optional[int] = OPTION_LIMIT,
-    offset: Optional[int] = OPTION_OFFSET,
-    types: Optional[list[d.EventType]] = OPTION_TYPES,
-    smart_types: Optional[list[d.SmartDetectObjectType]] = OPTION_SMART_TYPES,
+    event_id: str | None = ARG_EVENT_ID,
+    start: datetime | None = OPTION_START,
+    end: datetime | None = OPTION_END,
+    limit: int | None = OPTION_LIMIT,
+    offset: int | None = OPTION_OFFSET,
+    types: list[d.EventType] | None = OPTION_TYPES,
+    smart_types: list[d.SmartDetectObjectType] | None = OPTION_SMART_TYPES,
 ) -> None:
     """
     Events CLI.

uiprotect/cli/lights.py

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from datetime import timedelta
-from typing import Optional
 
 import typer
 
@@ -25,7 +24,7 @@ ALL_COMMANDS, DEVICE_COMMANDS = base.init_common_commands(app)
 
 
 @app.callback(invoke_without_command=True)
-def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
+def main(ctx: typer.Context, device_id: str | None = ARG_DEVICE_ID) -> None:
     """
     Lights device CLI.
 
@@ -59,7 +58,7 @@ def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
 
 
 @app.command()
-def camera(ctx: typer.Context, camera_id: Optional[str] = typer.Argument(None)) -> None:
+def camera(ctx: typer.Context, camera_id: str | None = typer.Argument(None)) -> None:
     """Returns or sets tha paired camera for a light."""
     base.require_device_id(ctx)
     obj: Light = ctx.obj.device
@@ -117,3 +116,12 @@ def set_duration(
     obj: Light = ctx.obj.device
 
     base.run(ctx, obj.set_duration(timedelta(seconds=duration)))
+
+
+@app.command()
+def set_flood_light(ctx: typer.Context, enabled: bool) -> None:
+    """Sets flood light (force on) for light device."""
+    base.require_device_id(ctx)
+    obj: Light = ctx.obj.device
+
+    base.run(ctx, obj.set_flood_light(enabled))

uiprotect/cli/liveviews.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional
 
 import typer
 
@@ -24,7 +23,7 @@ class LiveviewContext(base.CliContext):
 
 
 @app.callback(invoke_without_command=True)
-def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
+def main(ctx: typer.Context, device_id: str | None = ARG_DEVICE_ID) -> None:
     """
     Liveviews CLI.
 

uiprotect/cli/sensors.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional
 
 import typer
 
@@ -24,7 +23,7 @@ ALL_COMMANDS, DEVICE_COMMANDS = base.init_common_commands(app)
 
 
 @app.callback(invoke_without_command=True)
-def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
+def main(ctx: typer.Context, device_id: str | None = ARG_DEVICE_ID) -> None:
     """
     Sensors device CLI.
 
@@ -58,7 +57,7 @@ def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
 
 
 @app.command()
-def camera(ctx: typer.Context, camera_id: Optional[str] = typer.Argument(None)) -> None:
+def camera(ctx: typer.Context, camera_id: str | None = typer.Argument(None)) -> None:
     """Returns or sets tha paired camera for a sensor."""
     base.require_device_id(ctx)
     obj: Sensor = ctx.obj.device

uiprotect/cli/viewers.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional
 
 import typer
 
@@ -24,7 +23,7 @@ ALL_COMMANDS, DEVICE_COMMANDS = base.init_common_commands(app)
 
 
 @app.callback(invoke_without_command=True)
-def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
+def main(ctx: typer.Context, device_id: str | None = ARG_DEVICE_ID) -> None:
     """
     Viewers device CLI.
 
@@ -60,7 +59,7 @@ def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
 @app.command()
 def liveview(
     ctx: typer.Context,
-    liveview_id: Optional[str] = typer.Argument(None),
+    liveview_id: str | None = typer.Argument(None),
 ) -> None:
     """Returns or sets the current liveview."""
     base.require_device_id(ctx)

uiprotect/data/__init__.py

@@ -10,6 +10,7 @@ from .base import (
 from .bootstrap import Bootstrap
 from .convert import create_from_unifi_dict
 from .devices import (
+    AiPort,
     Bridge,
     Camera,
     CameraChannel,
@@ -85,6 +86,7 @@ __all__ = [
     "DEFAULT_TYPE",
     "NVR",
     "WS_HEADER_SIZE",
+    "AiPort",
     "AnalyticsOption",
     "AudioStyle",
     "Bootstrap",

uiprotect/data/base.py

@@ -6,14 +6,16 @@ import asyncio
 import logging
 from collections.abc import Callable
 from datetime import datetime, timedelta
-from functools import cache, cached_property
-from ipaddress import IPv4Address
-from typing import TYPE_CHECKING, Any, NamedTuple, TypeVar
+from functools import cache
+from ipaddress import IPv4Address, IPv6Address
+from typing import TYPE_CHECKING, Any, NamedTuple
 from uuid import UUID
 
-from pydantic.v1 import BaseModel
-from pydantic.v1.fields import SHAPE_DICT, SHAPE_LIST, PrivateAttr
+from convertertools import pop_dict_set_if_none, pop_dict_tuple
+from pydantic import BaseModel, ConfigDict
+from pydantic.fields import PrivateAttr
 
+from .._compat import cached_property
 from ..exceptions import BadRequest, ClientError, NotAuthorized
 from ..utils import (
     asyncio_timeout,
@@ -30,6 +32,7 @@ from .types import (
     PermissionNode,
     ProtectWSPayloadFormat,
     StateType,
+    get_field_type,
 )
 from .websocket import (
     WSJSONPacketFrame,
@@ -48,7 +51,6 @@ if TYPE_CHECKING:
     from ..data.user import User
 
 
-ProtectObject = TypeVar("ProtectObject", bound="ProtectBaseObject")
 RECENT_EVENT_MAX = timedelta(seconds=30)
 EVENT_PING_INTERVAL = timedelta(seconds=3)
 EVENT_PING_INTERVAL_SECONDS = EVENT_PING_INTERVAL.total_seconds()
@@ -60,7 +62,7 @@ _LOGGER = logging.getLogger(__name__)
 
 
 @cache
-def _is_protect_base_object(cls: type) -> bool:
+def _is_protect_base_object(cls: type[Any]) -> bool:
     """A cached version of `issubclass(cls, ProtectBaseObject)` to speed up the check."""
     return issubclass(cls, ProtectBaseObject)
 
@@ -91,12 +93,8 @@ class ProtectBaseObject(BaseModel):
     * Provides `.unifi_dict` to convert object back into UFP JSON
     """
 
-    _api: ProtectApiClient = PrivateAttr(None)
-
-    class Config:
-        arbitrary_types_allowed = True
-        validate_assignment = True
-        copy_on_model_validation = "shallow"
+    _api: ProtectApiClient = PrivateAttr(None)  # type: ignore[assignment]
+    model_config = ConfigDict(arbitrary_types_allowed=True, validate_assignment=True)
 
     def __init__(self, api: ProtectApiClient | None = None, **data: Any) -> None:
         """
@@ -136,10 +134,12 @@ class ProtectBaseObject(BaseModel):
             data.pop("api", None)
             return cls(api=api, **data)
 
-        return cls.construct(**data)
+        return cls.model_construct(**data)
 
     @classmethod
-    def construct(cls, _fields_set: set[str] | None = None, **values: Any) -> Self:
+    def model_construct(
+        cls, _fields_set: set[str] | None = None, **values: Any
+    ) -> Self:
         api: ProtectApiClient | None = values.pop("api", None)
         (
             unifi_objs,
@@ -151,19 +151,21 @@ class ProtectBaseObject(BaseModel):
         ) = cls._get_protect_model()
         for key, value in values.items():
             if has_unifi_objs and key in unifi_objs and isinstance(value, dict):
-                values[key] = unifi_objs[key].construct(**value)
+                values[key] = unifi_objs[key].model_construct(**value)
             elif has_unifi_lists and key in unifi_lists and isinstance(value, list):
                 values[key] = [
-                    unifi_lists[key].construct(**v) if isinstance(v, dict) else v
+                    unifi_lists[key].model_construct(**v) if isinstance(v, dict) else v
                     for v in value
                 ]
             elif has_unifi_dicts and key in unifi_dicts and isinstance(value, dict):
                 values[key] = {
-                    k: unifi_dicts[key].construct(**v) if isinstance(v, dict) else v
+                    k: unifi_dicts[key].model_construct(**v)
+                    if isinstance(v, dict)
+                    else v
                     for k, v in value.items()
                 }
 
-        obj = super().construct(_fields_set=_fields_set, **values)
+        obj = super().model_construct(_fields_set=_fields_set, **values)
         if api is not None:
             obj._api = api
 
@@ -217,15 +219,16 @@ class ProtectBaseObject(BaseModel):
         lists: dict[str, type[ProtectBaseObject]] = {}
         dicts: dict[str, type[ProtectBaseObject]] = {}
 
-        for name, field in cls.__fields__.items():
+        for name, field in cls.model_fields.items():
             try:
-                if _is_protect_base_object(field.type_):
-                    if field.shape == SHAPE_LIST:
-                        lists[name] = field.type_
-                    elif field.shape == SHAPE_DICT:
-                        dicts[name] = field.type_
+                origin, type_ = get_field_type(field.annotation)  # type: ignore[arg-type]
+                if _is_protect_base_object(type_):
+                    if origin is list:
+                        lists[name] = type_
+                    elif origin is dict:
+                        dicts[name] = type_
                     else:
-                        objs[name] = field.type_
+                        objs[name] = type_
             except TypeError:
                 pass
 
@@ -311,25 +314,28 @@ class ProtectBaseObject(BaseModel):
 
         remaps = cls._get_unifi_remaps()
         # convert to snake_case and remove extra fields
-        _fields = cls.__fields__
-        for key in list(data):
-            if key in remaps:
+        _fields = cls.model_fields
+        for key in data.copy():
+            current_key = key
+            if current_key in remaps:
                 # remap keys that will not be converted correctly by snake_case convert
-                remapped_key = remaps[key]
-                data[remapped_key] = data.pop(key)
-                key = remapped_key
+                remapped_key = remaps[current_key]
+                data[remapped_key] = data.pop(current_key)
+                current_key = remapped_key
 
-            new_key = to_snake_case(key)
-            data[new_key] = data.pop(key)
-            key = new_key
+            new_key = to_snake_case(current_key)
+            data[new_key] = data.pop(current_key)
+            current_key = new_key
 
-            if key == "api":
+            if current_key == "api":
                 continue
 
-            if key not in _fields:
-                del data[key]
+            if current_key not in _fields:
+                del data[current_key]
                 continue
-            data[key] = convert_unifi_data(data[key], _fields[key])
+            data[current_key] = convert_unifi_data(
+                data[current_key], _fields[current_key]
+            )
 
         if not data:
             return data
@@ -367,7 +373,7 @@ class ProtectBaseObject(BaseModel):
         if isinstance(value, ProtectBaseObject):
             value = value.unifi_dict()
         elif isinstance(value, dict):
-            value = klass.construct({}).unifi_dict(data=value)  # type: ignore[arg-type]
+            value = klass.model_construct({}).unifi_dict(data=value)  # type: ignore[arg-type]
 
         return value
 
@@ -388,7 +394,7 @@ class ProtectBaseObject(BaseModel):
         return [
             item.unifi_dict()
             if isinstance(item, ProtectBaseObject)
-            else klass.construct({}).unifi_dict(data=item)  # type: ignore[arg-type]
+            else klass.model_construct({}).unifi_dict(data=item)  # type: ignore[arg-type]
             for item in value
         ]
 
@@ -435,7 +441,7 @@ class ProtectBaseObject(BaseModel):
             excluded_fields = self._get_excluded_fields()
             if exclude is not None:
                 excluded_fields = excluded_fields.copy() | exclude
-            data = self.dict(exclude=excluded_fields)
+            data = self.model_dump(exclude=excluded_fields)
             use_obj = True
 
         (
@@ -472,7 +478,7 @@ class ProtectBaseObject(BaseModel):
 
         return new_data
 
-    def update_from_dict(cls: ProtectObject, data: dict[str, Any]) -> ProtectObject:
+    def update_from_dict(self, data: dict[str, Any]) -> Self:
         """
         Updates current object from a cleaned UFP JSON dict.
 
@@ -484,17 +490,17 @@ class ProtectBaseObject(BaseModel):
             has_unifi_objs,
             unifi_lists,
             has_unifi_lists,
-            unifi_dicts,
-            has_unifi_dicts,
-        ) = cls._get_protect_model()
-        api = cls._api
-        _fields = cls.__fields__
+            _unifi_dicts,
+            _has_unifi_dicts,
+        ) = self._get_protect_model()
+        api = self._api
+        _fields = self.__class__.model_fields
         unifi_obj: ProtectBaseObject | None
         value: Any
 
         for key, item in data.items():
             if has_unifi_objs and key in unifi_objs and isinstance(item, dict):
-                if (unifi_obj := getattr(cls, key)) is not None:
+                if (unifi_obj := getattr(self, key)) is not None:
                     value = unifi_obj.update_from_dict(item)
                 else:
                     value = unifi_objs[key](**item, api=api)
@@ -508,17 +514,17 @@ class ProtectBaseObject(BaseModel):
             else:
                 value = convert_unifi_data(item, _fields[key])
 
-            setattr(cls, key, value)
+            setattr(self, key, value)
 
-        return cls
+        return self
 
     def dict_with_excludes(self) -> dict[str, Any]:
         """Returns a dict of the current object without any UFP objects converted to dicts."""
         excludes = self.__class__._get_excluded_changed_fields()
-        return self.dict(exclude=excludes)
+        return self.model_dump(exclude=excludes)
 
     def get_changed(self, data_before_changes: dict[str, Any]) -> dict[str, Any]:
-        return dict_diff(data_before_changes, self.dict())
+        return dict_diff(data_before_changes, self.model_dump())
 
     @property
     def api(self) -> ProtectApiClient:
@@ -538,7 +544,7 @@ class ProtectModel(ProtectBaseObject):
     automatically decoding a `modelKey` object into the correct UFP object and type
     """
 
-    model: ModelType | None
+    model: ModelType | None = None
 
     @classmethod
     @cache
@@ -551,10 +557,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
 
 
@@ -580,7 +583,7 @@ class UpdateSynchronization:
 class ProtectModelWithId(ProtectModel):
     id: str
 
-    _update_sync: UpdateSynchronization = PrivateAttr(None)
+    _update_sync: UpdateSynchronization = PrivateAttr(None)  # type: ignore[assignment]
 
     def __init__(self, **data: Any) -> None:
         update_sync = data.pop("update_sync", None)
@@ -588,9 +591,11 @@ class ProtectModelWithId(ProtectModel):
         self._update_sync = update_sync or UpdateSynchronization()
 
     @classmethod
-    def construct(cls, _fields_set: set[str] | None = None, **values: Any) -> Self:
+    def model_construct(
+        cls, _fields_set: set[str] | None = None, **values: Any
+    ) -> Self:
         update_sync = values.pop("update_sync", None)
-        obj = super().construct(_fields_set=_fields_set, **values)
+        obj = super().model_construct(_fields_set=_fields_set, **values)
         obj._update_sync = update_sync or UpdateSynchronization()
         return obj
 
@@ -716,9 +721,9 @@ class ProtectModelWithId(ProtectModel):
             updated,
         )
 
-        assert (
-            self._update_sync.lock.locked()
-        ), "save_device_changes should only be called when the update lock is held"
+        assert self._update_sync.lock.locked(), (
+            "save_device_changes should only be called when the update lock is held"
+        )
         read_only_fields = self.__class__._get_read_only_fields()
 
         if self.model is None:
@@ -795,15 +800,15 @@ class ProtectModelWithId(ProtectModel):
 
 
 class ProtectDeviceModel(ProtectModelWithId):
-    name: str | None
+    name: str | None = None
     type: str
     mac: str
-    host: IPv4Address | str | None
-    up_since: datetime | None
-    uptime: timedelta | None
-    last_seen: datetime | None
-    hardware_revision: str | None
-    firmware_version: str | None
+    host: IPv4Address | str | None = None
+    up_since: datetime | None = None
+    uptime: timedelta | None = None
+    last_seen: datetime | None = None
+    hardware_revision: str | None = None
+    firmware_version: str | None = None
     is_updating: bool
     is_ssh_enabled: bool
 
@@ -854,12 +859,12 @@ class ProtectDeviceModel(ProtectModelWithId):
 
 
 class WiredConnectionState(ProtectBaseObject):
-    phy_rate: float | None
+    phy_rate: float | None = None
 
 
 class WirelessConnectionState(ProtectBaseObject):
-    signal_quality: int | None
-    signal_strength: int | None
+    signal_quality: int | None = None
+    signal_strength: int | None = None
 
 
 class BluetoothConnectionState(WirelessConnectionState):
@@ -867,10 +872,10 @@ class BluetoothConnectionState(WirelessConnectionState):
 
 
 class WifiConnectionState(WirelessConnectionState):
-    phy_rate: float | None
-    channel: int | None
-    frequency: int | None
-    ssid: str | None
+    phy_rate: float | None = None
+    channel: int | None = None
+    frequency: int | None = None
+    ssid: str | None = None
     bssid: str | None = None
     tx_rate: float | None = None
     # requires 2.7.5+
@@ -882,10 +887,10 @@ class WifiConnectionState(WirelessConnectionState):
 
 class ProtectAdoptableDeviceModel(ProtectDeviceModel):
     state: StateType
-    connection_host: IPv4Address | str | None
-    connected_since: datetime | None
-    latest_firmware_version: str | None
-    firmware_build: str | None
+    connection_host: IPv4Address | IPv6Address | str | None = None
+    connected_since: datetime | None = None
+    latest_firmware_version: str | None = None
+    firmware_build: str | None = None
     is_adopting: bool
     is_adopted: bool
     is_adopted_by_other: bool
@@ -895,7 +900,7 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
     is_attempting_to_connect: bool
     is_connected: bool
     # requires 1.21+
-    market_name: str | None
+    market_name: str | None = None
     # requires 2.7.5+
     fw_update_state: str | None = None
     # requires 2.8.14+
@@ -910,8 +915,8 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
     wired_connection_state: WiredConnectionState | None = None
     wifi_connection_state: WifiConnectionState | None = None
     bluetooth_connection_state: BluetoothConnectionState | None = None
-    bridge_id: str | None
-    is_downloading_firmware: bool | None
+    bridge_id: str | None = None
+    is_downloading_firmware: bool | None = None
 
     # TODO:
     # bridgeCandidates
@@ -955,13 +960,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
@@ -1055,7 +1057,7 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
 
 
 class ProtectMotionDeviceModel(ProtectAdoptableDeviceModel):
-    last_motion: datetime | None
+    last_motion: datetime | None = None
     is_dark: bool
 
     # not directly from UniFi
@@ -1072,10 +1074,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