EOS/src/akkudoktoreos/prediction/weather.py

"""Weather forecast module for weather predictions."""

from typing import Optional

from pydantic import Field, computed_field, field_validator

from akkudoktoreos.config.configabc import SettingsBaseModel
from akkudoktoreos.prediction.weatherabc import WeatherProvider
from akkudoktoreos.prediction.weatherimport import WeatherImportCommonSettings


def weather_provider_ids() -> list[str]:
    """Valid weather provider ids."""
    # From the provider classes: valid also while the configuration is created,
    # before the prediction instance exists.
    from akkudoktoreos.prediction.prediction import prediction_provider_ids

    return prediction_provider_ids(WeatherProvider)


class WeatherCommonSettings(SettingsBaseModel):
    """Weather Forecast Configuration."""

    provider: Optional[str] = Field(
        default=None,
        json_schema_extra={
            "description": "Weather provider id of provider to be used.",
            "examples": ["WeatherImport"],
        },
    )

    weatherimport: WeatherImportCommonSettings = Field(
        default_factory=WeatherImportCommonSettings,
        json_schema_extra={"description": "Weather import provider settings"},
    )

    @computed_field  # type: ignore[prop-decorator]
    @property
    def providers(self) -> list[str]:
        """Available weather provider ids."""
        return weather_provider_ids()

    # Validators
    @field_validator("provider", mode="after")
    @classmethod
    def validate_provider(cls, value: Optional[str]) -> Optional[str]:
        if value is None or value in weather_provider_ids():
            return value
        raise ValueError(
            f"Provider '{value}' is not a valid weather provider: {weather_provider_ids()}."
        )