smok-serwis/smok-client

View on GitHub
smok/extras/sensor_write_database/base.py

Summary

Maintainability
A
0 mins
Test Coverage
B
80%
import typing as tp
from abc import ABCMeta, abstractmethod

from smok.sensor import SensorWriteEvent


class BaseSensorWriteSynchronization:
    """
    At most a single instance of this object will be kept alive.

    Must be boolable - return False if this is empty
    """
    __slots__ = ('events', 'swdb')

    def __init__(self, events: tp.List[SensorWriteEvent], swdb: 'BaseSensorWriteDatabase'):
        self.events = events
        self.swdb = swdb

    def __bool__(self):
        return bool(self.events)

    def to_json(self):
        return [event.to_json() for event in self.events]

    def ack(self):
        for event in self.events:
            self.swdb.on_synced_sw(event)

    def nack(self):
        for event in self.events:
            self.swdb.on_sync_sw_failed(event)


class BaseSensorWriteDatabase(metaclass=ABCMeta):
    def on_sync_sw_failed(self, event: SensorWriteEvent):
        """
        Called when given event fails to sync.

        This will never be called if dont_do_pathpoints is True
        """

    def on_synced_sw(self, event: SensorWriteEvent):
        """
        Called when given event becomes synced

        This will never be called if dont_do_pathpoints is True
        """

    @abstractmethod
    def add_sw(self, event: SensorWriteEvent):
        """
        Add a new event to synchronize
        """

    @abstractmethod
    def get_sw_sync(self) -> BaseSensorWriteSynchronization:
        """
        Get a synchronization

        This will never be called if dont_do_pathpoints is True
        """