blakeblackshear.frigate/frigate/data_processing/post/api.py

"""Local or remote processors to handle post processing."""

import logging
from abc import ABC, abstractmethod

from frigate.config import FrigateConfig

from ..types import DataProcessorMetrics, PostProcessDataEnum

logger = logging.getLogger(__name__)


class PostProcessorApi(ABC):
    @abstractmethod
    def __init__(self, config: FrigateConfig, metrics: DataProcessorMetrics) -> None:
        self.config = config
        self.metrics = metrics
        pass

    @abstractmethod
    def process_data(
        self, data: dict[str, any], data_type: PostProcessDataEnum
    ) -> None:
        """Processes the data of data type.
        Args:
            data (dict): containing data about the input.
            data_type (enum): Describing the data that is being processed.

        Returns:
            None.
        """
        pass

    @abstractmethod
    def handle_request(self, request_data: dict[str, any]) -> dict[str, any] | None:
        """Handle metadata requests.
        Args:
            request_data (dict): containing data about requested change to process.

        Returns:
            None if request was not handled, otherwise return response.
        """
        pass