jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-26 06:37:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cache entity translation lookups and keys (#95180)

Browse Source
This commit is contained in:
J. Nick Koston 2023-06-25 08:50:48 -05:00 committed by GitHub
parent 2ce23c17ca
commit 9051750add
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
homeassistant/helpers/entity.py
View File

@ -312,6 +312,10 @@ 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.
@ -382,14 +386,19 @@ class Entity(ABC):
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 "_"
platform = self.platform
name_translation_key = ( name_translation_key = (
f"component.{self.platform.domain}.entity_component." f"component.{platform.domain}.entity_component." f"{device_class_key}.name"
f"{device_class_key}.name"
) )
return self.platform.component_translations.get(name_translation_key) self._cached_device_class_name = platform.component_translations.get(
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."""
@ -397,24 +406,30 @@ class Entity(ABC):
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
return ( platform = self.platform
f"component.{self.platform.platform_name}.entity.{self.platform.domain}" self._cached_name_translation_key = (
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:
"""Return the name of the entity.""" """Return the name of the entity."""
if hasattr(self, "_attr_name"): if hasattr(self, "_attr_name"):
return self._attr_name return self._attr_name
if self.has_entity_name and ( if (
name_translation_key := self._name_translation_key() self.has_entity_name
and (name_translation_key := self._name_translation_key())
and (name := self.platform.platform_translations.get(name_translation_key))
): ):
if name_translation_key in self.platform.platform_translations: if TYPE_CHECKING:
name: str = self.platform.platform_translations[name_translation_key] assert isinstance(name, str)
return name return name
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():

4
tests/helpers/test_entity.py
View File

@ -19,6 +19,7 @@ from homeassistant.const import (
) )
from homeassistant.core import Context, HomeAssistant, HomeAssistantError from homeassistant.core import Context, HomeAssistant, HomeAssistantError
from homeassistant.helpers import device_registry as dr, entity, entity_registry as er from homeassistant.helpers import device_registry as dr, entity, entity_registry as er
from homeassistant.helpers.entity_component import async_update_entity
from homeassistant.helpers.typing import UNDEFINED from homeassistant.helpers.typing import UNDEFINED
from tests.common import ( from tests.common import (
@ -983,6 +984,9 @@ async def _test_friendly_name(
assert state.attributes.get(ATTR_FRIENDLY_NAME) == expected_friendly_name assert state.attributes.get(ATTR_FRIENDLY_NAME) == expected_friendly_name
assert (expected_warning in caplog.text) is warn_implicit_name assert (expected_warning in caplog.text) is warn_implicit_name
await async_update_entity(hass, ent.entity_id)
assert state.attributes.get(ATTR_FRIENDLY_NAME) == expected_friendly_name
@pytest.mark.parametrize( @pytest.mark.parametrize(
("has_entity_name", "entity_name", "expected_friendly_name", "warn_implicit_name"), ("has_entity_name", "entity_name", "expected_friendly_name", "warn_implicit_name"),