m_rate_limiter.py

# m_rate_limiter.py
import time

from stream_pipeline.data_package import DataPackage, DataPackageController, DataPackagePhase, DataPackageModule, Status
from stream_pipeline.module_classes import Module, ExecutionModule, ModuleOptions

import data
import logger

log = logger.get_logger()

class Rate_Limiter(ExecutionModule):
    def __init__(self,
                    flowrate_per_second: float = 2 
                ) -> None:
        super().__init__(ModuleOptions(
                                use_mutex=False,
                                timeout=5,
                            ),
                            name="Flow-Limiter-Module"
                        )
        self.flowrate_per_second: float = flowrate_per_second

        self._last_package_time: float = 0.0

    def execute(self, dp: DataPackage[data.AudioData], dpc: DataPackageController, dpp: DataPackagePhase, dpm: DataPackageModule) -> None:
        if self.flowrate_per_second == 0.0:
            return

        current_time = time.time()
        if current_time - self._last_package_time < 1/self.flowrate_per_second:
            dpm.message = "Rate limit exceeded"
            dpm.status = Status.EXIT
            return

        self._last_package_time = current_time
        return