Refactor Shelly entity to remove name assignments (#157018)

Co-authored-by: Shay Levy <[email protected]>

Author: davidrapan

homeassistant/components/shelly/entity.py

@@ -20,14 +20,14 @@
 from homeassistant.helpers.typing import StateType
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
-from .const import CONF_SLEEP_PERIOD, DOMAIN, LOGGER
+from .const import CONF_SLEEP_PERIOD, DOMAIN, LOGGER, ROLE_GENERIC
 from .coordinator import ShellyBlockCoordinator, ShellyConfigEntry, ShellyRpcCoordinator
 from .utils import (
     async_remove_shelly_entity,
     get_block_device_info,
-    get_block_entity_name,
+    get_rpc_channel_name,
     get_rpc_device_info,
-    get_rpc_entity_name,
+    get_rpc_key,
     get_rpc_key_instances,
     get_rpc_role_by_key,
 )
@@ -371,7 +371,7 @@ def __init__(self, coordinator: ShellyBlockCoordinator, block: Block) -> None:
         """Initialize Shelly entity."""
         super().__init__(coordinator)
         self.block = block
-        self._attr_name = get_block_entity_name(coordinator.device, block)
+
         self._attr_device_info = get_entity_block_device_info(coordinator, block)
         self._attr_unique_id = f"{coordinator.mac}-{block.description}"
 
@@ -413,9 +413,9 @@ def __init__(self, coordinator: ShellyRpcCoordinator, key: str) -> None:
         """Initialize Shelly entity."""
         super().__init__(coordinator)
         self.key = key
+
         self._attr_device_info = get_entity_rpc_device_info(coordinator, key)
         self._attr_unique_id = f"{coordinator.mac}-{key}"
-        self._attr_name = get_rpc_entity_name(coordinator.device, key)
 
     @property
     def available(self) -> bool:
@@ -467,9 +467,6 @@ def __init__(
         self.entity_description = description
 
         self._attr_unique_id: str = f"{super().unique_id}-{self.attribute}"
-        self._attr_name = get_block_entity_name(
-            coordinator.device, block, description.name
-        )
 
     @property
     def attribute_value(self) -> StateType:
@@ -507,9 +504,7 @@ def __init__(
         self.block_coordinator = coordinator
         self.attribute = attribute
         self.entity_description = description
-        self._attr_name = get_block_entity_name(
-            coordinator.device, None, description.name
-        )
+
         self._attr_unique_id = f"{coordinator.mac}-{attribute}"
         self._attr_device_info = get_entity_block_device_info(coordinator)
         self._last_value = None
@@ -546,13 +541,13 @@ def __init__(
         self.attribute = attribute
         self.entity_description = description
 
+        if description.role == ROLE_GENERIC:
+            self._attr_name = get_rpc_channel_name(coordinator.device, key)
+
         self._attr_unique_id = f"{super().unique_id}-{attribute}"
-        self._attr_name = get_rpc_entity_name(
-            coordinator.device, key, description.name, description.role
-        )
         self._last_value = None
-        id_key = key.split(":")[-1]
-        self._id = int(id_key) if id_key.isnumeric() else None
+        has_id, _, component_id = get_rpc_key(key)
+        self._id = int(component_id) if has_id and component_id.isnumeric() else None
 
         if description.unit is not None:
             self._attr_native_unit_of_measurement = description.unit(
@@ -626,9 +621,6 @@ def __init__(
             self._attr_unique_id = (
                 f"{self.coordinator.mac}-{block.description}-{attribute}"
             )
-            self._attr_name = get_block_entity_name(
-                coordinator.device, block, description.name
-            )
         elif entry is not None:
             self._attr_unique_id = entry.unique_id
 
@@ -689,11 +681,7 @@ def __init__(
         self._attr_unique_id = f"{coordinator.mac}-{key}-{attribute}"
         self._last_value = None
 
-        if coordinator.device.initialized:
-            self._attr_name = get_rpc_entity_name(
-                coordinator.device, key, description.name
-            )
-        elif entry is not None:
+        if not coordinator.device.initialized and entry is not None:
             self._attr_name = cast(str, entry.original_name)
 
     async def async_update(self) -> None:

homeassistant/components/shelly/utils.py

@@ -49,7 +49,6 @@
     DeviceInfo,
 )
 from homeassistant.helpers.network import NoURLAvailableError, get_url
-from homeassistant.helpers.typing import UNDEFINED, UndefinedType
 from homeassistant.util.dt import utcnow
 
 from .const import (
@@ -117,20 +116,6 @@ def get_block_number_of_channels(device: BlockDevice, block: Block) -> int:
     return channels or 1
 
 
-def get_block_entity_name(
-    device: BlockDevice,
-    block: Block | None,
-    name: str | UndefinedType | None = None,
-) -> str | None:
-    """Naming for block based switch and sensors."""
-    channel_name = get_block_channel_name(device, block)
-
-    if name is not UNDEFINED and name:
-        return f"{channel_name} {name.lower()}" if channel_name else name
-
-    return channel_name
-
-
 def get_block_custom_name(device: BlockDevice, block: Block | None) -> str | None:
     """Get custom name from device settings."""
     if block and (key := cast(str, block.type) + "s") and key in device.settings:
@@ -474,23 +459,6 @@ def get_rpc_sub_device_name(
     return f"{device.name} {component.title()} {component_id}"
 
 
-def get_rpc_entity_name(
-    device: RpcDevice,
-    key: str,
-    name: str | UndefinedType | None = None,
-    role: str | None = None,
-) -> str | None:
-    """Naming for RPC based switch and sensors."""
-    channel_name = get_rpc_channel_name(device, key)
-
-    if name is not UNDEFINED and name:
-        if role and role != ROLE_GENERIC:
-            return name
-        return f"{channel_name} {name.lower()}" if channel_name else name
-
-    return channel_name
-
-
 def get_entity_translation_attributes(
     channel_name: str | None,
     translation_key: str | None,
@@ -826,11 +794,9 @@ async def get_rpc_scripts_event_types(
     device: RpcDevice, ignore_scripts: list[str]
 ) -> dict[int, list[str]]:
     """Return a dict of all scripts and their event types."""
-    script_instances = get_rpc_key_instances(device.status, "script")
     script_events = {}
-    for script in script_instances:
-        script_name = get_rpc_entity_name(device, script)
-        if script_name in ignore_scripts:
+    for script in get_rpc_key_instances(device.status, "script"):
+        if get_rpc_channel_name(device, script) in ignore_scripts:
             continue
 
         script_id = get_rpc_key_id(script)