Modernize template weather

homeassistant/components/template/weather.py

@@ -1,6 +1,9 @@
 """Template platform that aggregates meteorological data."""
 from __future__ import annotations
 
+from functools import partial
+from typing import Any, Literal
+
 import voluptuous as vol
 
 from homeassistant.components.weather import (
@@ -22,9 +25,11 @@
     ENTITY_ID_FORMAT,
     Forecast,
     WeatherEntity,
+    WeatherEntityFeature,
 )
 from homeassistant.const import CONF_NAME, CONF_TEMPERATURE_UNIT, CONF_UNIQUE_ID
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.exceptions import TemplateError
 import homeassistant.helpers.config_validation as cv
 from homeassistant.helpers.config_validation import PLATFORM_SCHEMA
 from homeassistant.helpers.entity import async_generate_entity_id
@@ -39,6 +44,8 @@
 
 from .template_entity import TemplateEntity, rewrite_common_legacy_to_modern_conf
 
+CHECK_FORECAST_KEYS = set().union(Forecast.__annotations__.keys())
+
 CONDITION_CLASSES = {
     ATTR_CONDITION_CLEAR_NIGHT,
     ATTR_CONDITION_CLOUDY,
@@ -68,6 +75,9 @@
 CONF_OZONE_TEMPLATE = "ozone_template"
 CONF_VISIBILITY_TEMPLATE = "visibility_template"
 CONF_FORECAST_TEMPLATE = "forecast_template"
+CONF_FORECAST_DAILY_TEMPLATE = "forecast_daily_template"
+CONF_FORECAST_HOURLY_TEMPLATE = "forecast_hourly_template"
+CONF_FORECAST_TWICE_DAILY_TEMPLATE = "forecast_twice_daily_template"
 CONF_PRESSURE_UNIT = "pressure_unit"
 CONF_WIND_SPEED_UNIT = "wind_speed_unit"
 CONF_VISIBILITY_UNIT = "visibility_unit"
@@ -77,30 +87,40 @@
 CONF_DEW_POINT_TEMPLATE = "dew_point_template"
 CONF_APPARENT_TEMPERATURE_TEMPLATE = "apparent_temperature_template"
 
-PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
-    {
-        vol.Required(CONF_NAME): cv.string,
-        vol.Required(CONF_CONDITION_TEMPLATE): cv.template,
-        vol.Required(CONF_TEMPERATURE_TEMPLATE): cv.template,
-        vol.Required(CONF_HUMIDITY_TEMPLATE): cv.template,
-        vol.Optional(CONF_ATTRIBUTION_TEMPLATE): cv.template,
-        vol.Optional(CONF_PRESSURE_TEMPLATE): cv.template,
-        vol.Optional(CONF_WIND_SPEED_TEMPLATE): cv.template,
-        vol.Optional(CONF_WIND_BEARING_TEMPLATE): cv.template,
-        vol.Optional(CONF_OZONE_TEMPLATE): cv.template,
-        vol.Optional(CONF_VISIBILITY_TEMPLATE): cv.template,
-        vol.Optional(CONF_FORECAST_TEMPLATE): cv.template,
-        vol.Optional(CONF_UNIQUE_ID): cv.string,
-        vol.Optional(CONF_TEMPERATURE_UNIT): vol.In(TemperatureConverter.VALID_UNITS),
-        vol.Optional(CONF_PRESSURE_UNIT): vol.In(PressureConverter.VALID_UNITS),
-        vol.Optional(CONF_WIND_SPEED_UNIT): vol.In(SpeedConverter.VALID_UNITS),
-        vol.Optional(CONF_VISIBILITY_UNIT): vol.In(DistanceConverter.VALID_UNITS),
-        vol.Optional(CONF_PRECIPITATION_UNIT): vol.In(DistanceConverter.VALID_UNITS),
-        vol.Optional(CONF_WIND_GUST_SPEED_TEMPLATE): cv.template,
-        vol.Optional(CONF_CLOUD_COVERAGE_TEMPLATE): cv.template,
-        vol.Optional(CONF_DEW_POINT_TEMPLATE): cv.template,
-        vol.Optional(CONF_APPARENT_TEMPERATURE_TEMPLATE): cv.template,
-    }
+PLATFORM_SCHEMA = vol.All(
+    cv.deprecated(CONF_FORECAST_TEMPLATE),
+    PLATFORM_SCHEMA.extend(
+        {
+            vol.Required(CONF_NAME): cv.string,
+            vol.Required(CONF_CONDITION_TEMPLATE): cv.template,
+            vol.Required(CONF_TEMPERATURE_TEMPLATE): cv.template,
+            vol.Required(CONF_HUMIDITY_TEMPLATE): cv.template,
+            vol.Optional(CONF_ATTRIBUTION_TEMPLATE): cv.template,
+            vol.Optional(CONF_PRESSURE_TEMPLATE): cv.template,
+            vol.Optional(CONF_WIND_SPEED_TEMPLATE): cv.template,
+            vol.Optional(CONF_WIND_BEARING_TEMPLATE): cv.template,
+            vol.Optional(CONF_OZONE_TEMPLATE): cv.template,
+            vol.Optional(CONF_VISIBILITY_TEMPLATE): cv.template,
+            vol.Optional(CONF_FORECAST_TEMPLATE): cv.template,
+            vol.Optional(CONF_FORECAST_DAILY_TEMPLATE): cv.template,
+            vol.Optional(CONF_FORECAST_HOURLY_TEMPLATE): cv.template,
+            vol.Optional(CONF_FORECAST_TWICE_DAILY_TEMPLATE): cv.template,
+            vol.Optional(CONF_UNIQUE_ID): cv.string,
+            vol.Optional(CONF_TEMPERATURE_UNIT): vol.In(
+                TemperatureConverter.VALID_UNITS
+            ),
+            vol.Optional(CONF_PRESSURE_UNIT): vol.In(PressureConverter.VALID_UNITS),
+            vol.Optional(CONF_WIND_SPEED_UNIT): vol.In(SpeedConverter.VALID_UNITS),
+            vol.Optional(CONF_VISIBILITY_UNIT): vol.In(DistanceConverter.VALID_UNITS),
+            vol.Optional(CONF_PRECIPITATION_UNIT): vol.In(
+                DistanceConverter.VALID_UNITS
+            ),
+            vol.Optional(CONF_WIND_GUST_SPEED_TEMPLATE): cv.template,
+            vol.Optional(CONF_CLOUD_COVERAGE_TEMPLATE): cv.template,
+            vol.Optional(CONF_DEW_POINT_TEMPLATE): cv.template,
+            vol.Optional(CONF_APPARENT_TEMPERATURE_TEMPLATE): cv.template,
+        }
+    ),
 )
 
 
@@ -151,6 +171,11 @@ def __init__(
         self._ozone_template = config.get(CONF_OZONE_TEMPLATE)
         self._visibility_template = config.get(CONF_VISIBILITY_TEMPLATE)
         self._forecast_template = config.get(CONF_FORECAST_TEMPLATE)
+        self._forecast_daily_template = config.get(CONF_FORECAST_DAILY_TEMPLATE)
+        self._forecast_hourly_template = config.get(CONF_FORECAST_HOURLY_TEMPLATE)
+        self._forecast_twice_daily_template = config.get(
+            CONF_FORECAST_TWICE_DAILY_TEMPLATE
+        )
         self._wind_gust_speed_template = config.get(CONF_WIND_GUST_SPEED_TEMPLATE)
         self._cloud_coverage_template = config.get(CONF_CLOUD_COVERAGE_TEMPLATE)
         self._dew_point_template = config.get(CONF_DEW_POINT_TEMPLATE)
@@ -180,6 +205,17 @@ def __init__(
         self._dew_point = None
         self._apparent_temperature = None
         self._forecast: list[Forecast] = []
+        self._forecast_daily: list[Forecast] = []
+        self._forecast_hourly: list[Forecast] = []
+        self._forecast_twice_daily: list[Forecast] = []
+
+        self._attr_supported_features = 0
+        if self._forecast_daily_template:
+            self._attr_supported_features |= WeatherEntityFeature.FORECAST_DAILY
+        if self._forecast_hourly_template:
+            self._attr_supported_features |= WeatherEntityFeature.FORECAST_HOURLY
+        if self._forecast_twice_daily_template:
+            self._attr_supported_features |= WeatherEntityFeature.FORECAST_TWICE_DAILY
 
     @property
     def condition(self) -> str | None:
@@ -246,6 +282,18 @@ def forecast(self) -> list[Forecast]:
         """Return the forecast."""
         return self._forecast
 
+    async def async_forecast_daily(self) -> list[Forecast]:
+        """Return the daily forecast in native units."""
+        return self._forecast_daily
+
+    async def async_forecast_hourly(self) -> list[Forecast]:
+        """Return the daily forecast in native units."""
+        return self._forecast_hourly
+
+    async def async_forecast_twice_daily(self) -> list[Forecast]:
+        """Return the daily forecast in native units."""
+        return self._forecast_twice_daily
+
     @property
     def attribution(self) -> str | None:
         """Return the attribution."""
@@ -327,4 +375,73 @@ async def async_added_to_hass(self) -> None:
                 "_forecast",
                 self._forecast_template,
             )
+
+        if self._forecast_daily_template:
+            self.add_template_attribute(
+                "_forecast_daily",
+                self._forecast_daily_template,
+                on_update=partial(self._update_forecast, "daily"),
+                validator=partial(self._validate_forecast, "daily"),
+            )
+        if self._forecast_hourly_template:
+            self.add_template_attribute(
+                "_forecast_hourly",
+                self._forecast_hourly_template,
+                on_update=partial(self._update_forecast, "hourly"),
+                validator=partial(self._validate_forecast, "hourly"),
+            )
+        if self._forecast_twice_daily_template:
+            self.add_template_attribute(
+                "_forecast_twice_daily",
+                self._forecast_twice_daily_template,
+                on_update=partial(self._update_forecast, "twice_daily"),
+                validator=partial(self._validate_forecast, "twice_daily"),
+            )
+
         await super().async_added_to_hass()
+
+    @callback
+    def _update_forecast(
+        self,
+        forecast_type: Literal["daily", "hourly", "twice_daily"],
+        result: list[Forecast] | TemplateError,
+    ) -> None:
+        """Save template result and trigger forecast listener."""
+        attr_result = None if isinstance(result, TemplateError) else result
+        setattr(self, f"_forecast_{forecast_type}", attr_result)
+        self.hass.create_task(self.async_update_listeners([forecast_type]))
+
+    @callback
+    def _validate_forecast(
+        self,
+        forecast_type: Literal["daily", "hourly", "twice_daily"],
+        result: Any,
+    ) -> list[Forecast] | None:
+        """Validate the forecasts."""
+        if result is None:
+            return None
+
+        if not isinstance(result, list):
+            raise vol.Invalid(
+                "Forecasts is not a list, see Weather documentation https://www.home-assistant.io/integrations/weather/"
+            )
+        for forecast in result:
+            if not isinstance(forecast, dict):
+                raise vol.Invalid(
+                    "Forecast in list is not a dict, see Weather documentation https://www.home-assistant.io/integrations/weather/"
+                )
+            diff_result = set().union(forecast.keys()).difference(CHECK_FORECAST_KEYS)
+            if diff_result:
+                raise vol.Invalid(
+                    "Only valid keys in Forecast are allowed, see Weather documentation https://www.home-assistant.io/integrations/weather/"
+                )
+            if forecast_type == "twice_daily" and "is_daytime" not in forecast:
+                raise vol.Invalid(
+                    "`is_daytime` is missing in twice_daily forecast, see Weather documentation https://www.home-assistant.io/integrations/weather/"
+                )
+            if "datetime" not in forecast:
+                raise vol.Invalid(
+                    "`datetime` is required in forecasts, see Weather documentation https://www.home-assistant.io/integrations/weather/"
+                )
+            continue
+        return result