core/homeassistant/components/template/trigger_entity.py

"""Trigger entity."""
from __future__ import annotations

import logging
from typing import Any

from homeassistant.const import (
    CONF_DEVICE_CLASS,
    CONF_ENTITY_PICTURE_TEMPLATE,
    CONF_FRIENDLY_NAME,
    CONF_FRIENDLY_NAME_TEMPLATE,
    CONF_ICON_TEMPLATE,
    CONF_UNIQUE_ID,
    CONF_UNIT_OF_MEASUREMENT,
    CONF_VALUE_TEMPLATE,
)
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import template, update_coordinator
from homeassistant.helpers.entity import async_generate_entity_id

from . import TriggerUpdateCoordinator
from .const import CONF_ATTRIBUTE_TEMPLATES, CONF_AVAILABILITY_TEMPLATE


class TriggerEntity(update_coordinator.CoordinatorEntity):
    """Template entity based on trigger data."""

    domain = ""
    extra_template_keys: tuple | None = None

    def __init__(
        self,
        hass: HomeAssistant,
        coordinator: TriggerUpdateCoordinator,
        device_id: str,
        config: dict,
    ):
        """Initialize the entity."""
        super().__init__(coordinator)

        self.entity_id = async_generate_entity_id(
            self.domain + ".{}", device_id, hass=hass
        )

        self._name = config.get(CONF_FRIENDLY_NAME, device_id)

        entity_unique_id = config.get(CONF_UNIQUE_ID)

        if entity_unique_id is None and coordinator.unique_id:
            entity_unique_id = device_id

        if entity_unique_id and coordinator.unique_id:
            self._unique_id = f"{coordinator.unique_id}-{entity_unique_id}"
        else:
            self._unique_id = entity_unique_id

        self._config = config

        self._to_render = [
            itm
            for itm in (
                CONF_VALUE_TEMPLATE,
                CONF_ICON_TEMPLATE,
                CONF_ENTITY_PICTURE_TEMPLATE,
                CONF_FRIENDLY_NAME_TEMPLATE,
                CONF_AVAILABILITY_TEMPLATE,
            )
            if itm in config
        ]

        if self.extra_template_keys is not None:
            self._to_render.extend(self.extra_template_keys)

        self._rendered = {}

    @property
    def name(self):
        """Name of the entity."""
        if (
            self._rendered is not None
            and (name := self._rendered.get(CONF_FRIENDLY_NAME_TEMPLATE)) is not None
        ):
            return name
        return self._name

    @property
    def unique_id(self):
        """Return unique ID of the entity."""
        return self._unique_id

    @property
    def device_class(self):
        """Return device class of the entity."""
        return self._config.get(CONF_DEVICE_CLASS)

    @property
    def unit_of_measurement(self) -> str | None:
        """Return unit of measurement."""
        return self._config.get(CONF_UNIT_OF_MEASUREMENT)

    @property
    def icon(self) -> str | None:
        """Return icon."""
        return self._rendered is not None and self._rendered.get(CONF_ICON_TEMPLATE)

    @property
    def entity_picture(self) -> str | None:
        """Return entity picture."""
        return self._rendered is not None and self._rendered.get(
            CONF_ENTITY_PICTURE_TEMPLATE
        )

    @property
    def available(self):
        """Return availability of the entity."""
        return (
            self._rendered is not None
            and
            # Check against False so `None` is ok
            self._rendered.get(CONF_AVAILABILITY_TEMPLATE) is not False
        )

    @property
    def extra_state_attributes(self) -> dict[str, Any] | None:
        """Return extra attributes."""
        return self._rendered.get(CONF_ATTRIBUTE_TEMPLATES)

    async def async_added_to_hass(self) -> None:
        """Handle being added to Home Assistant."""
        template.attach(self.hass, self._config)
        await super().async_added_to_hass()
        if self.coordinator.data is not None:
            self._handle_coordinator_update()

    @callback
    def _handle_coordinator_update(self) -> None:
        """Handle updated data from the coordinator."""
        try:
            rendered = {}

            for key in self._to_render:
                rendered[key] = self._config[key].async_render(
                    self.coordinator.data["run_variables"], parse_result=False
                )

            if CONF_ATTRIBUTE_TEMPLATES in self._config:
                rendered[CONF_ATTRIBUTE_TEMPLATES] = template.render_complex(
                    self._config[CONF_ATTRIBUTE_TEMPLATES],
                    self.coordinator.data["run_variables"],
                )

            self._rendered = rendered
        except template.TemplateError as err:
            logging.getLogger(f"{__package__}.{self.entity_id.split('.')[0]}").error(
                "Error rendering %s template for %s: %s", key, self.entity_id, err
            )
            self._rendered = None

        self.async_set_context(self.coordinator.data["context"])
        self.async_write_ha_state()