base.py

import abc
import logging
import typing


class SimvueBaseClass(abc.ABC):
    @abc.abstractmethod
    def __init__(
        self,
        name: str | None,
        uniq_id: str,
        suppress_errors: bool,
    ) -> None:
        self._logger = logging.getLogger(f"simvue.{self.__class__.__name__}")
        self._suppress_errors: bool = suppress_errors
        self._uuid: str = uniq_id
        self.name: str | None = name
        self.id: int | None = None
        self._aborted: bool = False

    def _error(self, message: str) -> None:
        """
        Raise an exception if necessary and log error
        """
        if not self._suppress_errors:
            raise RuntimeError(message)
        self._logger.error(message)
        self._aborted = True

    @abc.abstractmethod
    def list_tags(self) -> list[str] | None:
        pass

    @abc.abstractmethod
    def create_run(self, data: dict[str, typing.Any]) -> tuple[str, str | None]:
        pass

    @abc.abstractmethod
    def update(self, data: dict[str, typing.Any]) -> dict[str, typing.Any] | None:
        pass

    @abc.abstractmethod
    def set_folder_details(self, data) -> dict[str, typing.Any] | None:
        pass

    @abc.abstractmethod
    def save_file(self, data: dict[str, typing.Any]) -> dict[str, typing.Any] | None:
        pass

    @abc.abstractmethod
    def add_alert(self, data: dict[str, typing.Any]) -> dict[str, typing.Any] | None:
        pass

    @abc.abstractmethod
    def set_alert_state(
        self, alert_id: str, status: str
    ) -> dict[str, typing.Any] | None:
        pass

    @abc.abstractmethod
    def list_alerts(self) -> list[dict[str, typing.Any]]:
        pass

    @abc.abstractmethod
    def send_metrics(self, data: dict[str, typing.Any]) -> dict[str, typing.Any] | None:
        pass

    @abc.abstractmethod
    def send_event(self, data: dict[str, typing.Any]) -> dict[str, typing.Any] | None:
        pass

    @abc.abstractmethod
    def send_heartbeat(self) -> dict[str, typing.Any] | None:
        pass

    @abc.abstractmethod
    def get_abort_status(self) -> bool:
        pass