jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-16 09:47:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use cached_property in entity.py instead of manual cache (#95307)

Browse Source
This commit is contained in:
J. Nick Koston 2023-06-26 19:18:46 -05:00 committed by GitHub
parent 398dbed72e
commit c4288e7b1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
homeassistant/helpers/entity.py
View File

@ -16,6 +16,7 @@ from typing import TYPE_CHECKING, Any, Final, Literal, TypedDict, TypeVar, final
import voluptuous as vol import voluptuous as vol
from homeassistant.backports.functools import cached_property
from homeassistant.config import DATA_CUSTOMIZE from homeassistant.config import DATA_CUSTOMIZE
from homeassistant.const import ( from homeassistant.const import (
ATTR_ASSUMED_STATE, ATTR_ASSUMED_STATE,
@ -312,10 +313,6 @@ class Entity(ABC):
_attr_unique_id: str | None = None _attr_unique_id: str | None = None
_attr_unit_of_measurement: str | None _attr_unit_of_measurement: str | None
# Translation cache
_cached_name_translation_key: str | None = None
_cached_device_class_name: str | None = None
@property @property
def should_poll(self) -> bool: def should_poll(self) -> bool:
"""Return True if entity has to be polled for state. """Return True if entity has to be polled for state.
@ -354,7 +351,7 @@ class Entity(ABC):
if hasattr(self, "_attr_name"): if hasattr(self, "_attr_name"):
return not self._attr_name return not self._attr_name
if name_translation_key := self._name_translation_key(): if name_translation_key := self._name_translation_key:
if name_translation_key in self.platform.platform_translations: if name_translation_key in self.platform.platform_translations:
return False return False
@ -384,10 +381,9 @@ class Entity(ABC):
return self.entity_description.has_entity_name return self.entity_description.has_entity_name
return False return False
@cached_property
def _device_class_name(self) -> str | None: def _device_class_name(self) -> str | None:
"""Return a translated name of the entity based on its device class.""" """Return a translated name of the entity based on its device class."""
if self._cached_device_class_name is not None:
return self._cached_device_class_name
if not self.has_entity_name: if not self.has_entity_name:
return None return None
device_class_key = self.device_class or "_" device_class_key = self.device_class or "_"
@ -395,27 +391,22 @@ class Entity(ABC):
name_translation_key = ( name_translation_key = (
f"component.{platform.domain}.entity_component." f"{device_class_key}.name" f"component.{platform.domain}.entity_component." f"{device_class_key}.name"
) )
self._cached_device_class_name = platform.component_translations.get( return platform.component_translations.get(name_translation_key)
name_translation_key
)
return self._cached_device_class_name
def _default_to_device_class_name(self) -> bool: def _default_to_device_class_name(self) -> bool:
"""Return True if an unnamed entity should be named by its device class.""" """Return True if an unnamed entity should be named by its device class."""
return False return False
@cached_property
def _name_translation_key(self) -> str | None: def _name_translation_key(self) -> str | None:
"""Return translation key for entity name.""" """Return translation key for entity name."""
if self._cached_name_translation_key is not None:
return self._cached_name_translation_key
if self.translation_key is None: if self.translation_key is None:
return None return None
platform = self.platform platform = self.platform
self._cached_name_translation_key = ( return (
f"component.{platform.platform_name}.entity.{platform.domain}" f"component.{platform.platform_name}.entity.{platform.domain}"
f".{self.translation_key}.name" f".{self.translation_key}.name"
) )
return self._cached_name_translation_key
@property @property
def name(self) -> str | UndefinedType | None: def name(self) -> str | UndefinedType | None:
@ -424,7 +415,7 @@ class Entity(ABC):
return self._attr_name return self._attr_name
if ( if (
self.has_entity_name self.has_entity_name
and (name_translation_key := self._name_translation_key()) and (name_translation_key := self._name_translation_key)
and (name := self.platform.platform_translations.get(name_translation_key)) and (name := self.platform.platform_translations.get(name_translation_key))
): ):
if TYPE_CHECKING: if TYPE_CHECKING:
@ -433,13 +424,13 @@ class Entity(ABC):
if hasattr(self, "entity_description"): if hasattr(self, "entity_description"):
description_name = self.entity_description.name description_name = self.entity_description.name
if description_name is UNDEFINED and self._default_to_device_class_name(): if description_name is UNDEFINED and self._default_to_device_class_name():
return self._device_class_name() return self._device_class_name
return description_name return description_name
# The entity has no name set by _attr_name, translation_key or entity_description # The entity has no name set by _attr_name, translation_key or entity_description
# Check if the entity should be named by its device class # Check if the entity should be named by its device class
if self._default_to_device_class_name(): if self._default_to_device_class_name():
return self._device_class_name() return self._device_class_name
return UNDEFINED return UNDEFINED
@property @property