uiprotect 2.2.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

uiprotect/api.py

@@ -75,7 +75,6 @@ if sys.version_info[:2] < (3, 13):
 
 TOKEN_COOKIE_MAX_EXP_SECONDS = 60
 
-NEVER_RAN = -1000
 # how many seconds before the bootstrap is refreshed from Protect
 DEVICE_UPDATE_INTERVAL = 900
 # retry timeout for thumbnails/heatmaps
@@ -164,7 +163,6 @@ class BaseApiClient:
     _ws_timeout: int
 
     _is_authenticated: bool = False
-    _last_update: float = NEVER_RAN
     _last_ws_status: bool = False
     _last_token_cookie: Morsel[str] | None = None
     _last_token_cookie_decode: dict[str, Any] | None = None
@@ -289,7 +287,7 @@ class BaseApiClient:
         # since the lastUpdateId is not valid anymore
         if self._update_task and not self._update_task.done():
             return
-        self._update_task = asyncio.create_task(self.update(force=True))
+        self._update_task = asyncio.create_task(self.update())
 
     async def close_session(self) -> None:
         """Closing and deletes client session"""
@@ -699,7 +697,7 @@ class BaseApiClient:
     def _get_last_update_id(self) -> str | None:
         raise NotImplementedError
 
-    async def update(self, force: bool = False) -> Bootstrap | None:
+    async def update(self) -> Bootstrap:
         raise NotImplementedError
 
 
@@ -710,8 +708,7 @@ class ProtectApiClient(BaseApiClient):
     UniFi Protect is a full async application. "normal" use of interacting with it is
     to call `.update()` which will initialize the `.bootstrap` and create a Websocket
     connection to UFP. This Websocket connection will emit messages that will automatically
-    update the `.bootstrap` over time. Caling `.udpate` again (without `force`) will
-    verify the integry of the Websocket connection.
+    update the `.bootstrap` over time.
 
     You can use the `.get_` methods to one off pull devices from the UFP API, but should
     not be used for building an aplication on top of.
@@ -816,32 +813,21 @@ class ProtectApiClient(BaseApiClient):
 
         return self._connection_host
 
-    async def update(self, force: bool = False) -> Bootstrap | None:
+    async def update(self) -> Bootstrap:
         """
-        Updates the state of devices, initalizes `.bootstrap` and
-        connects to UFP Websocket for real time updates
+        Updates the state of devices, initializes `.bootstrap`
+
+        The websocket is auto connected once there are any
+        subscriptions to it. update must be called at least
+        once before subscribing to the websocket.
 
         You can use the various other `get_` methods if you need one off data from UFP
         """
         async with self._update_lock:
-            now = time.monotonic()
-            if force:
-                self._last_update = NEVER_RAN
-
-            bootstrap_updated = False
-            if (
-                self._bootstrap is None
-                or now - self._last_update > DEVICE_UPDATE_INTERVAL
-            ):
-                bootstrap_updated = True
-                self._bootstrap = await self.get_bootstrap()
-                self.__dict__.pop("bootstrap", None)
-                self._last_update = now
-
-            if bootstrap_updated:
-                return None
-            self._last_update = now
-            return self._bootstrap
+            bootstrap = await self.get_bootstrap()
+            self.__dict__.pop("bootstrap", None)
+            self._bootstrap = bootstrap
+            return bootstrap
 
     async def poll_events(self) -> None:
         """Poll for events."""

uiprotect/websocket.py

@@ -19,6 +19,8 @@ from aiohttp import (
 )
 from yarl import URL
 
+from .exceptions import NotAuthorized, NvrError
+
 _LOGGER = logging.getLogger(__name__)
 AuthCallbackType = Callable[..., Coroutine[Any, Any, Optional[dict[str, str]]]]
 GetSessionCallbackType = Callable[[], Awaitable[ClientSession]]
@@ -79,7 +81,7 @@ class Websocket:
                         _LOGGER.log(
                             level, "Websocket authentication error: %s: %s", url, ex
                         )
-                        await self._attempt_reauth()
+                        await self._attempt_auth(True)
                     else:
                         _LOGGER.log(level, "Websocket handshake error: %s: %s", url, ex)
                 else:
@@ -97,7 +99,7 @@ class Websocket:
 
     async def _websocket_inner_loop(self, url: URL) -> None:
         _LOGGER.debug("Connecting WS to %s", url)
-        self._headers = await self._auth(False)
+        await self._attempt_auth(False)
         ssl = None if self.verify else False
         msg: WSMessage | None = None
         self._seen_non_close_message = False
@@ -140,12 +142,14 @@ class Websocket:
                 await self._ws_connection.close()
             self._ws_connection = None
 
-    async def _attempt_reauth(self) -> None:
-        """Attempt to re-authenticate."""
+    async def _attempt_auth(self, force: bool) -> None:
+        """Attempt to authenticate."""
         try:
-            self._headers = await self._auth(True)
+            self._headers = await self._auth(force)
+        except (NotAuthorized, NvrError) as ex:
+            _LOGGER.debug("Error authenticating websocket: %s", ex)
         except Exception:
-            _LOGGER.exception("Error reauthenticating websocket")
+            _LOGGER.exception("Unknown error authenticating websocket")
 
     def start(self) -> None:
         """Start the websocket."""

{uiprotect-2.2.0.dist-info → uiprotect-3.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiprotect
-Version: 2.2.0
+Version: 3.0.0
 Summary: Python API for Unifi Protect (Unofficial)
 Home-page: https://github.com/uilibs/uiprotect
 License: MIT

{uiprotect-2.2.0.dist-info → uiprotect-3.0.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 uiprotect/__init__.py,sha256=UdpRSSLSy7pdDfTKf0zRIfy6KRGt_Jv-fMzYWgibbG4,686
 uiprotect/__main__.py,sha256=C_bHCOkv5qj6WMy-6ELoY3Y6HDhLxOa1a30CzmbZhsg,462
-uiprotect/api.py,sha256=P_iS5nIxc4sAYp4ISBS_X7wUGIPV2c96xhUkj6kGleg,67379
+uiprotect/api.py,sha256=2IV1DjkWbv4aAesGnVJkzgT5Y9DdRmIAll2FB68Jf6Q,66830
 uiprotect/cli/__init__.py,sha256=1MO8rJmjjAsfVx2x01gn5DJo8B64xdPGo6gRVJbWd18,8868
 uiprotect/cli/backup.py,sha256=ZiS7RZnJGKI8TJKLW2cOUzkRM8nyTvE5Ov_jZZGtvSM,36708
 uiprotect/cli/base.py,sha256=k-_qGuNT7br0iV0KE5F4wYXF75iyLLjBEckTqxC71xM,7591
@@ -29,9 +29,9 @@ uiprotect/stream.py,sha256=McV3XymKyjn-1uV5jdQHcpaDjqLS4zWyMASQ8ubcyb4,4924
 uiprotect/test_util/__init__.py,sha256=whiOUb5LfDLNT3AQG6ISiKtAqO2JnhCIdFavhWDK46M,18718
 uiprotect/test_util/anonymize.py,sha256=f-8ijU-_y9r-uAbhIPn0f0I6hzJpAkvJzc8UpWihObI,8478
 uiprotect/utils.py,sha256=3SJFF8qs1Jz8t3mD8qwc1hFSocolFjdXI_v4yVlC7o4,20088
-uiprotect/websocket.py,sha256=Ufm1WLOeKCffXvSl8pWT11Q_t8tNpGHZWgeAL7Ao4mc,6799
-uiprotect-2.2.0.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
-uiprotect-2.2.0.dist-info/METADATA,sha256=8TmCakZrF5cw4pKa7xLQzt-fyQFDMDKp1iCl4zUNl04,10982
-uiprotect-2.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-uiprotect-2.2.0.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
-uiprotect-2.2.0.dist-info/RECORD,,
+uiprotect/websocket.py,sha256=wWcVhMST_hFamOIUQogUytMqwpsvKwKN73BYErYTrJU,6973
+uiprotect-3.0.0.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
+uiprotect-3.0.0.dist-info/METADATA,sha256=slp9fl5MLh2zPWhVqhgwXczlmNS2ZtN2cGHZUDkIfJA,10982
+uiprotect-3.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+uiprotect-3.0.0.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
+uiprotect-3.0.0.dist-info/RECORD,,