uiprotect 6.8.0__tar.gz → 7.0.0__tar.gz

{uiprotect-6.8.0 → uiprotect-7.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiprotect
-Version: 6.8.0
+Version: 7.0.0
 Summary: Python API for Unifi Protect (Unofficial)
 Home-page: https://github.com/uilibs/uiprotect
 Author: UI Protect Maintainers
@@ -29,7 +29,8 @@ Requires-Dist: packaging (>=23)
 Requires-Dist: pillow (>=10)
 Requires-Dist: platformdirs (>=4)
 Requires-Dist: propcache (>=0.0.0)
-Requires-Dist: pydantic (>=1.10.17)
+Requires-Dist: pydantic (>=2.10.0)
+Requires-Dist: pydantic-extra-types (>=2.10.1)
 Requires-Dist: pyjwt (>=2.6)
 Requires-Dist: rich (>=10)
 Requires-Dist: typer (>=0.12.3)

{uiprotect-6.8.0 → uiprotect-7.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uiprotect"
-version = "6.8.0"
+version = "7.0.0"
 description = "Python API for Unifi Protect (Unofficial)"
 authors = ["UI Protect Maintainers <ui@koston.org>"]
 readme = "README.md"
@@ -41,12 +41,13 @@ orjson = ">=3.9.15"
 packaging = ">=23"
 pillow = ">=10"
 platformdirs = ">=4"
-pydantic = "!=1.9.1,>=1.10.17"
+pydantic = ">=2.10.0"
 pyjwt = ">=2.6"
 yarl = ">=1.9"
 typer = ">=0.12.3"
 convertertools = ">=0.5.0"
 propcache = ">=0.0.0"
+pydantic-extra-types = ">=2.10.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7,<9"

{uiprotect-6.8.0 → uiprotect-7.0.0}/src/uiprotect/cli/base.py

@@ -7,7 +7,7 @@ from typing import Any, Optional, TypeVar
 
 import orjson
 import typer
-from pydantic.v1 import ValidationError
+from pydantic import ValidationError
 
 from ..api import ProtectApiClient
 from ..data import NVR, ProtectAdoptableDeviceModel, ProtectBaseObject

{uiprotect-6.8.0 → uiprotect-7.0.0}/src/uiprotect/data/base.py

@@ -12,8 +12,8 @@ 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
+from pydantic import BaseModel, ConfigDict
+from pydantic.fields import PrivateAttr
 
 from .._compat import cached_property
 from ..exceptions import BadRequest, ClientError, NotAuthorized
@@ -27,11 +27,14 @@ from ..utils import (
     to_snake_case,
 )
 from .types import (
+    SHAPE_DICT_V1,
+    SHAPE_LIST_V1,
     ModelType,
     PercentFloat,
     PermissionNode,
     ProtectWSPayloadFormat,
     StateType,
+    extract_type_shape,
 )
 from .websocket import (
     WSJSONPacketFrame,
@@ -62,7 +65,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)
 
@@ -93,12 +96,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:
         """
@@ -219,15 +218,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_
+                type_, shape = extract_type_shape(field.annotation)  # type: ignore[arg-type]
+                if _is_protect_base_object(type_):
+                    if shape == SHAPE_LIST_V1:
+                        lists[name] = type_
+                    elif shape == SHAPE_DICT_V1:
+                        dicts[name] = type_
                     else:
-                        objs[name] = field.type_
+                        objs[name] = type_
             except TypeError:
                 pass
 
@@ -313,8 +313,8 @@ class ProtectBaseObject(BaseModel):
 
         remaps = cls._get_unifi_remaps()
         # convert to snake_case and remove extra fields
-        _fields = cls.__fields__
-        for key in list(data):
+        _fields = cls.model_fields
+        for key in data.copy():
             if key in remaps:
                 # remap keys that will not be converted correctly by snake_case convert
                 remapped_key = remaps[key]
@@ -437,7 +437,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
 
         (
@@ -490,7 +490,7 @@ class ProtectBaseObject(BaseModel):
             has_unifi_dicts,
         ) = cls._get_protect_model()
         api = cls._api
-        _fields = cls.__fields__
+        _fields = cls.model_fields
         unifi_obj: ProtectBaseObject | None
         value: Any
 
@@ -517,10 +517,10 @@ class ProtectBaseObject(BaseModel):
     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:
@@ -540,7 +540,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
@@ -579,7 +579,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)
@@ -794,15 +794,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
 
@@ -853,12 +853,12 @@ class ProtectDeviceModel(ProtectModelWithId):
 
 
 class WiredConnectionState(ProtectBaseObject):
-    phy_rate: float | None
+    phy_rate: int | 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):
@@ -866,10 +866,10 @@ class BluetoothConnectionState(WirelessConnectionState):
 
 
 class WifiConnectionState(WirelessConnectionState):
-    phy_rate: float | None
-    channel: int | None
-    frequency: int | None
-    ssid: str | None
+    phy_rate: int | 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+
@@ -881,10 +881,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 | 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
@@ -894,7 +894,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+
@@ -909,8 +909,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
@@ -1051,7 +1051,7 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
 
 
 class ProtectMotionDeviceModel(ProtectAdoptableDeviceModel):
-    last_motion: datetime | None
+    last_motion: datetime | None = None
     is_dark: bool
 
     # not directly from UniFi

{uiprotect-6.8.0 → uiprotect-7.0.0}/src/uiprotect/data/bootstrap.py

@@ -10,7 +10,7 @@ from typing import TYPE_CHECKING, Any, cast
 
 from aiohttp.client_exceptions import ServerDisconnectedError
 from convertertools import pop_dict_set, pop_dict_tuple
-from pydantic.v1 import PrivateAttr, ValidationError
+from pydantic import PrivateAttr, ValidationError
 
 from ..exceptions import ClientError
 from ..utils import normalize_mac, to_snake_case, utc_now
@@ -362,7 +362,7 @@ class Bootstrap(ProtectBaseObject):
         return WSSubscriptionMessage(
             action=WSAction.ADD,
             new_update_id=self.last_update_id,
-            changed_data=obj.dict(),
+            changed_data=obj.model_dump(),
             new_obj=obj,
         )
 
@@ -407,7 +407,7 @@ class Bootstrap(ProtectBaseObject):
             return WSSubscriptionMessage(
                 action=WSAction.ADD,
                 new_update_id=self.last_update_id,
-                changed_data=add_obj.dict(),
+                changed_data=add_obj.model_dump(),
                 new_obj=add_obj,
             )
         elif action_type == "remove":

{uiprotect-6.8.0 → uiprotect-7.0.0}/src/uiprotect/data/devices.py

@@ -13,7 +13,7 @@ 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 pydantic.fields import PrivateAttr
 
 from ..exceptions import BadRequest, NotAuthorized, StreamError
 from ..stream import TalkbackStream
@@ -123,7 +123,7 @@ class Light(ProtectMotionDeviceModel):
     light_device_settings: LightDeviceSettings
     light_on_settings: LightOnSettings
     light_mode_settings: LightModeSettings
-    camera_id: str | None
+    camera_id: str | None = None
     is_camera_paired: bool
 
     @classmethod
@@ -245,15 +245,15 @@ class CameraChannel(ProtectBaseObject):
     name: str  # read only
     enabled: bool  # read only
     is_rtsp_enabled: bool
-    rtsp_alias: str | None  # read only
+    rtsp_alias: str | None = None  # read only
     width: int
     height: int
     fps: int
     bitrate: int
     min_bitrate: int  # read only
     max_bitrate: int  # read only
-    min_client_adaptive_bit_rate: int | None  # read only
-    min_motion_adaptive_bit_rate: int | None  # read only
+    min_client_adaptive_bit_rate: int | None = None  # read only
+    min_motion_adaptive_bit_rate: int | None = None  # read only
     fps_values: list[int]  # read only
     idr_interval: int
     # 3.0.22+
@@ -325,8 +325,8 @@ class ISPSettings(ProtectBaseObject):
     d_zoom_stream_id: int
     focus_mode: FocusMode | None = None
     focus_position: int
-    touch_focus_x: int | None
-    touch_focus_y: int | None
+    touch_focus_x: int | None = None
+    touch_focus_y: int | None = None
     zoom_position: PercentInt
     mount_position: MountPosition | None = None
     # requires 2.8.14+
@@ -545,8 +545,8 @@ class TalkbackSettings(ProtectBaseObject):
     type_in: str
     bind_addr: IPv4Address
     bind_port: int
-    filter_addr: str | None  # can be used to restrict sender address
-    filter_port: int | None  # can be used to restrict sender port
+    filter_addr: str | None = None  # can be used to restrict sender address
+    filter_port: int | None = None  # can be used to restrict sender port
     channels: int  # 1 or 2
     sampling_rate: int  # 8000, 11025, 22050, 44100, 48000
     bits_per_sample: int
@@ -554,22 +554,22 @@ class TalkbackSettings(ProtectBaseObject):
 
 
 class WifiStats(ProtectBaseObject):
-    channel: int | None
-    frequency: int | None
-    link_speed_mbps: str | None
+    channel: int | None = None
+    frequency: int | None = None
+    link_speed_mbps: str | None = None
     signal_quality: PercentInt
     signal_strength: int
 
 
 class VideoStats(ProtectBaseObject):
-    recording_start: datetime | None
-    recording_end: datetime | None
-    recording_start_lq: datetime | None
-    recording_end_lq: datetime | None
-    timelapse_start: datetime | None
-    timelapse_end: datetime | None
-    timelapse_start_lq: datetime | None
-    timelapse_end_lq: datetime | None
+    recording_start: datetime | None = None
+    recording_end: datetime | None = None
+    recording_start_lq: datetime | None = None
+    recording_end_lq: datetime | None = None
+    timelapse_start: datetime | None = None
+    timelapse_end: datetime | None = None
+    timelapse_start_lq: datetime | None = None
+    timelapse_end_lq: datetime | None = None
 
     @classmethod
     @cache
@@ -601,8 +601,8 @@ class VideoStats(ProtectBaseObject):
 
 
 class StorageStats(ProtectBaseObject):
-    used: int | None  # bytes
-    rate: float | None  # bytes / millisecond
+    used: int | None = None  # bytes
+    rate: float | None = None  # bytes / millisecond
 
     @property
     def rate_per_second(self) -> float | None:
@@ -633,7 +633,7 @@ class CameraStats(ProtectBaseObject):
     tx_bytes: int
     wifi: WifiStats
     video: VideoStats
-    storage: StorageStats | None
+    storage: StorageStats | None = None
     wifi_quality: PercentInt
     wifi_strength: int
 
@@ -708,7 +708,7 @@ class SmartMotionZone(MotionZone):
 
 
 class PrivacyMaskCapability(ProtectBaseObject):
-    max_masks: int | None
+    max_masks: int | None = None
     rectangle_only: bool
 
 
@@ -735,9 +735,9 @@ class Hotplug(ProtectBaseObject):
 
 
 class PTZRangeSingle(ProtectBaseObject):
-    max: float | None
-    min: float | None
-    step: float | None
+    max: float | None = None
+    min: float | None = None
+    step: float | None = None
 
 
 class PTZRange(ProtectBaseObject):
@@ -771,7 +771,7 @@ class PTZRange(ProtectBaseObject):
 
 
 class PTZZoomRange(PTZRange):
-    ratio: float
+    ratio: int
 
     def to_native_value(self, zoom_value: float, is_relative: bool = False) -> float:
         """Convert zoom values to step values."""
@@ -921,13 +921,13 @@ class Camera(ProtectMotionDeviceModel):
     is_recording: bool
     is_motion_detected: bool
     is_smart_detected: bool
-    phy_rate: float | None
+    phy_rate: int | None = None
     hdr_mode: bool
     # Recording Quality -> High Frame
     video_mode: VideoMode
     is_probing_for_wifi: bool
     chime_duration: timedelta
-    last_ring: datetime | None
+    last_ring: datetime | None = None
     is_live_heatmap_enabled: bool
     video_reconfiguration_in_progress: bool
     channels: list[CameraChannel]
@@ -943,7 +943,7 @@ class Camera(ProtectMotionDeviceModel):
     smart_detect_zones: list[SmartMotionZone]
     stats: CameraStats
     feature_flags: CameraFeatureFlags
-    lcd_message: LCDMessage | None
+    lcd_message: LCDMessage | None = None
     lenses: list[CameraLenses]
     platform: str
     has_speaker: bool
@@ -951,10 +951,10 @@ class Camera(ProtectMotionDeviceModel):
     audio_bitrate: int
     can_manage: bool
     is_managed: bool
-    voltage: float | None
+    voltage: float | None = None
     # requires 1.21+
-    is_poor_network: bool | None
-    is_wireless_uplink_enabled: bool | None
+    is_poor_network: bool | None = None
+    is_wireless_uplink_enabled: bool | None = None
     # requires 2.6.13+
     homekit_settings: CameraHomekitSettings | None = None
     # requires 2.6.17+
@@ -1118,7 +1118,7 @@ class Camera(ProtectMotionDeviceModel):
                 updated["lcd_message"] = {"reset_at": utc_now() - timedelta(seconds=10)}
             # otherwise, pass full LCD message to prevent issues
             elif self.lcd_message is not None:
-                updated["lcd_message"] = self.lcd_message.dict()
+                updated["lcd_message"] = self.lcd_message.model_dump()
 
             # if reset_at is not passed in, it will default to reset in 1 minute
             if lcd_message is not None and "reset_at" not in lcd_message:
@@ -2771,8 +2771,8 @@ class SensorThresholdSettings(SensorSettingsBase):
     margin: float  # read only
     # "safe" thresholds for alerting
     # anything below/above will trigger alert
-    low_threshold: float | None
-    high_threshold: float | None
+    low_threshold: float | None = None
+    high_threshold: float | None = None
 
 
 class SensorSensitivitySettings(SensorSettingsBase):
@@ -2780,12 +2780,12 @@ class SensorSensitivitySettings(SensorSettingsBase):
 
 
 class SensorBatteryStatus(ProtectBaseObject):
-    percentage: PercentInt | None
+    percentage: PercentInt | None = None
     is_low: bool
 
 
 class SensorStat(ProtectBaseObject):
-    value: float | None
+    value: float | None = None
     status: SensorStatusType
 
 
@@ -2797,20 +2797,20 @@ class SensorStats(ProtectBaseObject):
 
 class Sensor(ProtectAdoptableDeviceModel):
     alarm_settings: SensorSettingsBase
-    alarm_triggered_at: datetime | None
+    alarm_triggered_at: datetime | None = None
     battery_status: SensorBatteryStatus
-    camera_id: str | None
+    camera_id: str | None = None
     humidity_settings: SensorThresholdSettings
     is_motion_detected: bool
     is_opened: bool
-    leak_detected_at: datetime | None
+    leak_detected_at: datetime | None = None
     led_settings: SensorSettingsBase
     light_settings: SensorThresholdSettings
-    motion_detected_at: datetime | None
+    motion_detected_at: datetime | None = None
     motion_settings: SensorSensitivitySettings
-    open_status_changed_at: datetime | None
+    open_status_changed_at: datetime | None = None
     stats: SensorStats
-    tampering_detected_at: datetime | None
+    tampering_detected_at: datetime | None = None
     temperature_settings: SensorThresholdSettings
     mount_type: MountType
 
@@ -3104,13 +3104,13 @@ class Sensor(ProtectAdoptableDeviceModel):
 
 
 class Doorlock(ProtectAdoptableDeviceModel):
-    credentials: str | None
+    credentials: str | None = None
     lock_status: LockStatusType
     enable_homekit: bool
     auto_close_time: timedelta
     led_settings: SensorSettingsBase
     battery_status: SensorBatteryStatus
-    camera_id: str | None
+    camera_id: str | None = None
     has_homekit: bool
     private_token: str
 
@@ -3247,7 +3247,7 @@ class ChimeTrack(ProtectBaseObject):
 class Chime(ProtectAdoptableDeviceModel):
     volume: PercentInt
     is_probing_for_wifi: bool
-    last_ring: datetime | None
+    last_ring: datetime | None = None
     is_wireless_uplink_enabled: bool
     camera_ids: list[str]
     # requires 2.6.17+

{uiprotect-6.8.0 → uiprotect-7.0.0}/src/uiprotect/data/nvr.py

@@ -17,7 +17,7 @@ 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 pydantic.fields import PrivateAttr
 
 from ..exceptions import BadRequest, NotAuthorized
 from ..utils import RELEASE_CACHE, convert_to_datetime
@@ -61,7 +61,7 @@ from .types import (
 from .user import User, UserLocation
 
 if TYPE_CHECKING:
-    from pydantic.v1.typing import SetStr
+    from pydantic.typing import SetStr
 
 
 _LOGGER = logging.getLogger(__name__)
@@ -181,7 +181,7 @@ class EventDetectedThumbnail(ProtectBaseObject):
     type: str
     cropped_id: str
     attributes: EventThumbnailAttributes | None = None
-    name: str | None
+    name: str | None = None
 
     @classmethod
     @cache
@@ -199,24 +199,24 @@ class EventDetectedThumbnail(ProtectBaseObject):
 
 
 class EventMetadata(ProtectBaseObject):
-    client_platform: str | None
-    reason: str | None
-    app_update: str | None
-    light_id: str | None
-    light_name: str | None
-    type: str | None
-    sensor_id: str | None
-    sensor_name: str | None
-    sensor_type: SensorType | None
-    doorlock_id: str | None
-    doorlock_name: str | None
-    from_value: str | None
-    to_value: str | None
-    mount_type: MountType | None
-    status: SensorStatusType | None
-    alarm_type: str | None
-    device_id: str | None
-    mac: str | None
+    client_platform: str | None = None
+    reason: str | None = None
+    app_update: str | None = None
+    light_id: str | None = None
+    light_name: str | None = None
+    type: str | None = None
+    sensor_id: str | None = None
+    sensor_name: str | None = None
+    sensor_type: SensorType | None = None
+    doorlock_id: str | None = None
+    doorlock_name: str | None = None
+    from_value: str | None = None
+    to_value: str | None = None
+    mount_type: MountType | None = None
+    status: SensorStatusType | None = None
+    alarm_type: str | None = None
+    device_id: str | None = None
+    mac: str | None = None
     # require 2.7.5+
     license_plate: LicensePlateMetadata | None = None
     # requires 2.11.13+
@@ -281,16 +281,16 @@ class EventMetadata(ProtectBaseObject):
 class Event(ProtectModelWithId):
     type: EventType
     start: datetime
-    end: datetime | None
+    end: datetime | None = None
     score: int
-    heatmap_id: str | None
-    camera_id: str | None
+    heatmap_id: str | None = None
+    camera_id: str | None = None
     smart_detect_types: list[SmartDetectObjectType]
     smart_detect_event_ids: list[str]
-    thumbnail_id: str | None
-    user_id: str | None
-    timestamp: datetime | None
-    metadata: EventMetadata | None
+    thumbnail_id: str | None = None
+    user_id: str | None = None
+    timestamp: datetime | None = None
+    metadata: EventMetadata | None = None
     # requires 2.7.5+
     deleted_at: datetime | None = None
     deletion_type: Literal["manual", "automatic"] | None = None
@@ -551,9 +551,9 @@ class CPUInfo(ProtectBaseObject):
 
 
 class MemoryInfo(ProtectBaseObject):
-    available: int | None
-    free: int | None
-    total: int | None
+    available: int | None = None
+    free: int | None = None
+    total: int | None = None
 
 
 class StorageDevice(ProtectBaseObject):
@@ -868,8 +868,8 @@ class StorageDistribution(ProtectBaseObject):
 
 class StorageStats(ProtectBaseObject):
     utilization: float
-    capacity: timedelta | None
-    remaining_capacity: timedelta | None
+    capacity: timedelta | None = None
+    remaining_capacity: timedelta | None = None
     recording_space: StorageSpace
     storage_distribution: StorageDistribution
 
@@ -916,7 +916,7 @@ class NVR(ProtectDeviceModel):
     ucore_version: str
     hardware_platform: str
     ports: PortConfig
-    last_update_at: datetime | None
+    last_update_at: datetime | None = None
     is_station: bool
     enable_automatic_backups: bool
     enable_stats_reporting: bool
@@ -927,14 +927,14 @@ class NVR(ProtectDeviceModel):
     host_type: int
     host_shortname: str
     is_hardware: bool
-    is_wireless_uplink_enabled: bool | None
+    is_wireless_uplink_enabled: bool | None = None
     time_format: Literal["12h", "24h"]
     temperature_unit: Literal["C", "F"]
-    recording_retention_duration: timedelta | None
+    recording_retention_duration: timedelta | None = None
     enable_crash_reporting: bool
     disable_audio: bool
     analytics_data: AnalyticsOption
-    anonymous_device_id: UUID | None
+    anonymous_device_id: UUID | None = None
     camera_utilization: int
     is_recycling: bool
     disable_auto_link: bool

{uiprotect-6.8.0 → uiprotect-7.0.0}/src/uiprotect/data/types.py

@@ -2,13 +2,18 @@ from __future__ import annotations
 
 import enum
 from collections.abc import Callable, Coroutine
-from functools import cache
-from typing import Any, Literal, Optional, TypeVar, Union
+from functools import cache, lru_cache
+from typing import Annotated, Any, Literal, Optional, TypeVar, Union
 
 from packaging.version import Version as BaseVersion
-from pydantic.v1 import BaseModel, ConstrainedInt
-from pydantic.v1.color import Color as BaseColor
-from pydantic.v1.types import ConstrainedFloat, ConstrainedStr
+from pydantic import BaseModel, Field
+from pydantic.types import StringConstraints
+from pydantic.v1.config import BaseConfig as BaseConfigV1
+from pydantic.v1.fields import SHAPE_DICT as SHAPE_DICT_V1  # noqa: F401
+from pydantic.v1.fields import SHAPE_LIST as SHAPE_LIST_V1  # noqa: F401
+from pydantic.v1.fields import SHAPE_SET as SHAPE_SET_V1  # noqa: F401
+from pydantic.v1.fields import ModelField as ModelFieldV1
+from pydantic_extra_types.color import Color  # noqa: F401
 
 from .._compat import cached_property
 
@@ -16,6 +21,22 @@ KT = TypeVar("KT")
 VT = TypeVar("VT")
 
 
+class _BaseConfigV1(BaseConfigV1):
+    arbitrary_types_allowed = True
+    validate_assignment = True
+
+
+@lru_cache(maxsize=512)
+def extract_type_shape(annotation: type[Any] | None) -> tuple[Any, int]:
+    """Extract the type from a type hint."""
+    if annotation is None:
+        raise ValueError("Type annotation cannot be None")
+    v1_field = ModelFieldV1(
+        name="", type_=annotation, class_validators=None, model_config=_BaseConfigV1
+    )
+    return v1_field.type_, v1_field.shape
+
+
 DEFAULT = "DEFAULT_VALUE"
 DEFAULT_TYPE = Literal["DEFAULT_VALUE"]
 EventCategories = Literal[
@@ -626,58 +647,27 @@ class LensType(str, enum.Enum):
     DLSR_17 = "m43"
 
 
-class DoorbellText(ConstrainedStr):
-    max_length = 30
-
-
-class ICRCustomValue(ConstrainedInt):
-    ge = 0
-    le = 10
-
-
-class ICRLuxValue(ConstrainedInt):
-    ge = 1
-    le = 30
-
+DoorbellText = Annotated[str, StringConstraints(max_length=30)]
 
-class LEDLevel(ConstrainedInt):
-    ge = 0
-    le = 6
+ICRCustomValue = Annotated[int, Field(ge=0, le=10)]
 
+ICRLuxValue = Annotated[int, Field(ge=1, le=30)]
 
-class PercentInt(ConstrainedInt):
-    ge = 0
-    le = 100
+LEDLevel = Annotated[int, Field(ge=0, le=6)]
 
+PercentInt = Annotated[int, Field(ge=0, le=100)]
 
-class TwoByteInt(ConstrainedInt):
-    ge = 1
-    le = 255
+TwoByteInt = Annotated[int, Field(ge=1, le=255)]
 
+PercentFloat = Annotated[float, Field(ge=0, le=100)]
 
-class PercentFloat(ConstrainedFloat):
-    ge = 0
-    le = 100
+WDRLevel = Annotated[int, Field(ge=0, le=3)]
 
+ICRSensitivity = Annotated[int, Field(ge=0, le=3)]
 
-class WDRLevel(ConstrainedInt):
-    ge = 0
-    le = 3
+Percent = Annotated[float, Field(ge=0, le=1)]
 
-
-class ICRSensitivity(ConstrainedInt):
-    ge = 0
-    le = 3
-
-
-class Percent(ConstrainedFloat):
-    ge = 0
-    le = 1
-
-
-class RepeatTimes(ConstrainedInt):
-    ge = 1
-    le = 6
+RepeatTimes = Annotated[int, Field(ge=1, le=6)]
 
 
 class PTZPositionDegree(BaseModel):
@@ -714,15 +704,6 @@ class PTZPreset(BaseModel):
 CoordType = Union[Percent, int, float]
 
 
-# TODO: fix when upgrading to pydantic v2
-class Color(BaseColor):
-    def __eq__(self, o: object) -> bool:
-        if isinstance(o, Color):
-            return self.as_hex() == o.as_hex()
-
-        return super().__eq__(o)
-
-
 class Version(BaseVersion):
     def __str__(self) -> str:
         super_str = super().__str__()

{uiprotect-6.8.0 → uiprotect-7.0.0}/src/uiprotect/data/user.py

@@ -8,7 +8,7 @@ from datetime import datetime
 from functools import cache
 from typing import TYPE_CHECKING, Any, Generic, TypeVar
 
-from pydantic.v1.fields import PrivateAttr
+from pydantic.fields import PrivateAttr
 
 from .base import ProtectBaseObject, ProtectModel, ProtectModelWithId
 from .types import ModelType, PermissionNode
@@ -23,7 +23,7 @@ class Permission(ProtectBaseObject):
     raw_permission: str
     model: ModelType
     nodes: set[PermissionNode]
-    obj_ids: set[str] | None
+    obj_ids: set[str] | None = None
 
     @classmethod
     def unifi_dict_to_dict(cls, data: dict[str, Any]) -> dict[str, Any]:
@@ -79,8 +79,8 @@ class Group(ProtectModelWithId):
 
 class UserLocation(ProtectModel):
     is_away: bool
-    latitude: float | None
-    longitude: float | None
+    latitude: float | None = None
+    longitude: float | None = None
 
 
 class CloudAccount(ProtectModelWithId):
@@ -89,7 +89,7 @@ class CloudAccount(ProtectModelWithId):
     email: str
     user_id: str
     name: str
-    location: UserLocation | None
+    location: UserLocation | None = None
     profile_img: str | None = None
 
     @classmethod
@@ -123,21 +123,21 @@ class UserFeatureFlags(ProtectBaseObject):
 
 class User(ProtectModelWithId):
     permissions: list[Permission]
-    last_login_ip: str | None
-    last_login_time: datetime | None
+    last_login_ip: str | None = None
+    last_login_time: datetime | None = None
     is_owner: bool
     enable_notifications: bool
     has_accepted_invite: bool
     all_permissions: list[Permission]
     scopes: list[str] | None = None
-    location: UserLocation | None
+    location: UserLocation | None = None
     name: str
     first_name: str
     last_name: str
-    email: str | None
+    email: str | None = None
     local_username: str
     group_ids: list[str]
-    cloud_account: CloudAccount | None
+    cloud_account: CloudAccount | None = None
     feature_flags: UserFeatureFlags
 
     # TODO:

{uiprotect-6.8.0 → uiprotect-7.0.0}/src/uiprotect/utils.py

@@ -29,15 +29,18 @@ 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 pydantic.fields import FieldInfo
 
 from .data.types import (
+    SHAPE_DICT_V1,
+    SHAPE_LIST_V1,
+    SHAPE_SET_V1,
     Color,
     SmartDetectAudioType,
     SmartDetectObjectType,
     Version,
     VideoMode,
+    extract_type_shape,
 )
 from .exceptions import NvrError
 
@@ -88,6 +91,11 @@ IP_TYPES = {
 }
 
 
+@lru_cache
+def to_camel(string: str) -> str:
+    return "".join(word.capitalize() for word in string.split("_"))
+
+
 def set_debug() -> None:
     """Sets ENV variable for UFP_DEBUG to on (True)"""
     os.environ[DEBUG_ENV] = str(True)
@@ -202,22 +210,22 @@ def to_camel_case(name: str) -> str:
 
 
 _EMPTY_UUID = UUID("0" * 32)
-_SHAPE_TYPES = {SHAPE_DICT, SHAPE_LIST, SHAPE_SET}
+_SHAPE_TYPES = {SHAPE_DICT_V1, SHAPE_SET_V1, SHAPE_LIST_V1}
 
 
-def convert_unifi_data(value: Any, field: ModelField) -> Any:
+def convert_unifi_data(value: Any, field: FieldInfo) -> Any:
     """Converts value from UFP data into pydantic field class"""
-    type_ = field.type_
+    type_, shape = extract_type_shape(field.annotation)  # type: ignore[arg-type]
 
     if type_ is Any:
         return value
 
-    if (shape := field.shape) in _SHAPE_TYPES:
-        if shape == SHAPE_LIST and isinstance(value, list):
+    if shape in _SHAPE_TYPES:
+        if shape == SHAPE_LIST_V1 and isinstance(value, list):
             return [convert_unifi_data(v, field) for v in value]
-        if shape == SHAPE_SET and isinstance(value, list):
+        if shape == SHAPE_SET_V1 and isinstance(value, list):
             return {convert_unifi_data(v, field) for v in value}
-        if shape == SHAPE_DICT and isinstance(value, dict):
+        if shape == SHAPE_DICT_V1 and isinstance(value, dict):
             return {k: convert_unifi_data(v, field) for k, v in value.items()}
 
     if value is not None:
@@ -298,9 +306,7 @@ def serialize_dict(data: dict[str, Any], levels: int = -1) -> dict[str, Any]:
 
 def serialize_coord(coord: CoordType) -> int | float:
     """Serializes UFP zone coordinate"""
-    from uiprotect.data import Percent
-
-    if not isinstance(coord, Percent):
+    if not isinstance(coord, float):
         return coord
 
     if math.isclose(coord, 0) or math.isclose(coord, 1):