Merge pull request #68 from andrew-codechimp/config-attribute

Config attribute

Author: andrew-codechimp

.vscode/tasks.json

@@ -6,6 +6,68 @@
             "type": "shell",
             "command": "scripts/develop",
             "problemMatcher": []
+        },
+        {
+            "label": "Lint: All",
+            "type": "shell",
+            "command": "scripts/lint",
+            "group": {
+                "kind": "test",
+                "isDefault": false
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Lint: Ruff Check",
+            "type": "shell",
+            "command": "uv run ruff check .",
+            "group": "test",
+            "problemMatcher": []
+        },
+        {
+            "label": "Lint: Ruff Check & Fix",
+            "type": "shell",
+            "command": "uv run ruff check . --fix",
+            "group": "test",
+            "problemMatcher": []
+        },
+        {
+            "label": "Lint: Ruff Format",
+            "type": "shell",
+            "command": "uv run ruff format .",
+            "group": "test",
+            "problemMatcher": []
+        },
+        {
+            "label": "Lint: MyPy",
+            "type": "shell",
+            "command": "uv run mypy",
+            "group": "test",
+            "problemMatcher": []
+        },
+        {
+            "label": "Test: All",
+            "type": "shell",
+            "command": "uv run pytest",
+            "group": {
+                "kind": "test",
+                "isDefault": true
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Test: Verbose",
+            "type": "shell",
+            "command": "uv run pytest -v",
+            "group": "test",
+            "problemMatcher": []
+        },
+        {
+            "label": "Test: Coverage",
+            "type": "shell",
+            "command": "uv run pytest --cov=custom_components.label_state --cov-report=term-missing",
+            "group": "test",
+            "problemMatcher": []
         }
     ],
     "configurations": [

custom_components/label_state/__init__.py

@@ -8,17 +8,17 @@
 
 from awesomeversion.awesomeversion import AwesomeVersion
 
-from homeassistant.core import HomeAssistant
+from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import __version__ as HA_VERSION  # noqa: N812
+from homeassistant.core import HomeAssistant
 from homeassistant.helpers import config_validation as cv
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.helpers.typing import ConfigType
 
 from .const import (
     DOMAIN,
     LOGGER,
-    PLATFORMS,
     MIN_HA_VERSION,
+    PLATFORMS,
 )
 
 CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)

custom_components/label_state/binary_sensor.py

@@ -2,34 +2,40 @@
 
 from __future__ import annotations
 
-from homeassistant.core import Event, HomeAssistant, EventStateChangedData, callback
+from homeassistant.components.binary_sensor import BinarySensorEntity
+from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
     CONF_NAME,
-    STATE_UNKNOWN,
     CONF_UNIQUE_ID,
     STATE_UNAVAILABLE,
+    STATE_UNKNOWN,
+)
+from homeassistant.core import Event, EventStateChangedData, HomeAssistant, callback
+from homeassistant.helpers import (
+    device_registry as dr,
+    entity_registry as er,
+    label_registry as lr,
 )
-from homeassistant.helpers import device_registry as dr, entity_registry as er
-from homeassistant.helpers.event import async_track_state_change_event
-from homeassistant.config_entries import ConfigEntry
-from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 from homeassistant.helpers.entity_platform import (
-    AddEntitiesCallback,
     AddConfigEntryEntitiesCallback,
+    AddEntitiesCallback,
 )
 from homeassistant.helpers.entity_registry import EVENT_ENTITY_REGISTRY_UPDATED
-from homeassistant.components.binary_sensor import BinarySensorEntity
+from homeassistant.helpers.event import async_track_state_change_event
+from homeassistant.helpers.label_registry import EVENT_LABEL_REGISTRY_UPDATED
+from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
 from .const import (
-    LOGGER,
-    CONF_LABEL,
     ATTR_ENTITIES,
-    CONF_STATE_TO,
-    CONF_STATE_NOT,
-    CONF_STATE_TYPE,
     ATTR_ENTITY_NAMES,
+    ATTR_LABEL_NAME,
+    CONF_LABEL,
     CONF_STATE_LOWER_LIMIT,
+    CONF_STATE_NOT,
+    CONF_STATE_TO,
+    CONF_STATE_TYPE,
     CONF_STATE_UPPER_LIMIT,
+    LOGGER,
     StateTypes,
 )
 
@@ -116,6 +122,7 @@ class LabelStateBinarySensor(BinarySensorEntity):
     _attr_should_poll = False
 
     _state_dict: dict[str, str] = {}
+    _label_name: str = ""
 
     def __init__(
         self,
@@ -131,7 +138,7 @@ def __init__(
     ) -> None:
         """Initialize the label state sensor."""
         self._attr_unique_id = unique_id
-        self._label = label
+        self._label_id = label
         self._state_type = state_type
         self._state_to = state_to
         self._state_not = state_not
@@ -142,20 +149,27 @@ def __init__(
         self._unit_of_measurement_mismatch = False
 
         self._attr_is_on = False
-        self._attr_extra_state_attributes = {}
-        self._attr_extra_state_attributes.update(
-            {
-                ATTR_ENTITIES: [],
-            }
+        self._attr_extra_state_attributes = {
+            ATTR_ENTITIES: [],
+            ATTR_ENTITY_NAMES: [],
+            ATTR_LABEL_NAME: self._label_name,
+        }
+        self._unrecorded_attributes = frozenset(
+            {ATTR_ENTITIES, ATTR_ENTITY_NAMES, ATTR_LABEL_NAME}
         )
 
     async def async_added_to_hass(self) -> None:
         """Handle added to Hass."""
 
         await super().async_added_to_hass()
 
+        label_reg = lr.async_get(self.hass)
+        label_entry = label_reg.async_get_label(self._label_id)
+        if label_entry is not None:
+            self._label_name = label_entry.name
+
         ent_reg = er.async_get(self.hass)
-        entries = er.async_entries_for_label(ent_reg, self._label)
+        entries = er.async_entries_for_label(ent_reg, self._label_id)
 
         for entity_entry in entries:
             if entity_entry.entity_id == self.entity_id:
@@ -165,10 +179,10 @@ async def async_added_to_hass(self) -> None:
                 )
                 continue
             for label in entity_entry.labels:
-                if label == self._label:
+                if label == self._label_id:
                     LOGGER.debug(
                         "Found label %s in entity %s",
-                        self._label,
+                        self._label_id,
                         entity_entry.entity_id,
                     )
 
@@ -183,7 +197,7 @@ async def async_added_to_hass(self) -> None:
                         },
                     )
 
-                    if entity_entry and self._label in entity_entry.labels:
+                    if entity_entry and self._label_id in entity_entry.labels:
                         self._async_state_listener(state_event, update_state=False)
 
                     self.async_on_remove(
@@ -194,6 +208,13 @@ async def async_added_to_hass(self) -> None:
                         )
                     )
 
+        self.async_on_remove(
+            self.hass.bus.async_listen(
+                EVENT_LABEL_REGISTRY_UPDATED,
+                self._async_label_registry_modified,
+            )
+        )
+
         self.async_on_remove(
             self.hass.bus.async_listen(
                 EVENT_ENTITY_REGISTRY_UPDATED,
@@ -204,6 +225,22 @@ async def async_added_to_hass(self) -> None:
         self._calc_state()
         self.async_write_ha_state()
 
+    @callback
+    def _async_label_registry_modified(
+        self, event: Event[lr.EventLabelRegistryUpdatedData]
+    ) -> None:
+        """Handle label registry update."""
+        data = event.data
+        if data["action"] == "update" and data["label_id"] == self._label_id:
+            # Get the label, update the name
+            label_reg = lr.async_get(self.hass)
+            label_entry = label_reg.async_get_label(self._label_id)
+            if label_entry is not None:
+                self._label_name = label_entry.name
+
+            self._calc_state()
+            self.async_write_ha_state()
+
     @callback
     def _async_entity_registry_modified(
         self, event: Event[er.EventEntityRegistryUpdatedData]
@@ -215,7 +252,7 @@ def _async_entity_registry_modified(
             entity_registry = er.async_get(self.hass)
             entity_entry = entity_registry.async_get(data["entity_id"])
 
-            if entity_entry and self._label in entity_entry.labels:
+            if entity_entry and self._label_id in entity_entry.labels:
                 if entity_entry.entity_id == self.entity_id:
                     LOGGER.debug(
                         "We don't watch ourself %s",
@@ -232,7 +269,7 @@ def _async_entity_registry_modified(
                     )
                     LOGGER.debug(
                         "Found label %s in entity %s",
-                        self._label,
+                        self._label_id,
                         entity_entry.entity_id,
                     )
 
@@ -273,7 +310,7 @@ def _calc_state(self) -> None:
             for entity_id in self._state_dict.keys():
                 # Check if the state still has the label
                 entity_entry = entity_registry.async_get(entity_id)
-                if entity_entry and self._label in entity_entry.labels:
+                if entity_entry and self._label_id in entity_entry.labels:
                     entity_state = self._state_dict[entity_id]
 
                     if (
@@ -290,7 +327,7 @@ def _calc_state(self) -> None:
             for entity_id in self._state_dict.keys():
                 # Check if the state still has the label
                 entity_entry = entity_registry.async_get(entity_id)
-                if entity_entry and self._label in entity_entry.labels:
+                if entity_entry and self._label_id in entity_entry.labels:
                     entity_state = self._state_dict[entity_id]
 
                     if (
@@ -307,7 +344,7 @@ def _calc_state(self) -> None:
             for entity_id in self._state_dict.keys():
                 # Check if the state still has the label
                 entity_entry = entity_registry.async_get(entity_id)
-                if entity_entry and self._label in entity_entry.labels:
+                if entity_entry and self._label_id in entity_entry.labels:
                     entity_state = self._state_dict[entity_id]
 
                     try:
@@ -384,6 +421,7 @@ def _calc_state(self) -> None:
         self._attr_is_on = state_is_on
         self._attr_extra_state_attributes[ATTR_ENTITIES] = entities_on
         self._attr_extra_state_attributes[ATTR_ENTITY_NAMES] = entity_names
+        self._attr_extra_state_attributes[ATTR_LABEL_NAME] = self._label_name
 
     def _get_device_or_entity_name(
         self,

custom_components/label_state/config_flow.py

@@ -2,28 +2,28 @@
 
 from __future__ import annotations
 
+from collections.abc import Callable, Coroutine, Mapping
 from typing import Any, cast
-from collections.abc import Mapping, Callable, Coroutine
 
 import voluptuous as vol
 
 from homeassistant.helpers import selector
 from homeassistant.helpers.schema_config_entry_flow import (
+    SchemaCommonFlowHandler,
+    SchemaConfigFlowHandler,
     SchemaFlowError,
     SchemaFlowFormStep,
     SchemaFlowMenuStep,
-    SchemaCommonFlowHandler,
-    SchemaConfigFlowHandler,
 )
 
 from .const import (
-    DOMAIN,
     CONF_LABEL,
-    CONF_STATE_TO,
+    CONF_STATE_LOWER_LIMIT,
     CONF_STATE_NOT,
+    CONF_STATE_TO,
     CONF_STATE_TYPE,
-    CONF_STATE_LOWER_LIMIT,
     CONF_STATE_UPPER_LIMIT,
+    DOMAIN,
     StateTypes,
 )
 

custom_components/label_state/const.py

@@ -9,7 +9,7 @@
 
 LOGGER: Logger = getLogger(__package__)
 
-MIN_HA_VERSION = "2025.4"
+MIN_HA_VERSION = "2025.11"
 
 manifestfile = Path(__file__).parent / "manifest.json"
 with open(file=manifestfile, encoding="UTF-8") as json_file:
@@ -32,6 +32,7 @@
 
 ATTR_ENTITIES = "entities"
 ATTR_ENTITY_NAMES = "entity_names"
+ATTR_LABEL_NAME = "label_name"
 
 
 class StateTypes(StrEnum):

hacs.json

@@ -2,6 +2,6 @@
     "name": "Label State",
     "filename": "label_state.zip",
     "hide_default_branch": true,
-    "homeassistant": "2025.4.0",
+    "homeassistant": "2025.11.0",
     "zip_release": true
 }

pyproject.toml

@@ -28,11 +28,12 @@ Changelog = "https://github.com/andrew-codechimp/HA-Label-State/releases"
 [dependency-groups]
 dev = [
     "colorlog",
-    "homeassistant==2025.4.0",
+    "homeassistant==2025.11.0",
     "mypy",
     "pygments",
     "pytest-homeassistant-custom-component",
     "ruff",
+    "pycares<5.0.0",
 ]
 
 [tool.uv]
@@ -109,7 +110,7 @@ ignore = [
 max-complexity = 25
 
 [tool.ruff.lint.isort]
-length-sort = true
+length-sort = false
 section-order = [
   "future",
   "standard-library",