Source code for blocksnet.method.base_method

from abc import ABC

from pydantic import BaseModel, InstanceOf

from ..models import City


[docs]class BaseMethod(ABC, BaseModel):
    """BaseMethod class required for methods implementation"""

    city_model: InstanceOf[City]

[docs]    def calculate(self, *args, **kwargs) -> any:
        """Main calculation method that should be overrided in child class"""
        raise NotImplementedError("Calculation method is not implemented")

[docs]    def plot(self, *args, **kwargs) -> any:
        """Plot method that can be overrided in child class"""
        raise NotImplementedError("Plot method is not implemented")