Ignore Jinja import filenames (#1307)

Author: frenckatron

custom_components/spook/entity_filtering.py

@@ -418,6 +418,32 @@ def _is_concatenated_template_match(template_str: str, match: re.Match[str]) ->
     return before_literal.endswith("~") or after_literal.startswith("~")
 
 
+def _is_jinja_import_match(template_str: str, match: re.Match[str]) -> bool:
+    """Return if a quoted entity-like literal is a Jinja import filename."""
+    groups = match.groups()
+    if len(groups) == _STATES_DOMAIN_ENTITY_GROUPS:
+        return False
+
+    entity_start, entity_end = match.span(1)
+    block_start = template_str.rfind("{%", 0, entity_start)
+    expression_start = template_str.rfind("{{", 0, entity_start)
+    if block_start == -1 or expression_start > block_start:
+        return False
+
+    block_end = template_str.find("%}", entity_end)
+    expression_end = template_str.find("}}", entity_end)
+    if block_end == -1 or (expression_end != -1 and expression_end < block_end):
+        return False
+
+    block = template_str[block_start : block_end + 2]
+    return bool(
+        re.match(
+            r"\{%-?\s*(?:from\s+['\"][^'\"]+['\"]\s+import|import\s+['\"][^'\"]+['\"]\s+as)",
+            block,
+        )
+    )
+
+
 def _is_string_method_argument_match(template_str: str, match: re.Match[str]) -> bool:
     """Return if an entity-like literal is used as a string method argument."""
     groups = match.groups()
@@ -473,9 +499,11 @@ def extract_entities_from_template_regex(
 
     for pattern in ENTITY_ID_TEMPLATE_PATTERNS:
         for match in re.finditer(pattern, template_str, re.IGNORECASE):
-            if _is_concatenated_template_match(
-                template_str, match
-            ) or _is_string_method_argument_match(template_str, match):
+            if (
+                _is_concatenated_template_match(template_str, match)
+                or _is_jinja_import_match(template_str, match)
+                or _is_string_method_argument_match(template_str, match)
+            ):
                 continue
 
             entity_id = _entity_id_from_template_match(match)

tests/ectoplasms/automation/repairs/test_unknown_entity_references.py

@@ -66,6 +66,46 @@ async def test_value_template_ignores_concatenated_entity_id_literal(
     assert await extract_entities_from_value(hass, template) == set()
 
 
+async def test_value_template_ignores_jinja_import_filename(
+    hass: HomeAssistant,
+) -> None:
+    """Jinja import filenames are not entity references."""
+    template = "{% from 'date.jinja' import how_about_now %}{{ how_about_now() }}"
+
+    assert await extract_entities_from_value(hass, template) == set()
+
+
+async def test_value_template_ignores_jinja_import_as_filename(
+    hass: HomeAssistant,
+) -> None:
+    """Jinja import-as filenames are not entity references."""
+    template = "{% import 'date.jinja' as date_helpers %}{{ date_helpers.now() }}"
+
+    assert await extract_entities_from_value(hass, template) == set()
+
+
+async def test_value_template_ignores_whitespace_control_jinja_import_filename(
+    hass: HomeAssistant,
+) -> None:
+    """Jinja import filenames with whitespace control are not entity references."""
+    template = "{%- from 'date.jinja' import how_about_now -%}{{ how_about_now() }}"
+
+    assert await extract_entities_from_value(hass, template) == set()
+
+
+async def test_value_template_keeps_entity_reference_between_jinja_blocks(
+    hass: HomeAssistant,
+) -> None:
+    """Entity references in expression blocks are not treated as import filenames."""
+    template = (
+        "{% from 'date.jinja' import how_about_now %}"
+        "{{ states('light.kitchen') }}"
+        "{% set finished = true %}"
+    )
+
+    assert await extract_entities_from_value(hass, template) == {"light.kitchen"}
+
+
 async def test_value_template_ignores_entity_id_prefix_string_match(
     hass: HomeAssistant,
 ) -> None: