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

Add label_description to template engine (#147138)

Browse Source 
Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>
This commit is contained in:
Petro31 2025-06-23 14:21:29 -04:00 committed by GitHub
parent 2833e97625
commit e494f66c02
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
homeassistant/helpers/template.py
View File

@ -1734,6 +1734,14 @@ def label_name(hass: HomeAssistant, lookup_value: str) -> str | None:
return None return None
def label_description(hass: HomeAssistant, lookup_value: str) -> str | None:
"""Get the label description from a label ID."""
label_reg = label_registry.async_get(hass)
if label := label_reg.async_get_label(lookup_value):
return label.description
return None
def _label_id_or_name(hass: HomeAssistant, label_id_or_name: str) -> str | None: def _label_id_or_name(hass: HomeAssistant, label_id_or_name: str) -> str | None:
"""Get the label ID from a label name or ID.""" """Get the label ID from a label name or ID."""
# If label_name returns a value, we know the input was an ID, otherwise we # If label_name returns a value, we know the input was an ID, otherwise we
@ -3314,6 +3322,9 @@ class TemplateEnvironment(ImmutableSandboxedEnvironment):
self.globals["label_name"] = hassfunction(label_name) self.globals["label_name"] = hassfunction(label_name)
self.filters["label_name"] = self.globals["label_name"] self.filters["label_name"] = self.globals["label_name"]
self.globals["label_description"] = hassfunction(label_description)
self.filters["label_description"] = self.globals["label_description"]
self.globals["label_areas"] = hassfunction(label_areas) self.globals["label_areas"] = hassfunction(label_areas)
self.filters["label_areas"] = self.globals["label_areas"] self.filters["label_areas"] = self.globals["label_areas"]

34
tests/helpers/test_template.py
View File

@ -6295,6 +6295,40 @@ async def test_label_name(
assert info.rate_limit is None assert info.rate_limit is None
async def test_label_description(
hass: HomeAssistant,
label_registry: lr.LabelRegistry,
) -> None:
"""Test label_description function."""
# Test non existing label ID
info = render_to_info(hass, "{{ label_description('1234567890') }}")
assert_result_info(info, None)
assert info.rate_limit is None
info = render_to_info(hass, "{{ '1234567890' | label_description }}")
assert_result_info(info, None)
assert info.rate_limit is None
# Test wrong value type
info = render_to_info(hass, "{{ label_description(42) }}")
assert_result_info(info, None)
assert info.rate_limit is None
info = render_to_info(hass, "{{ 42 | label_description }}")
assert_result_info(info, None)
assert info.rate_limit is None
# Test valid label ID
label = label_registry.async_create("choo choo", description="chugga chugga")
info = render_to_info(hass, f"{{{{ label_description('{label.label_id}') }}}}")
assert_result_info(info, label.description)
assert info.rate_limit is None
info = render_to_info(hass, f"{{{{ '{label.label_id}' | label_description }}}}")
assert_result_info(info, label.description)
assert info.rate_limit is None
async def test_label_entities( async def test_label_entities(
hass: HomeAssistant, hass: HomeAssistant,
entity_registry: er.EntityRegistry, entity_registry: er.EntityRegistry,