From 20f95fa6b3133936f4576c2a0c46501a07818bab Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sun, 3 Apr 2022 20:16:12 +0200 Subject: [PATCH] Exclude weather forecast attribute from recorder (#69205) --- homeassistant/components/weather/recorder.py | 12 ++++++ tests/components/weather/test_recorder.py | 45 ++++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 homeassistant/components/weather/recorder.py create mode 100644 tests/components/weather/test_recorder.py diff --git a/homeassistant/components/weather/recorder.py b/homeassistant/components/weather/recorder.py new file mode 100644 index 00000000000..1c887ea5202 --- /dev/null +++ b/homeassistant/components/weather/recorder.py @@ -0,0 +1,12 @@ +"""Integration platform for recorder.""" +from __future__ import annotations + +from homeassistant.core import HomeAssistant, callback + +from . import ATTR_FORECAST + + +@callback +def exclude_attributes(hass: HomeAssistant) -> set[str]: + """Exclude (often large) forecasts from being recorded in the database.""" + return {ATTR_FORECAST} diff --git a/tests/components/weather/test_recorder.py b/tests/components/weather/test_recorder.py new file mode 100644 index 00000000000..ed902df1385 --- /dev/null +++ b/tests/components/weather/test_recorder.py @@ -0,0 +1,45 @@ +"""The tests for weather recorder.""" +from __future__ import annotations + +from datetime import timedelta + +from homeassistant.components.recorder.models import StateAttributes, States +from homeassistant.components.recorder.util import session_scope +from homeassistant.components.weather import ATTR_FORECAST, DOMAIN +from homeassistant.core import HomeAssistant, State +from homeassistant.setup import async_setup_component +from homeassistant.util import dt as dt_util +from homeassistant.util.unit_system import METRIC_SYSTEM + +from tests.common import async_fire_time_changed, async_init_recorder_component +from tests.components.recorder.common import async_wait_recording_done_without_instance + + +async def test_exclude_attributes(hass: HomeAssistant) -> None: + """Test weather attributes to be excluded.""" + await async_init_recorder_component(hass) + await async_setup_component(hass, DOMAIN, {DOMAIN: {"platform": "demo"}}) + hass.config.units = METRIC_SYSTEM + await hass.async_block_till_done() + + state = hass.states.get("weather.demo_weather_south") + assert state.attributes[ATTR_FORECAST] + + await hass.async_block_till_done() + async_fire_time_changed(hass, dt_util.utcnow() + timedelta(minutes=5)) + await hass.async_block_till_done() + await async_wait_recording_done_without_instance(hass) + + def _fetch_states() -> list[State]: + with session_scope(hass=hass) as session: + native_states = [] + for db_state, db_state_attributes in session.query(States, StateAttributes): + state = db_state.to_native() + state.attributes = db_state_attributes.to_native() + native_states.append(state) + return native_states + + states: list[State] = await hass.async_add_executor_job(_fetch_states) + assert len(states) > 1 + for state in states: + assert ATTR_FORECAST not in state.attributes