mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-04-19 08:55:15 +00:00
d4e31d556a
Add documentation that covers: - configuration - prediction Add Python scripts that support automatic documentation generation for configuration data defined with pydantic. Adapt EOS configuration to provide more methods for REST API and automatic documentation generation. Adapt REST API to allow for EOS configuration file load and save. Sort REST API on generation of openapi markdown for docs. Move logutil to core/logging to allow configuration of logging by standard config. Make Akkudoktor predictions always start extraction of prediction data at start of day. Previously extraction started at actual hour. This is to support the code that assumes prediction data to start at start of day. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
69 lines
2.7 KiB
Python
69 lines
2.7 KiB
Python
"""Retrieves pvforecast forecast data from an import file.
|
|
|
|
This module provides classes and mappings to manage pvforecast data obtained from
|
|
an import file, including support for various pvforecast attributes such as temperature,
|
|
humidity, cloud cover, and solar irradiance. The data is mapped to the `PVForecastDataRecord`
|
|
format, enabling consistent access to forecasted and historical pvforecast attributes.
|
|
"""
|
|
|
|
from pathlib import Path
|
|
from typing import Optional, Union
|
|
|
|
from pydantic import Field, field_validator
|
|
|
|
from akkudoktoreos.config.configabc import SettingsBaseModel
|
|
from akkudoktoreos.core.logging import get_logger
|
|
from akkudoktoreos.prediction.predictionabc import PredictionImportProvider
|
|
from akkudoktoreos.prediction.pvforecastabc import PVForecastProvider
|
|
|
|
logger = get_logger(__name__)
|
|
|
|
|
|
class PVForecastImportCommonSettings(SettingsBaseModel):
|
|
"""Common settings for pvforecast data import from file or JSON string."""
|
|
|
|
pvforecastimport_file_path: Optional[Union[str, Path]] = Field(
|
|
default=None, description="Path to the file to import PV forecast data from."
|
|
)
|
|
|
|
pvforecastimport_json: Optional[str] = Field(
|
|
default=None,
|
|
description="JSON string, dictionary of PV forecast value lists.",
|
|
)
|
|
|
|
# Validators
|
|
@field_validator("pvforecastimport_file_path", mode="after")
|
|
@classmethod
|
|
def validate_pvforecastimport_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 PVForecastImport(PVForecastProvider, PredictionImportProvider):
|
|
"""Fetch PV forecast data from import file or JSON string.
|
|
|
|
PVForecastImport is a singleton-based class that retrieves pvforecast forecast data
|
|
from a file or JSON string and maps it to `PVForecastDataRecord` 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 PVForecastImport provider."""
|
|
return "PVForecastImport"
|
|
|
|
def _update_data(self, force_update: Optional[bool] = False) -> None:
|
|
if self.config.pvforecastimport_file_path is not None:
|
|
self.import_from_file(self.config.pvforecastimport_file_path, key_prefix="pvforecast")
|
|
if self.config.pvforecastimport_json is not None:
|
|
self.import_from_json(self.config.pvforecastimport_json, key_prefix="pvforecast")
|