python-kasa/kasa/module.py

"""Base class for all module implementations."""

from __future__ import annotations

import logging
from abc import ABC, abstractmethod
from typing import TYPE_CHECKING

from .exceptions import KasaException
from .feature import Feature

if TYPE_CHECKING:
    from .device import Device

_LOGGER = logging.getLogger(__name__)


class Module(ABC):
    """Base class implemention for all modules.

    The base classes should implement `query` to return the query they want to be
    executed during the regular update cycle.
    """

    def __init__(self, device: Device, module: str):
        self._device = device
        self._module = module
        self._module_features: dict[str, Feature] = {}

    @abstractmethod
    def query(self):
        """Query to execute during the update cycle.

        The inheriting modules implement this to include their wanted
        queries to the query that gets executed when Device.update() gets called.
        """

    @property
    @abstractmethod
    def data(self):
        """Return the module specific raw data from the last update."""

    def _add_feature(self, feature: Feature):
        """Add module feature."""

        def _slugified_name(name):
            return name.lower().replace(" ", "_").replace("'", "_")

        feat_name = _slugified_name(feature.name)
        if feat_name in self._module_features:
            raise KasaException("Duplicate name detected %s" % feat_name)
        self._module_features[feat_name] = feature

    def __repr__(self) -> str:
        return (
            f"<Module {self.__class__.__name__} ({self._module})"
            f" for {self._device.host}>"
        )