starred/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2026-10-06 06:15:47 -04:00
Code Issues Packages Projects Releases Wiki Activity

Ensure template results are converted to string before validating against a list of strings. (#184123)

Browse Source
This commit is contained in:
Petro31
2026-10-05 16:06:11 +00:00
committed by Franck Nijhof
parent ec61dda08d
commit 2d44b667a4
4 changed files with 86 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
homeassistant/components/template/climate.py
+14 -2
View File
@@ -508,7 +508,13 @@ class AbstractTemplateClimate(AbstractTemplateEntity, ClimateEntity, RestoreEnti
self.setup_template(
CONF_FAN_MODE,
"_attr_fan_mode",
tcv.item_in_list(self, CONF_FAN_MODE, "_attr_fan_modes", CONF_FAN_MODES),
tcv.item_in_list(
self,
CONF_FAN_MODE,
"_attr_fan_modes",
CONF_FAN_MODES,
stringify_result=True,
),
)
self.add_assumed_attribute("_attr_fan_mode", CONF_FAN_MODE, SET_FAN_MODE_ACTION)
@@ -521,7 +527,11 @@ class AbstractTemplateClimate(AbstractTemplateEntity, ClimateEntity, RestoreEnti
CONF_SWING_MODE,
"_attr_swing_mode",
tcv.item_in_list(
self, CONF_SWING_MODE, "_attr_swing_modes", CONF_SWING_MODES
self,
CONF_SWING_MODE,
"_attr_swing_modes",
CONF_SWING_MODES,
stringify_result=True,
),
)
self.add_assumed_attribute(
@@ -541,6 +551,7 @@ class AbstractTemplateClimate(AbstractTemplateEntity, ClimateEntity, RestoreEnti
CONF_SWING_HORIZONTAL_MODE,
"_attr_swing_horizontal_modes",
CONF_SWING_HORIZONTAL_MODES,
stringify_result=True,
),
)
self.add_assumed_attribute(
@@ -562,6 +573,7 @@ class AbstractTemplateClimate(AbstractTemplateEntity, ClimateEntity, RestoreEnti
CONF_PRESET_MODE,
"_attr_preset_modes",
CONF_PRESET_MODES,
stringify_result=True,
),
)
self.add_assumed_attribute(
homeassistant/components/template/light.py
+5 -1
View File
@@ -450,7 +450,11 @@ class AbstractTemplateLight(AbstractTemplateEntity, LightEntity, RestoreEntity):
CONF_EFFECT,
"_attr_effect",
tcv.item_in_list(
self, "_attr_effect", "_attr_effect_list", CONF_EFFECT_LIST
self,
"_attr_effect",
"_attr_effect_list",
CONF_EFFECT_LIST,
stringify_result=True,
),
)
homeassistant/components/template/validators.py
+4
View File
@@ -350,6 +350,7 @@ def item_in_list[T](
attribute: str,
items: list[Any] | str | None,
items_attribute: str | None = None,
stringify_result: bool = False,
**kwargs: Any,
) -> Callable[[Any], Any | None]:
"""Assert the result of the template is an item inside a list.
@@ -381,6 +382,9 @@ def item_in_list[T](
return None
if stringify_result:
result = str(result)
if result not in _items:
log_validation_result_error(
entity,
tests/components/template/test_validators.py
+63
View File
@@ -893,6 +893,69 @@ async def test_item_in_list(
check_for_error(value, expected, caplog.text, error.format(value))
@pytest.mark.parametrize(
("config", "error"),
[
(
{"default_entity_id": "test.test"},
"Received invalid test state: {} for entity test.test, expected 1, 2, 3, 4",
),
(
{},
"Received invalid state: {} for entity Test, expected 1, 2, 3, 4",
),
],
)
@pytest.mark.parametrize(
("value", "expected"),
[
("1", "1"),
("2", "2"),
("3", "3"),
("4", "4"),
(1, "1"),
(2, "2"),
(3, "3"),
(4, "4"),
*expect_none(
None,
"1.0",
"2.0",
"3.0",
"4.0",
"BEER",
"IS",
"good",
"al;dfj",
"unknown",
"unavailable",
"tru", # codespell:ignore tru
83242.2342,
True,
False,
{},
{"junk": "stuff"},
{"junk"},
),
],
)
async def test_string_item_in_list(
hass: HomeAssistant,
config: dict,
error: str,
value: Any,
expected: bool | None,
caplog: pytest.LogCaptureFixture,
) -> None:
"""Test result is in a list."""
entity = create_test_entity(hass, config)
value = cv.item_in_list(
entity, "state", ["1", "2", "3", "4"], stringify_result=True
)(value)
assert value == expected
check_for_error(value, expected, caplog.text, error.format(value))
@pytest.mark.parametrize(
("config", "error"),
[