bachya/eufy-security-ws-python

View on GitHub
eufy_security_ws_python/event.py

Summary

Maintainability
A
0 mins
Test Coverage
"""Define a utilities related to websocket events."""
from __future__ import annotations

from dataclasses import dataclass, field
from typing import Callable

from eufy_security_ws_python.const import LOGGER


@dataclass
class Event:
    """Define an event."""

    type: str
    data: dict = field(default_factory=dict)


class EventBase:
    """Define a base class for event handling."""

    def __init__(self) -> None:
        """Initialize event base."""
        self._listeners: dict[str, list[Callable]] = {}

    def on(  # pylint: disable=invalid-name
        self, event_name: str, callback: Callable
    ) -> Callable:
        """Register an event callback."""
        listeners = self._listeners.setdefault(event_name, [])
        listeners.append(callback)

        def unsubscribe() -> None:
            """Unsubscribe listeners."""
            if callback in listeners:
                listeners.remove(callback)

        return unsubscribe

    def once(self, event_name: str, callback: Callable) -> Callable:
        """Listen for an event exactly once."""

        def event_listener(data: dict) -> None:
            unsub()
            callback(data)

        unsub = self.on(event_name, event_listener)

        return unsub

    def emit(self, event_name: str, data: dict) -> None:
        """Run all callbacks for an event."""
        for listener in self._listeners.get(event_name, []):
            listener(data)

    def _handle_event_protocol(self, event: Event) -> None:
        """Process an event based on event protocol."""
        handler = getattr(self, f"handle_{event.type.replace(' ', '_')}", None)

        if handler is None:
            LOGGER.debug("Received unknown event: %s", event)
            return

        handler(event)