Fix use_device_name in case device device class translations are used (#95010)
Co-authored-by: Erik <erik@montnemery.com>
This commit is contained in:
Franck Nijhof
GitHub
parent
ed55632a66
commit
e2f5a707ce
2 changed files with 194 additions and 10 deletions
|
|
@ -355,14 +355,14 @@ class Entity(ABC):
|
||||||
if hasattr(self, "entity_description"):
|
if hasattr(self, "entity_description"):
|
||||||
if not (name := self.entity_description.name):
|
if not (name := self.entity_description.name):
|
||||||
return True
|
return True
|
||||||
if name is UNDEFINED:
|
if name is UNDEFINED and not self._default_to_device_class_name():
|
||||||
# Backwards compatibility with leaving EntityDescription.name unassigned
|
# Backwards compatibility with leaving EntityDescription.name unassigned
|
||||||
# for device name.
|
# for device name.
|
||||||
# Deprecated in HA Core 2023.6, remove in HA Core 2023.9
|
# Deprecated in HA Core 2023.6, remove in HA Core 2023.9
|
||||||
report_implicit_device_name()
|
report_implicit_device_name()
|
||||||
return True
|
return True
|
||||||
return False
|
return False
|
||||||
if self.name is UNDEFINED:
|
if self.name is UNDEFINED and not self._default_to_device_class_name():
|
||||||
# Backwards compatibility with not overriding name property for device name.
|
# Backwards compatibility with not overriding name property for device name.
|
||||||
# Deprecated in HA Core 2023.6, remove in HA Core 2023.9
|
# Deprecated in HA Core 2023.6, remove in HA Core 2023.9
|
||||||
report_implicit_device_name()
|
report_implicit_device_name()
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,10 @@
|
||||||
"""Test the entity helper."""
|
"""Test the entity helper."""
|
||||||
import asyncio
|
import asyncio
|
||||||
|
from collections.abc import Iterable
|
||||||
import dataclasses
|
import dataclasses
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
import threading
|
import threading
|
||||||
|
from typing import Any
|
||||||
from unittest.mock import MagicMock, PropertyMock, patch
|
from unittest.mock import MagicMock, PropertyMock, patch
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
@ -953,8 +955,6 @@ async def _test_friendly_name(
|
||||||
hass: HomeAssistant,
|
hass: HomeAssistant,
|
||||||
caplog: pytest.LogCaptureFixture,
|
caplog: pytest.LogCaptureFixture,
|
||||||
ent: entity.Entity,
|
ent: entity.Entity,
|
||||||
has_entity_name: bool,
|
|
||||||
entity_name: str | None,
|
|
||||||
expected_friendly_name: str | None,
|
expected_friendly_name: str | None,
|
||||||
warn_implicit_name: bool,
|
warn_implicit_name: bool,
|
||||||
) -> None:
|
) -> None:
|
||||||
|
|
@ -1017,8 +1017,6 @@ async def test_friendly_name_attr(
|
||||||
hass,
|
hass,
|
||||||
caplog,
|
caplog,
|
||||||
ent,
|
ent,
|
||||||
has_entity_name,
|
|
||||||
entity_name,
|
|
||||||
expected_friendly_name,
|
expected_friendly_name,
|
||||||
warn_implicit_name,
|
warn_implicit_name,
|
||||||
)
|
)
|
||||||
|
|
@ -1060,13 +1058,78 @@ async def test_friendly_name_description(
|
||||||
hass,
|
hass,
|
||||||
caplog,
|
caplog,
|
||||||
ent,
|
ent,
|
||||||
has_entity_name,
|
|
||||||
entity_name,
|
|
||||||
expected_friendly_name,
|
expected_friendly_name,
|
||||||
warn_implicit_name,
|
warn_implicit_name,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("has_entity_name", "entity_name", "expected_friendly_name", "warn_implicit_name"),
|
||||||
|
(
|
||||||
|
(False, "Entity Blu", "Entity Blu", False),
|
||||||
|
(False, None, None, False),
|
||||||
|
(False, UNDEFINED, None, False),
|
||||||
|
(True, "Entity Blu", "Device Bla Entity Blu", False),
|
||||||
|
(True, None, "Device Bla", False),
|
||||||
|
(True, UNDEFINED, "Device Bla English cls", False),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
async def test_friendly_name_description_device_class_name(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
has_entity_name: bool,
|
||||||
|
entity_name: str | None,
|
||||||
|
expected_friendly_name: str | None,
|
||||||
|
warn_implicit_name: bool,
|
||||||
|
) -> None:
|
||||||
|
"""Test friendly name when the entity has an entity description."""
|
||||||
|
|
||||||
|
translations = {
|
||||||
|
"en": {"component.test_domain.entity_component.test_class.name": "English cls"},
|
||||||
|
}
|
||||||
|
|
||||||
|
async def async_get_translations(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
language: str,
|
||||||
|
category: str,
|
||||||
|
integrations: Iterable[str] | None = None,
|
||||||
|
config_flow: bool | None = None,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Return all backend translations."""
|
||||||
|
return translations[language]
|
||||||
|
|
||||||
|
class DeviceClassNameMockEntity(MockEntity):
|
||||||
|
def _default_to_device_class_name(self) -> bool:
|
||||||
|
"""Return True if an unnamed entity should be named by its device class."""
|
||||||
|
return True
|
||||||
|
|
||||||
|
ent = DeviceClassNameMockEntity(
|
||||||
|
unique_id="qwer",
|
||||||
|
device_info={
|
||||||
|
"identifiers": {("hue", "1234")},
|
||||||
|
"connections": {(dr.CONNECTION_NETWORK_MAC, "abcd")},
|
||||||
|
"name": "Device Bla",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
ent.entity_description = entity.EntityDescription(
|
||||||
|
"test",
|
||||||
|
device_class="test_class",
|
||||||
|
has_entity_name=has_entity_name,
|
||||||
|
name=entity_name,
|
||||||
|
)
|
||||||
|
with patch(
|
||||||
|
"homeassistant.helpers.entity_platform.translation.async_get_translations",
|
||||||
|
side_effect=async_get_translations,
|
||||||
|
):
|
||||||
|
await _test_friendly_name(
|
||||||
|
hass,
|
||||||
|
caplog,
|
||||||
|
ent,
|
||||||
|
expected_friendly_name,
|
||||||
|
warn_implicit_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"),
|
||||||
(
|
(
|
||||||
|
|
@ -1102,13 +1165,134 @@ async def test_friendly_name_property(
|
||||||
hass,
|
hass,
|
||||||
caplog,
|
caplog,
|
||||||
ent,
|
ent,
|
||||||
has_entity_name,
|
|
||||||
entity_name,
|
|
||||||
expected_friendly_name,
|
expected_friendly_name,
|
||||||
warn_implicit_name,
|
warn_implicit_name,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("has_entity_name", "entity_name", "expected_friendly_name", "warn_implicit_name"),
|
||||||
|
(
|
||||||
|
(False, "Entity Blu", "Entity Blu", False),
|
||||||
|
(False, None, None, False),
|
||||||
|
(False, UNDEFINED, None, False),
|
||||||
|
(True, "Entity Blu", "Device Bla Entity Blu", False),
|
||||||
|
(True, None, "Device Bla", False),
|
||||||
|
# Won't use the device class name because the entity overrides the name property
|
||||||
|
(True, UNDEFINED, "Device Bla None", False),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
async def test_friendly_name_property_device_class_name(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
has_entity_name: bool,
|
||||||
|
entity_name: str | None,
|
||||||
|
expected_friendly_name: str | None,
|
||||||
|
warn_implicit_name: bool,
|
||||||
|
) -> None:
|
||||||
|
"""Test friendly name when the entity has overridden the name property."""
|
||||||
|
|
||||||
|
translations = {
|
||||||
|
"en": {"component.test_domain.entity_component.test_class.name": "English cls"},
|
||||||
|
}
|
||||||
|
|
||||||
|
async def async_get_translations(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
language: str,
|
||||||
|
category: str,
|
||||||
|
integrations: Iterable[str] | None = None,
|
||||||
|
config_flow: bool | None = None,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Return all backend translations."""
|
||||||
|
return translations[language]
|
||||||
|
|
||||||
|
class DeviceClassNameMockEntity(MockEntity):
|
||||||
|
def _default_to_device_class_name(self) -> bool:
|
||||||
|
"""Return True if an unnamed entity should be named by its device class."""
|
||||||
|
return True
|
||||||
|
|
||||||
|
ent = DeviceClassNameMockEntity(
|
||||||
|
unique_id="qwer",
|
||||||
|
device_class="test_class",
|
||||||
|
device_info={
|
||||||
|
"identifiers": {("hue", "1234")},
|
||||||
|
"connections": {(dr.CONNECTION_NETWORK_MAC, "abcd")},
|
||||||
|
"name": "Device Bla",
|
||||||
|
},
|
||||||
|
has_entity_name=has_entity_name,
|
||||||
|
name=entity_name,
|
||||||
|
)
|
||||||
|
with patch(
|
||||||
|
"homeassistant.helpers.entity_platform.translation.async_get_translations",
|
||||||
|
side_effect=async_get_translations,
|
||||||
|
):
|
||||||
|
await _test_friendly_name(
|
||||||
|
hass,
|
||||||
|
caplog,
|
||||||
|
ent,
|
||||||
|
expected_friendly_name,
|
||||||
|
warn_implicit_name,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("has_entity_name", "expected_friendly_name", "warn_implicit_name"),
|
||||||
|
(
|
||||||
|
(False, None, False),
|
||||||
|
(True, "Device Bla English cls", False),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
async def test_friendly_name_device_class_name(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
has_entity_name: bool,
|
||||||
|
expected_friendly_name: str | None,
|
||||||
|
warn_implicit_name: bool,
|
||||||
|
) -> None:
|
||||||
|
"""Test friendly name when the entity has not set the name in any way."""
|
||||||
|
|
||||||
|
translations = {
|
||||||
|
"en": {"component.test_domain.entity_component.test_class.name": "English cls"},
|
||||||
|
}
|
||||||
|
|
||||||
|
async def async_get_translations(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
language: str,
|
||||||
|
category: str,
|
||||||
|
integrations: Iterable[str] | None = None,
|
||||||
|
config_flow: bool | None = None,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Return all backend translations."""
|
||||||
|
return translations[language]
|
||||||
|
|
||||||
|
class DeviceClassNameMockEntity(MockEntity):
|
||||||
|
def _default_to_device_class_name(self) -> bool:
|
||||||
|
"""Return True if an unnamed entity should be named by its device class."""
|
||||||
|
return True
|
||||||
|
|
||||||
|
ent = DeviceClassNameMockEntity(
|
||||||
|
unique_id="qwer",
|
||||||
|
device_class="test_class",
|
||||||
|
device_info={
|
||||||
|
"identifiers": {("hue", "1234")},
|
||||||
|
"connections": {(dr.CONNECTION_NETWORK_MAC, "abcd")},
|
||||||
|
"name": "Device Bla",
|
||||||
|
},
|
||||||
|
has_entity_name=has_entity_name,
|
||||||
|
)
|
||||||
|
with patch(
|
||||||
|
"homeassistant.helpers.entity_platform.translation.async_get_translations",
|
||||||
|
side_effect=async_get_translations,
|
||||||
|
):
|
||||||
|
await _test_friendly_name(
|
||||||
|
hass,
|
||||||
|
caplog,
|
||||||
|
ent,
|
||||||
|
expected_friendly_name,
|
||||||
|
warn_implicit_name,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
(
|
(
|
||||||
"entity_name",
|
"entity_name",
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue