mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-07-20 16:58:12 +00:00
eb9e966de9
FAstAPI is an async framework. Data may be imported and exported, load and save, set and get asynchronously. Prevent interleaving data operations to corrupt the data. In the previous design sync and async data access was intermixed leading to data corruption. The basic data classes DataSequence and DataContainer and the derived classes like Provider and Measurement now are async. Data access is protected by several async locks. To support the async design of the data classes the database interface became async. The energy management is also adapted to the new async design. Optimization is still off-loaded to another thread, but the prepration for the optimization and the post optimization actions now follow the async design. Adapter operations are now also protected by async locks. Tests were adapted to the async design and new tests were created. Besides this major fix several other improvements and fixes are included in this PR. * fix: key_to_dict/list/array only regard data records with key value set. Before the exclusion of no value data records was only done if the dropna flag was set. * fix: test for visual result pdf generation Due to updates in the library the generated charts text was a little bit different. Adapt the test to create the comaprison pdf in the test data durectory and update the reference pdf. * chore: Remove MutableMapping from DataSequence and DataContainer. Mutable Mapping does not fit to the now async design. * chore: Add NoDB database backend This backend implements the full database backend interface but performs no actual persistence. It is intended for configurations where database persistence is disabled (`provider=None`). * chore: Improve measurement data import testing with real world scenarios. Added two new endpoints to support testing. * chore: Add mermaid to supported documentation tools * chore: Add documentation about async design * chore: Add documentation about generic data handling Covers the basics of measurement and prediction time series data handling. * chore: Add empty lines around markdown lists. * chore: sync pre-commit config to updated package versions Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
83 lines
3.4 KiB
Python
83 lines
3.4 KiB
Python
"""Retrieves feed in tariff forecast data from an import file.
|
|
|
|
This module provides classes and mappings to manage feed in tariff data obtained from
|
|
an import file. The data is mapped to the `FeedInTariffDataRecord` format, enabling consistent
|
|
access to forecasted and historical feed in tariff attributes.
|
|
"""
|
|
|
|
from pathlib import Path
|
|
from typing import Optional, Union
|
|
|
|
from loguru import logger
|
|
from pydantic import Field, field_validator
|
|
|
|
from akkudoktoreos.config.configabc import SettingsBaseModel
|
|
from akkudoktoreos.prediction.feedintariffabc import FeedInTariffProvider
|
|
from akkudoktoreos.prediction.predictionabc import PredictionImportProvider
|
|
|
|
|
|
class FeedInTariffImportCommonSettings(SettingsBaseModel):
|
|
"""Common settings for feed in tariff data import from file or JSON string."""
|
|
|
|
import_file_path: Optional[Union[str, Path]] = Field(
|
|
default=None,
|
|
json_schema_extra={
|
|
"description": "Path to the file to import feed in tariff data from.",
|
|
"examples": [None, "/path/to/feedintariff.json"],
|
|
},
|
|
)
|
|
import_json: Optional[str] = Field(
|
|
default=None,
|
|
json_schema_extra={
|
|
"description": "JSON string, dictionary of feed in tariff forecast value lists.",
|
|
"examples": ['{"fead_in_tariff_wh": [0.000078, 0.000078, 0.000023]}'],
|
|
},
|
|
)
|
|
|
|
# Validators
|
|
@field_validator("import_file_path", mode="after")
|
|
@classmethod
|
|
def validate_feedintariffimport_file_path(
|
|
cls, value: Optional[Union[str, Path]]
|
|
) -> Optional[Path]:
|
|
if value is None:
|
|
return None
|
|
if isinstance(value, str):
|
|
value = Path(value)
|
|
"""Ensure file is available."""
|
|
value.resolve()
|
|
if not value.is_file():
|
|
raise ValueError(f"Import file path '{value}' is not a file.")
|
|
return value
|
|
|
|
|
|
class FeedInTariffImport(FeedInTariffProvider, PredictionImportProvider):
|
|
"""Fetch Feed In Tariff data from import file or JSON string.
|
|
|
|
FeedInTariffImport is a singleton-based class that retrieves fedd in tariff forecast data
|
|
from a file or JSON string and maps it to `FeedInTariffDataRecord` fields. It manages the forecast
|
|
over a range of hours into the future and retains historical data.
|
|
"""
|
|
|
|
@classmethod
|
|
def provider_id(cls) -> str:
|
|
"""Return the unique identifier for the FeedInTariffImport provider."""
|
|
return "FeedInTariffImport"
|
|
|
|
async def _update_data(self, force_update: Optional[bool] = False) -> None:
|
|
# Both _sequence_lock and _record_lock are already held by the caller.
|
|
# Use internal sync methods only — never await public async counterparts.
|
|
if self.config.feedintariff.provider_settings.FeedInTariffImport is None:
|
|
logger.debug(f"{self.provider_id()} data update without provider settings.")
|
|
return
|
|
if self.config.feedintariff.provider_settings.FeedInTariffImport.import_file_path:
|
|
await self._import_from_file(
|
|
self.config.provider_settings.FeedInTariffImport.import_file_path,
|
|
key_prefix="feedintariff",
|
|
)
|
|
if self.config.feedintariff.provider_settings.FeedInTariffImport.import_json:
|
|
await self._import_from_json(
|
|
self.config.feedintariff.provider_settings.FeedInTariffImport.import_json,
|
|
key_prefix="feedintariff",
|
|
)
|