mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-11-25 06:46:25 +00:00
e7b43782a4
Pydantic deprecates using extra keyword arguments on Field. Used json_schema_extra instead. Deprecated in Pydantic V2.0 to be removed in V3.0. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
73 lines
2.7 KiB
Python
73 lines
2.7 KiB
Python
"""Abstract and base classes for electricity price predictions.
|
|
|
|
Notes:
|
|
- Ensure appropriate API keys or configurations are set up if required by external data sources.
|
|
"""
|
|
|
|
from abc import abstractmethod
|
|
from typing import List, Optional
|
|
|
|
from pydantic import Field, computed_field
|
|
|
|
from akkudoktoreos.prediction.predictionabc import PredictionProvider, PredictionRecord
|
|
|
|
|
|
class ElecPriceDataRecord(PredictionRecord):
|
|
"""Represents a electricity price data record containing various price attributes at a specific datetime.
|
|
|
|
Attributes:
|
|
date_time (Optional[AwareDatetime]): The datetime of the record.
|
|
|
|
"""
|
|
|
|
elecprice_marketprice_wh: Optional[float] = Field(
|
|
None, json_schema_extra={"description": "Electricity market price per Wh (€/Wh)"}
|
|
)
|
|
|
|
# Computed fields
|
|
@computed_field # type: ignore[prop-decorator]
|
|
@property
|
|
def elecprice_marketprice_kwh(self) -> Optional[float]:
|
|
"""Electricity market price per kWh (€/kWh).
|
|
|
|
Convenience attribute calculated from `elecprice_marketprice_wh`.
|
|
"""
|
|
if self.elecprice_marketprice_wh is None:
|
|
return None
|
|
return self.elecprice_marketprice_wh * 1000.0
|
|
|
|
|
|
class ElecPriceProvider(PredictionProvider):
|
|
"""Abstract base class for electricity price providers.
|
|
|
|
WeatherProvider is a thread-safe singleton, ensuring only one instance of this class is created.
|
|
|
|
Configuration variables:
|
|
electricity price_provider (str): Prediction provider for electricity price.
|
|
|
|
Attributes:
|
|
hours (int, optional): The number of hours into the future for which predictions are generated.
|
|
historic_hours (int, optional): The number of past hours for which historical data is retained.
|
|
latitude (float, optional): The latitude in degrees, must be within -90 to 90.
|
|
longitude (float, optional): The longitude in degrees, must be within -180 to 180.
|
|
start_datetime (datetime, optional): The starting datetime for predictions, defaults to the current datetime if unspecified.
|
|
end_datetime (datetime, computed): The datetime representing the end of the prediction range,
|
|
calculated based on `start_datetime` and `hours`.
|
|
keep_datetime (datetime, computed): The earliest datetime for retaining historical data, calculated
|
|
based on `start_datetime` and `historic_hours`.
|
|
"""
|
|
|
|
# overload
|
|
records: List[ElecPriceDataRecord] = Field(
|
|
default_factory=list,
|
|
json_schema_extra={"description": "List of ElecPriceDataRecord records"},
|
|
)
|
|
|
|
@classmethod
|
|
@abstractmethod
|
|
def provider_id(cls) -> str:
|
|
return "ElecPriceProvider"
|
|
|
|
def enabled(self) -> bool:
|
|
return self.provider_id() == self.config.elecprice.provider
|