evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add support for attribute caching to the fan platform (#106269)

Browse source
This commit is contained in:
J. Nick Koston 2023-12-23 00:26:40 -10:00 • committed by GitHub
parent 060172fc24
commit d83dafa14a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
homeassistant/components/fan/__init__.py
View file

@ -6,7 +6,7 @@ from enum import IntFlag
import functools as ft import functools as ft
import logging import logging
import math import math
from typing import Any, final from typing import TYPE_CHECKING, Any, final
import voluptuous as vol import voluptuous as vol
@ -38,6 +38,12 @@ from homeassistant.util.percentage import (
ranged_value_to_percentage, ranged_value_to_percentage,
) )
if TYPE_CHECKING:
from functools import cached_property
else:
from homeassistant.backports.functools import cached_property
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
DOMAIN = "fan" DOMAIN = "fan"
@ -207,7 +213,18 @@ class FanEntityDescription(ToggleEntityDescription, frozen_or_thawed=True):
"""A class that describes fan entities.""" """A class that describes fan entities."""
class FanEntity(ToggleEntity): CACHED_PROPERTIES_WITH_ATTR_ = {
"percentage",
"speed_count",
"current_direction",
"oscillating",
"supported_features",
"preset_mode",
"preset_modes",
}
class FanEntity(ToggleEntity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
"""Base class for fan entities.""" """Base class for fan entities."""
_entity_component_unrecorded_attributes = frozenset({ATTR_PRESET_MODES}) _entity_component_unrecorded_attributes = frozenset({ATTR_PRESET_MODES})
@ -350,14 +367,14 @@ class FanEntity(ToggleEntity):
self.percentage is not None and self.percentage > 0 self.percentage is not None and self.percentage > 0
) or self.preset_mode is not None ) or self.preset_mode is not None
@property @cached_property
def percentage(self) -> int | None: def percentage(self) -> int | None:
"""Return the current speed as a percentage.""" """Return the current speed as a percentage."""
if hasattr(self, "_attr_percentage"): if hasattr(self, "_attr_percentage"):
return self._attr_percentage return self._attr_percentage
return 0 return 0
@property @cached_property
def speed_count(self) -> int: def speed_count(self) -> int:
"""Return the number of speeds the fan supports.""" """Return the number of speeds the fan supports."""
if hasattr(self, "_attr_speed_count"): if hasattr(self, "_attr_speed_count"):
@ -369,12 +386,12 @@ class FanEntity(ToggleEntity):
"""Return the step size for percentage.""" """Return the step size for percentage."""
return 100 / self.speed_count return 100 / self.speed_count
@property @cached_property
def current_direction(self) -> str | None: def current_direction(self) -> str | None:
"""Return the current direction of the fan.""" """Return the current direction of the fan."""
return self._attr_current_direction return self._attr_current_direction
@property @cached_property
def oscillating(self) -> bool | None: def oscillating(self) -> bool | None:
"""Return whether or not the fan is currently oscillating.""" """Return whether or not the fan is currently oscillating."""
return self._attr_oscillating return self._attr_oscillating
@ -417,12 +434,12 @@ class FanEntity(ToggleEntity):
return data return data
@property @cached_property
def supported_features(self) -> FanEntityFeature: def supported_features(self) -> FanEntityFeature:
"""Flag supported features.""" """Flag supported features."""
return self._attr_supported_features return self._attr_supported_features
@property @cached_property
def preset_mode(self) -> str | None: def preset_mode(self) -> str | None:
"""Return the current preset mode, e.g., auto, smart, interval, favorite. """Return the current preset mode, e.g., auto, smart, interval, favorite.
@ -432,7 +449,7 @@ class FanEntity(ToggleEntity):
return self._attr_preset_mode return self._attr_preset_mode
return None return None
@property @cached_property
def preset_modes(self) -> list[str] | None: def preset_modes(self) -> list[str] | None:
"""Return a list of available preset modes. """Return a list of available preset modes.