template_entity.py

Go to the documentation of this file.

"""TemplateEntity utility class."""
 
from __future__ import annotations
 
from collections.abc import Callable, Mapping
import contextlib
import itertools
import logging
from typing import Any, cast
 
from propcache import under_cached_property
import voluptuous as vol
 
from homeassistant.components.blueprint import CONF_USE_BLUEPRINT
from homeassistant.const import (
    CONF_ENTITY_PICTURE_TEMPLATE,
    CONF_FRIENDLY_NAME,
    CONF_ICON,
    CONF_ICON_TEMPLATE,
    CONF_NAME,
    CONF_PATH,
    CONF_VARIABLES,
    STATE_UNKNOWN,
)
from homeassistant.core import (
    CALLBACK_TYPE,
    Context,
    Event,
    EventStateChangedData,
    HomeAssistant,
    State,
    callback,
    validate_state,
)
from homeassistant.exceptions import TemplateError
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity import Entity
from homeassistant.helpers.event import (
    TrackTemplate,
    TrackTemplateResult,
    TrackTemplateResultInfo,
    async_track_template_result,
)
from homeassistant.helpers.script import Script, _VarsType
from homeassistant.helpers.start import async_at_start
from homeassistant.helpers.template import (
    Template,
    TemplateStateFromEntityId,
    result_as_boolean,
)
from homeassistant.helpers.trigger_template_entity import (
    TEMPLATE_ENTITY_BASE_SCHEMA,
    make_template_entity_base_schema,
)
from homeassistant.helpers.typing import ConfigType
 
from .const import (
    CONF_ATTRIBUTE_TEMPLATES,
    CONF_ATTRIBUTES,
    CONF_AVAILABILITY,
    CONF_AVAILABILITY_TEMPLATE,
    CONF_PICTURE,
)
 
_LOGGER = logging.getLogger(__name__)
 
TEMPLATE_ENTITY_AVAILABILITY_SCHEMA = vol.Schema(
    {
        vol.Optional(CONF_AVAILABILITY): cv.template,
    }
)
 
TEMPLATE_ENTITY_ICON_SCHEMA = vol.Schema(
    {
        vol.Optional(CONF_ICON): cv.template,
    }
)
 
TEMPLATE_ENTITY_COMMON_SCHEMA = vol.Schema(
    {
        vol.Optional(CONF_ATTRIBUTES): vol.Schema({cv.string: cv.template}),
        vol.Optional(CONF_AVAILABILITY): cv.template,
        vol.Optional(CONF_VARIABLES): cv.SCRIPT_VARIABLES_SCHEMA,
    }
).extend(TEMPLATE_ENTITY_BASE_SCHEMA.schema)
 
 
def make_template_entity_common_schema(default_name: str) -> vol.Schema:
    """Return a schema with default name."""
    return vol.Schema(
        {
            vol.Optional(CONF_ATTRIBUTES): vol.Schema({cv.string: cv.template}),
            vol.Optional(CONF_AVAILABILITY): cv.template,
        }
    ).extend(make_template_entity_base_schema(default_name).schema)
 
 
TEMPLATE_ENTITY_ATTRIBUTES_SCHEMA_LEGACY = vol.Schema(
    {
        vol.Optional(CONF_ATTRIBUTE_TEMPLATES, default={}): vol.Schema(
            {cv.string: cv.template}
        ),
    }
)
 
TEMPLATE_ENTITY_AVAILABILITY_SCHEMA_LEGACY = vol.Schema(
    {
        vol.Optional(CONF_AVAILABILITY_TEMPLATE): cv.template,
    }
)
 
TEMPLATE_ENTITY_COMMON_SCHEMA_LEGACY = vol.Schema(
    {
        vol.Optional(CONF_ENTITY_PICTURE_TEMPLATE): cv.template,
        vol.Optional(CONF_ICON_TEMPLATE): cv.template,
    }
).extend(TEMPLATE_ENTITY_AVAILABILITY_SCHEMA_LEGACY.schema)
 
 
LEGACY_FIELDS = {
    CONF_ICON_TEMPLATE: CONF_ICON,
    CONF_ENTITY_PICTURE_TEMPLATE: CONF_PICTURE,
    CONF_AVAILABILITY_TEMPLATE: CONF_AVAILABILITY,
    CONF_ATTRIBUTE_TEMPLATES: CONF_ATTRIBUTES,
    CONF_FRIENDLY_NAME: CONF_NAME,
}
 
 
def rewrite_common_legacy_to_modern_conf(
    hass: HomeAssistant,
    entity_cfg: dict[str, Any],
    extra_legacy_fields: dict[str, str] | None = None,
) -> dict[str, Any]:
    """Rewrite legacy config."""
    entity_cfg = {**entity_cfg}
    if extra_legacy_fields is None:
        extra_legacy_fields = {}
 
    for from_key, to_key in itertools.chain(
        LEGACY_FIELDS.items(), extra_legacy_fields.items()
    ):
        if from_key not in entity_cfg or to_key in entity_cfg:
            continue
 
        val = entity_cfg.pop(from_key)
        if isinstance(val, str):
            val = Template(val, hass)
        entity_cfg[to_key] = val
 
    if CONF_NAME in entity_cfg and isinstance(entity_cfg[CONF_NAME], str):
        entity_cfg[CONF_NAME] = Template(entity_cfg[CONF_NAME], hass)
 
    return entity_cfg
 
 
class _TemplateAttribute:
    """Attribute value linked to template result."""
 
    def __init__(
        self,
        entity: Entity,
        attribute: str,
        template: Template,
        validator: Callable[[Any], Any] | None = None,
        on_update: Callable[[Any], None] | None = None,
        none_on_template_error: bool | None = False,
    ) -> None:
        """Template attribute."""
        self._entity_entity = entity
        self._attribute_attribute = attribute
        self.templatetemplate = template
        self.validatorvalidator = validator
        self.on_updateon_update = on_update
        self.async_updateasync_update = None
        self.none_on_template_errornone_on_template_error = none_on_template_error
 
    @callback
    def async_setup(self) -> None:
        """Config update path for the attribute."""
        if self.on_updateon_update:
            return
 
        if not hasattr(self._entity_entity, self._attribute_attribute):
            raise AttributeError(f"Attribute '{self._attribute}' does not exist.")
 
        self.on_updateon_update = self._default_update_default_update
 
    @callback
    def _default_update(self, result: str | TemplateError) -> None:
        attr_result = None if isinstance(result, TemplateError) else result
        setattr(self._entity_entity, self._attribute_attribute, attr_result)
 
    @callback
    def handle_result(
        self,
        event: Event[EventStateChangedData] | None,
        template: Template,
        last_result: str | TemplateError | None,
        result: str | TemplateError,
    ) -> None:
        """Handle a template result event callback."""
        if isinstance(result, TemplateError):
            _LOGGER.error(
                (
                    "TemplateError('%s') "
                    "while processing template '%s' "
                    "for attribute '%s' in entity '%s'"
                ),
                result,
                self.templatetemplate,
                self._attribute_attribute,
                self._entity_entity.entity_id,
            )
            if self.none_on_template_errornone_on_template_error:
                self._default_update_default_update(result)
            else:
                assert self.on_updateon_update
                self.on_updateon_update(result)
            return
 
        if not self.validatorvalidator:
            assert self.on_updateon_update
            self.on_updateon_update(result)
            return
 
        try:
            validated = self.validatorvalidator(result)
        except vol.Invalid as ex:
            _LOGGER.error(
                (
                    "Error validating template result '%s' "
                    "from template '%s' "
                    "for attribute '%s' in entity %s "
                    "validation message '%s'"
                ),
                result,
                self.templatetemplate,
                self._attribute_attribute,
                self._entity_entity.entity_id,
                ex.msg,
            )
            assert self.on_updateon_update
            self.on_updateon_update(None)
            return
 
        assert self.on_updateon_update
        self.on_updateon_update(validated)
        return
 
 
class TemplateEntity(Entity):  # pylint: disable=hass-enforce-class-module
    """Entity that uses templates to calculate attributes."""
 
    _attr_available = True
    _attr_entity_picture = None
    _attr_icon = None
 
    def __init__(
        self,
        hass: HomeAssistant,
        *,
        availability_template: Template | None = None,
        icon_template: Template | None = None,
        entity_picture_template: Template | None = None,
        attribute_templates: dict[str, Template] | None = None,
        config: ConfigType | None = None,
        fallback_name: str | None = None,
        unique_id: str | None = None,
    ) -> None:
        """Template Entity."""
        self._template_attrs: dict[Template, list[_TemplateAttribute]] = {}
        self._template_result_info_template_result_info: TrackTemplateResultInfo | None = None
        self._attr_extra_state_attributes_attr_extra_state_attributes = {}
        self._self_ref_update_count_self_ref_update_count = 0
        self._attr_unique_id_attr_unique_id = unique_id
        self._preview_callback_preview_callback: (
            Callable[
                [
                    str | None,
                    dict[str, Any] | None,
                    dict[str, bool | set[str]] | None,
                    str | None,
                ],
                None,
            ]
            | None
        ) = None
        if config is None:
            self._attribute_templates_attribute_templates = attribute_templates
            self._availability_template_availability_template = availability_template
            self._icon_template_icon_template = icon_template
            self._entity_picture_template_entity_picture_template = entity_picture_template
            self._friendly_name_template_friendly_name_template = None
            self._run_variables_run_variables = {}
            self._blueprint_inputs_blueprint_inputs = None
        else:
            self._attribute_templates_attribute_templates = config.get(CONF_ATTRIBUTES)
            self._availability_template_availability_template = config.get(CONF_AVAILABILITY)
            self._icon_template_icon_template = config.get(CONF_ICON)
            self._entity_picture_template_entity_picture_template = config.get(CONF_PICTURE)
            self._friendly_name_template_friendly_name_template = config.get(CONF_NAME)
            self._run_variables_run_variables = config.get(CONF_VARIABLES, {})
            self._blueprint_inputs_blueprint_inputs = config.get("raw_blueprint_inputs")
 
        class DummyState(State):
            """None-state for template entities not yet added to the state machine."""
 
            def __init__(self) -> None:
                """Initialize a new state."""
                super().__init__("unknown.unknown", STATE_UNKNOWN)
                self.entity_identity_identity_id = None  # type: ignore[assignment]
 
            @under_cached_property
            def name(self) -> str:
                """Name of this state."""
                return "<None>"
 
        variables = {"this": DummyState()}
 
        # Try to render the name as it can influence the entity ID
        self._attr_name_attr_name = fallback_name
        if self._friendly_name_template_friendly_name_template:
            with contextlib.suppress(TemplateError):
                self._attr_name_attr_name = self._friendly_name_template_friendly_name_template.async_render(
                    variables=variables, parse_result=False
                )
 
        # Templates will not render while the entity is unavailable, try to render the
        # icon and picture templates.
        if self._entity_picture_template_entity_picture_template:
            with contextlib.suppress(TemplateError):
                self._attr_entity_picture_attr_entity_picture = self._entity_picture_template_entity_picture_template.async_render(
                    variables=variables, parse_result=False
                )
 
        if self._icon_template_icon_template:
            with contextlib.suppress(TemplateError):
                self._attr_icon_attr_icon = self._icon_template_icon_template.async_render(
                    variables=variables, parse_result=False
                )
 
    @callback
    def _render_variables(self) -> dict:
        if isinstance(self._run_variables_run_variables, dict):
            return self._run_variables_run_variables
 
        return self._run_variables_run_variables.async_render(
            self.hasshass,
            {
                "this": TemplateStateFromEntityId(self.hasshass, self.entity_identity_identity_id),
            },
        )
 
    @callback
    def _update_available(self, result: str | TemplateError) -> None:
        if isinstance(result, TemplateError):
            self._attr_available_attr_available_attr_available = True
            return
 
        self._attr_available_attr_available_attr_available = result_as_boolean(result)
 
    @callback
    def _update_state(self, result: str | TemplateError) -> None:
        if self._availability_template_availability_template:
            return
 
        self._attr_available_attr_available_attr_available = not isinstance(result, TemplateError)
 
    @callback
    def _add_attribute_template(
        self, attribute_key: str, attribute_template: Template
    ) -> None:
        """Create a template tracker for the attribute."""
 
        def _update_attribute(result: str | TemplateError) -> None:
            attr_result = None if isinstance(result, TemplateError) else result
            self._attr_extra_state_attributes_attr_extra_state_attributes[attribute_key] = attr_result
 
        self.add_template_attributeadd_template_attribute(
            attribute_key, attribute_template, None, _update_attribute
        )
 
    @property
    def referenced_blueprint(self) -> str | None:
        """Return referenced blueprint or None."""
        if self._blueprint_inputs_blueprint_inputs is None:
            return None
        return cast(str, self._blueprint_inputs_blueprint_inputs[CONF_USE_BLUEPRINT][CONF_PATH])
 
    def add_template_attribute(
        self,
        attribute: str,
        template: Template,
        validator: Callable[[Any], Any] | None = None,
        on_update: Callable[[Any], None] | None = None,
        none_on_template_error: bool = False,
    ) -> None:
        """Call in the constructor to add a template linked to a attribute.
 
        Parameters
        ----------
        attribute
            The name of the attribute to link to. This attribute must exist
            unless a custom on_update method is supplied.
        template
            The template to calculate.
        validator
            Validator function to parse the result and ensure it's valid.
        on_update
            Called to store the template result rather than storing it
            the supplied attribute. Passed the result of the validator, or None
            if the template or validator resulted in an error.
        none_on_template_error
            If True, the attribute will be set to None if the template errors.
 
        """
        if self.hasshass is None:
            raise ValueError("hass cannot be None")
        if template.hass is None:
            raise ValueError("template.hass cannot be None")
        template_attribute = _TemplateAttribute(
            self, attribute, template, validator, on_update, none_on_template_error
        )
        self._template_attrs.setdefault(template, [])
        self._template_attrs[template].append(template_attribute)
 
    @callback
    def _handle_results(
        self,
        event: Event[EventStateChangedData] | None,
        updates: list[TrackTemplateResult],
    ) -> None:
        """Call back the results to the attributes."""
        if event:
            self.async_set_contextasync_set_context(event.context)
 
        entity_id = event and event.data["entity_id"]
 
        if entity_id and entity_id == self.entity_identity_identity_id:
            self._self_ref_update_count_self_ref_update_count += 1
        else:
            self._self_ref_update_count_self_ref_update_count = 0
 
        if self._self_ref_update_count_self_ref_update_count > len(self._template_attrs):
            for update in updates:
                _LOGGER.warning(
                    (
                        "Template loop detected while processing event: %s, skipping"
                        " template render for Template[%s]"
                    ),
                    event,
                    update.template.template,
                )
            return
 
        for update in updates:
            for template_attr in self._template_attrs[update.template]:
                template_attr.handle_result(
                    event, update.template, update.last_result, update.result
                )
 
        if not self._preview_callback_preview_callback:
            self.async_write_ha_stateasync_write_ha_state()
            return
 
        try:
            calculated_state = self._async_calculate_state_async_calculate_state()
            validate_state(calculated_state.state)
        except Exception as err:  # noqa: BLE001
            self._preview_callback_preview_callback(None, None, None, str(err))
        else:
            assert self._template_result_info_template_result_info
            self._preview_callback_preview_callback(
                calculated_state.state,
                calculated_state.attributes,
                self._template_result_info_template_result_info.listeners,
                None,
            )
 
    @callback
    def _async_template_startup(
        self,
        _hass: HomeAssistant | None,
        log_fn: Callable[[int, str], None] | None = None,
    ) -> None:
        template_var_tups: list[TrackTemplate] = []
        has_availability_template = False
 
        variables = {
            "this": TemplateStateFromEntityId(self.hasshass, self.entity_identity_identity_id),
            **self._render_variables_render_variables(),
        }
 
        for template, attributes in self._template_attrs.items():
            template_var_tup = TrackTemplate(template, variables)
            is_availability_template = False
            for attribute in attributes:
                if attribute._attribute == "_attr_available":  # noqa: SLF001
                    has_availability_template = True
                    is_availability_template = True
                attribute.async_setup()
            # Insert the availability template first in the list
            if is_availability_template:
                template_var_tups.insert(0, template_var_tup)
            else:
                template_var_tups.append(template_var_tup)
 
        result_info = async_track_template_result(
            self.hasshass,
            template_var_tups,
            self._handle_results_handle_results,
            log_fn=log_fn,
            has_super_template=has_availability_template,
        )
        self.async_on_removeasync_on_remove(result_info.async_remove)
        self._template_result_info_template_result_info = result_info
        result_info.async_refresh()
 
    @callback
    def _async_setup_templates(self) -> None:
        """Set up templates."""
        if self._availability_template_availability_template is not None:
            self.add_template_attributeadd_template_attribute(
                "_attr_available",
                self._availability_template_availability_template,
                None,
                self._update_available_update_available,
            )
        if self._attribute_templates_attribute_templates is not None:
            for key, value in self._attribute_templates_attribute_templates.items():
                self._add_attribute_template_add_attribute_template(key, value)
        if self._icon_template_icon_template is not None:
            self.add_template_attributeadd_template_attribute(
                "_attr_icon", self._icon_template_icon_template, vol.Or(cv.whitespace, cv.icon)
            )
        if self._entity_picture_template_entity_picture_template is not None:
            self.add_template_attributeadd_template_attribute(
                "_attr_entity_picture", self._entity_picture_template_entity_picture_template, cv.string
            )
        if (
            self._friendly_name_template_friendly_name_template is not None
            and not self._friendly_name_template_friendly_name_template.is_static
        ):
            self.add_template_attributeadd_template_attribute(
                "_attr_name", self._friendly_name_template_friendly_name_template, cv.string
            )
 
    @callback
    def async_start_preview(
        self,
        preview_callback: Callable[
            [
                str | None,
                Mapping[str, Any] | None,
                dict[str, bool | set[str]] | None,
                str | None,
            ],
            None,
        ],
    ) -> CALLBACK_TYPE:
        """Render a preview."""
 
        def log_template_error(level: int, msg: str) -> None:
            preview_callback(None, None, None, msg)
 
        self._preview_callback_preview_callback = preview_callback
        self._async_setup_templates_async_setup_templates()
        try:
            self._async_template_startup_async_template_startup(None, log_template_error)
        except Exception as err:  # noqa: BLE001
            preview_callback(None, None, None, str(err))
        return self._call_on_remove_callbacks_call_on_remove_callbacks
 
    async def async_added_to_hass(self) -> None:
        """Run when entity about to be added to hass."""
        self._async_setup_templates_async_setup_templates()
 
        async_at_start(self.hasshass, self._async_template_startup_async_template_startup)
 
    async def async_update(self) -> None:
        """Call for forced update."""
        assert self._template_result_info_template_result_info
        self._template_result_info_template_result_info.async_refresh()
 
    async def async_run_script(
        self,
        script: Script,
        *,
        run_variables: _VarsType | None = None,
        context: Context | None = None,
    ) -> None:
        """Run an action script."""
        if run_variables is None:
            run_variables = {}
        await script.async_run(
            run_variables={
                "this": TemplateStateFromEntityId(self.hasshass, self.entity_identity_identity_id),
                **self._render_variables_render_variables(),
                **run_variables,
            },
            context=context,
        )