import asyncio import time from typing import Any, Awaitable, Callable, Optional from .. import background_tasks, globals # pylint: disable=redefined-builtin from ..binding import BindableProperty from ..slot import Slot class Timer: active = BindableProperty() interval = BindableProperty() def __init__(self, interval: float, callback: Callable[..., Any], *, active: bool = True, once: bool = False, ) -> None: """Timer One major drive behind the creation of NiceGUI was the necessity to have a simple approach to update the interface in regular intervals, for example to show a graph with incoming measurements. A timer will execute a callback repeatedly with a given interval. :param interval: the interval in which the timer is called (can be changed during runtime) :param callback: function or coroutine to execute when interval elapses :param active: whether the callback should be executed or not (can be changed during runtime) :param once: whether the callback is only executed once after a delay specified by `interval` (default: `False`) """ self.interval = interval self.callback: Optional[Callable[..., Any]] = callback self.active = active self.slot: Optional[Slot] = globals.get_slot() self._is_canceled: bool = False coroutine = self._run_once if once else self._run_in_loop if globals.state == globals.State.STARTED: background_tasks.create(coroutine(), name=str(callback)) else: globals.app.on_startup(coroutine) def activate(self) -> None: """Activate the timer.""" assert not self._is_canceled, 'Cannot activate a canceled timer' self.active = True def deactivate(self) -> None: """Deactivate the timer.""" self.active = False def cancel(self) -> None: """Cancel the timer.""" self._is_canceled = True async def _run_once(self) -> None: try: if not await self._connected(): return assert self.slot is not None with self.slot: await asyncio.sleep(self.interval) if self.active and not self._should_stop(): await self._invoke_callback() finally: self._cleanup() async def _run_in_loop(self) -> None: try: if not await self._connected(): return assert self.slot is not None with self.slot: while not self._should_stop(): try: start = time.time() if self.active: await self._invoke_callback() dt = time.time() - start await asyncio.sleep(self.interval - dt) except asyncio.CancelledError: break except Exception as e: globals.handle_exception(e) await asyncio.sleep(self.interval) finally: self._cleanup() async def _invoke_callback(self) -> None: try: assert self.callback is not None result = self.callback() if isinstance(result, Awaitable): await result except Exception as e: globals.handle_exception(e) async def _connected(self, timeout: float = 60.0) -> bool: """Wait for the client connection before the timer callback can be allowed to manipulate the state. See https://github.com/zauberzeug/nicegui/issues/206 for details. Returns True if the client is connected, False if the client is not connected and the timer should be cancelled. """ assert self.slot is not None if self.slot.parent.client.shared: return True # ignore served pages which do not reconnect to backend (e.g. monitoring requests, scrapers etc.) try: await self.slot.parent.client.connected(timeout=timeout) return True except TimeoutError: globals.log.error(f'Timer cancelled because client is not connected after {timeout} seconds') return False def _should_stop(self) -> bool: assert self.slot is not None return ( self.slot.parent.is_deleted or self.slot.parent.client.id not in globals.clients or self._is_canceled or globals.state in {globals.State.STOPPING, globals.State.STOPPED} ) def _cleanup(self) -> None: self.slot = None self.callback = None