uiprotect 7.14.1__tar.gz → 7.15.0__tar.gz

{uiprotect-7.14.1 → uiprotect-7.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: uiprotect
-Version: 7.14.1
+Version: 7.15.0
 Summary: Python API for Unifi Protect (Unofficial)
 License: MIT
 Author: UI Protect Maintainers
@@ -241,6 +241,8 @@ unsub()
 
 ## TODO / Planned / Not Implemented
 
+Switching from Protect Private API to the New Public API
+
 Generally any feature missing from the library is planned to be done eventually / nice to have with the following exceptions
 
 ### UniFi OS Features

{uiprotect-7.14.1 → uiprotect-7.15.0}/README.md

@@ -198,6 +198,8 @@ unsub()
 
 ## TODO / Planned / Not Implemented
 
+Switching from Protect Private API to the New Public API
+
 Generally any feature missing from the library is planned to be done eventually / nice to have with the following exceptions
 
 ### UniFi OS Features

{uiprotect-7.14.1 → uiprotect-7.15.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uiprotect"
-version = "7.14.1"
+version = "7.15.0"
 license = "MIT"
 description = "Python API for Unifi Protect (Unofficial)"
 authors = [{ name = "UI Protect Maintainers", email = "ui@koston.org" }]

{uiprotect-7.14.1 → uiprotect-7.15.0}/src/uiprotect/api.py

@@ -82,10 +82,7 @@ TOKEN_COOKIE_MAX_EXP_SECONDS = 60
 DEVICE_UPDATE_INTERVAL = 900
 # retry timeout for thumbnails/heatmaps
 RETRY_TIMEOUT = 10
-PROTECT_APT_URLS = [
-    "https://apt.artifacts.ui.com/dists/stretch/release/binary-arm64/Packages",
-    "https://apt.artifacts.ui.com/dists/bullseye/release/binary-arm64/Packages",
-]
+
 TYPES_BUG_MESSAGE = """There is currently a bug in UniFi Protect that makes `start` / `end` not work if `types` is not provided. This means uiprotect has to iterate over all of the events matching the filters provided to return values.
 
 If your Protect instance has a lot of events, this request will take much longer then expected. It is recommended adding additional filters to speed the request up."""
@@ -172,6 +169,7 @@ class BaseApiClient:
     _last_token_cookie: Morsel[str] | None = None
     _last_token_cookie_decode: dict[str, Any] | None = None
     _session: aiohttp.ClientSession | None = None
+    _public_api_session: aiohttp.ClientSession | None = None
     _loaded_session: bool = False
     _cookiename = "TOKEN"
 
@@ -195,6 +193,7 @@ class BaseApiClient:
         api_key: str | None = None,
         verify_ssl: bool = True,
         session: aiohttp.ClientSession | None = None,
+        public_api_session: aiohttp.ClientSession | None = None,
         ws_timeout: int = 30,
         cache_dir: Path | None = None,
         config_dir: Path | None = None,
@@ -221,6 +220,9 @@ class BaseApiClient:
         if session is not None:
             self._session = session
 
+        if public_api_session is not None:
+            self._public_api_session = public_api_session
+
         self._update_url()
 
     def _update_cookiename(self, cookie: SimpleCookie) -> None:
@@ -264,6 +266,15 @@ class BaseApiClient:
 
         return self._session
 
+    async def get_public_api_session(self) -> aiohttp.ClientSession:
+        """Gets or creates current public API client session"""
+        if self._public_api_session is None or self._public_api_session.closed:
+            if self._public_api_session is not None and self._public_api_session.closed:
+                _LOGGER.debug("Public API session was closed, creating a new one")
+            self._public_api_session = aiohttp.ClientSession()
+
+        return self._public_api_session
+
     async def _auth_websocket(self, force: bool) -> dict[str, str] | None:
         """Authenticate for Websocket."""
         if force:
@@ -309,6 +320,12 @@ class BaseApiClient:
             self._session = None
             self._loaded_session = False
 
+    async def close_public_api_session(self) -> None:
+        """Closing and deletes public API client session"""
+        if self._public_api_session is not None:
+            await self._public_api_session.close()
+            self._public_api_session = None
+
     async def _cancel_update_task(self) -> None:
         if self._update_task:
             self._update_task.cancel()
@@ -348,7 +365,11 @@ class BaseApiClient:
         _LOGGER.debug("Request url: %s", request_url)
         if not self._verify_ssl:
             kwargs["ssl"] = False
-        session = await self.get_session()
+
+        if public_api:
+            session = await self.get_public_api_session()
+        else:
+            session = await self.get_session()
 
         for attempt in range(2):
             try:
@@ -780,6 +801,7 @@ class ProtectApiClient(BaseApiClient):
         api_key: str | None = None,
         verify_ssl: bool = True,
         session: aiohttp.ClientSession | None = None,
+        public_api_session: aiohttp.ClientSession | None = None,
         ws_timeout: int = 30,
         cache_dir: Path | None = None,
         config_dir: Path | None = None,
@@ -800,6 +822,7 @@ class ProtectApiClient(BaseApiClient):
             api_key=api_key,
             verify_ssl=verify_ssl,
             session=session,
+            public_api_session=public_api_session,
             ws_timeout=ws_timeout,
             ws_receive_timeout=ws_receive_timeout,
             cache_dir=cache_dir,
@@ -1915,17 +1938,6 @@ class ProtectApiClient(BaseApiClient):
 
         return versions
 
-    async def get_release_versions(self) -> set[Version]:
-        """Get all release versions for UniFi Protect"""
-        versions: set[Version] = set()
-        for url in PROTECT_APT_URLS:
-            try:
-                versions |= await self._get_versions_from_api(url)
-            except NvrError:
-                _LOGGER.warning("Failed to retrieve release versions from online.")
-
-        return versions
-
     async def relative_move_ptz_camera(
         self,
         device_id: str,

{uiprotect-7.14.1 → uiprotect-7.15.0}/src/uiprotect/cli/__init__.py

@@ -13,9 +13,9 @@ from rich.progress import track
 
 from uiprotect.api import MetaInfo, ProtectApiClient
 
-from ..data import Version, WSPacket
+from ..data import WSPacket
 from ..test_util import SampleDataGenerator
-from ..utils import RELEASE_CACHE, get_local_timezone, run_async
+from ..utils import get_local_timezone, run_async
 from ..utils import profile_ws as profile_ws_job
 from .aiports import app as aiports_app
 from .base import CliContext, OutputFormatEnum
@@ -173,6 +173,7 @@ def main(
     async def update() -> None:
         protect._bootstrap = await protect.get_bootstrap()
         await protect.close_session()
+        await protect.close_public_api_session()
 
     run_async(update())
     ctx.obj = CliContext(protect=protect, output_format=output_format)
@@ -286,6 +287,7 @@ def profile_ws(
         unsub()
         await protect.async_disconnect_ws()
         await protect.close_session()
+        await protect.close_public_api_session()
 
     _setup_logger()
 
@@ -314,25 +316,6 @@ def decode_ws_msg(
     typer.echo(orjson.dumps(response).decode("utf-8"))
 
 
-@app.command()
-def release_versions(ctx: typer.Context) -> None:
-    """Updates the release version cache on disk."""
-    protect = cast(ProtectApiClient, ctx.obj.protect)
-
-    async def callback() -> set[Version]:
-        versions = await protect.get_release_versions()
-        await protect.close_session()
-        return versions
-
-    _setup_logger()
-
-    versions = run_async(callback())
-    output = orjson.dumps(sorted([str(v) for v in versions]))
-
-    Path(RELEASE_CACHE).write_bytes(output)
-    typer.echo(output.decode("utf-8"))
-
-
 @app.command()
 def create_api_key(
     ctx: typer.Context,
@@ -344,6 +327,7 @@ def create_api_key(
     async def callback() -> str:
         api_key = await protect.create_api_key(name)
         await protect.close_session()
+        await protect.close_public_api_session()
         return api_key
 
     _setup_logger()
@@ -359,6 +343,7 @@ def get_meta_info(ctx: typer.Context) -> None:
     async def callback() -> MetaInfo:
         meta = await protect.get_meta_info()
         await protect.close_session()
+        await protect.close_public_api_session()
         return meta
 
     _setup_logger()

{uiprotect-7.14.1 → uiprotect-7.15.0}/src/uiprotect/cli/backup.py

@@ -1064,6 +1064,7 @@ async def _events(
     finally:
         _LOGGER.debug("Cleaning up Protect connection/database...")
         await ctx.protect.close_session()
+        await ctx.protect.close_public_api_session()
         await ctx.db_engine.dispose()
 
 

{uiprotect-7.14.1 → uiprotect-7.15.0}/src/uiprotect/cli/base.py

@@ -36,6 +36,7 @@ def run(ctx: typer.Context, func: Coroutine[Any, Any, T]) -> T:
     async def callback() -> T:
         return_value = await func
         await ctx.obj.protect.close_session()
+        await ctx.obj.protect.close_public_api_session()
         return return_value
 
     try:

{uiprotect-7.14.1 → uiprotect-7.15.0}/src/uiprotect/data/bootstrap.py

@@ -680,5 +680,5 @@ class Bootstrap(ProtectBaseObject):
         _LOGGER.debug("Successfully refresh model: %s %s", model_type, device_id)
 
     async def get_is_prerelease(self) -> bool:
-        """Get if current version of Protect is a prerelease version."""
-        return await self.nvr.get_is_prerelease()
+        """[DEPRECATED] Always returns False. Will be removed after HA 2025.8.0."""
+        return False

{uiprotect-7.14.1 → uiprotect-7.15.0}/src/uiprotect/data/nvr.py

@@ -15,12 +15,11 @@ from uuid import UUID
 
 import aiofiles
 import orjson
-from aiofiles import os as aos
 from convertertools import pop_dict_set_if_none, pop_dict_tuple
 from pydantic.fields import PrivateAttr
 
 from ..exceptions import BadRequest, NotAuthorized
-from ..utils import RELEASE_CACHE, convert_to_datetime
+from ..utils import convert_to_datetime
 from .base import (
     ProtectBaseObject,
     ProtectDeviceModel,
@@ -1217,29 +1216,8 @@ class NVR(ProtectDeviceModel):
         return versions
 
     async def get_is_prerelease(self) -> bool:
-        """Get if current version of Protect is a prerelease version."""
-        # only EA versions have `-beta` in versions
-        if self.version.is_prerelease:
-            return True
-
-        # 2.6.14 is an EA version that looks like a release version
-        cache_file_path = self._api.cache_dir / "release_cache.json"
-        versions = await self._read_cache_file(
-            cache_file_path,
-        ) or await self._read_cache_file(RELEASE_CACHE)
-        if versions is None or self.version not in versions:
-            versions = await self._api.get_release_versions()
-            try:
-                _LOGGER.debug("Fetching releases from APT repos...")
-                tmp = self._api.cache_dir / "release_cache.tmp.json"
-                await aos.makedirs(self._api.cache_dir, exist_ok=True)
-                async with aiofiles.open(tmp, "wb") as cache_file:
-                    await cache_file.write(orjson.dumps([str(v) for v in versions]))
-                await aos.rename(tmp, cache_file_path)
-            except Exception:
-                _LOGGER.warning("Failed write cache file.")
-
-        return self.version not in versions
+        """[DEPRECATED] Always returns False. Will be removed after HA 2025.8.0."""
+        return False
 
     async def set_smart_detections(self, value: bool) -> None:
         """Set if smart detections are enabled."""

{uiprotect-7.14.1 → uiprotect-7.15.0}/src/uiprotect/test_util/__init__.py

@@ -142,6 +142,7 @@ class SampleDataGenerator:
 
         if close_session:
             await self.client.close_session()
+            await self.client.close_public_api_session()
 
         await self.write_json_file("sample_constants", self.constants, anonymize=False)
 

{uiprotect-7.14.1 → uiprotect-7.15.0}/src/uiprotect/utils.py

@@ -74,8 +74,6 @@ SNAKE_CASE_MATCH_3 = re.compile("([a-z0-9])([A-Z])")
 
 _LOGGER = logging.getLogger(__name__)
 
-RELEASE_CACHE = Path(__file__).parent / "release_cache.json"
-
 _CREATE_TYPES = {IPv6Address, IPv4Address, UUID, Color, Decimal, Path, Version}
 _BAD_UUID = "00000000-0000-00 0- 000-000000000000"