Minor refactor of template sensor (#59466)

homeassistant/components/template/sensor.py

@@ -1,6 +1,8 @@
 """Allows the creation of a sensor that breaks out state_attributes."""
 from __future__ import annotations
 
+from typing import Any
+
 import voluptuous as vol
 
 from homeassistant.components.sensor import (
@@ -41,7 +43,7 @@ from .const import (
     CONF_PICTURE,
     CONF_TRIGGER,
 )
-from .template_entity import TemplateEntity
+from .template_entity import TEMPLATE_ENTITY_COMMON_SCHEMA, TemplateEntity
 from .trigger_entity import TriggerEntity
 
 LEGACY_FIELDS = {
@@ -57,18 +59,14 @@ LEGACY_FIELDS = {
 
 SENSOR_SCHEMA = vol.Schema(
     {
-        vol.Optional(CONF_NAME): cv.template,
-        vol.Required(CONF_STATE): cv.template,
-        vol.Optional(CONF_ICON): cv.template,
-        vol.Optional(CONF_PICTURE): cv.template,
-        vol.Optional(CONF_AVAILABILITY): cv.template,
-        vol.Optional(CONF_ATTRIBUTES): vol.Schema({cv.string: cv.template}),
-        vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
         vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
-        vol.Optional(CONF_UNIQUE_ID): cv.string,
+        vol.Optional(CONF_NAME): cv.template,
         vol.Optional(CONF_STATE_CLASS): STATE_CLASSES_SCHEMA,
+        vol.Required(CONF_STATE): cv.template,
+        vol.Optional(CONF_UNIQUE_ID): cv.string,
+        vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
     }
-)
+).extend(TEMPLATE_ENTITY_COMMON_SCHEMA.schema)
 
 
 LEGACY_SENSOR_SCHEMA = vol.All(
@@ -150,19 +148,7 @@ def _async_create_template_tracking_entities(
     sensors = []
 
     for entity_conf in definitions:
-        # Still available on legacy
-        object_id = entity_conf.get(CONF_OBJECT_ID)
-
-        state_template = entity_conf[CONF_STATE]
-        icon_template = entity_conf.get(CONF_ICON)
-        entity_picture_template = entity_conf.get(CONF_PICTURE)
-        availability_template = entity_conf.get(CONF_AVAILABILITY)
-        friendly_name_template = entity_conf.get(CONF_NAME)
-        unit_of_measurement = entity_conf.get(CONF_UNIT_OF_MEASUREMENT)
-        device_class = entity_conf.get(CONF_DEVICE_CLASS)
-        attribute_templates = entity_conf.get(CONF_ATTRIBUTES, {})
         unique_id = entity_conf.get(CONF_UNIQUE_ID)
-        state_class = entity_conf.get(CONF_STATE_CLASS)
 
         if unique_id and unique_id_prefix:
             unique_id = f"{unique_id_prefix}-{unique_id}"
@@ -170,17 +156,8 @@ def _async_create_template_tracking_entities(
         sensors.append(
             SensorTemplate(
                 hass,
-                object_id,
+                entity_conf,
-                friendly_name_template,
-                unit_of_measurement,
-                state_template,
-                icon_template,
-                entity_picture_template,
-                availability_template,
-                device_class,
-                attribute_templates,
                 unique_id,
-                state_class,
             )
         )
 
@@ -219,47 +196,33 @@ class SensorTemplate(TemplateEntity, SensorEntity):
     def __init__(
         self,
         hass: HomeAssistant,
-        object_id: str | None,
+        config: dict[str, Any],
-        friendly_name_template: template.Template | None,
-        unit_of_measurement: str | None,
-        state_template: template.Template,
-        icon_template: template.Template | None,
-        entity_picture_template: template.Template | None,
-        availability_template: template.Template | None,
-        device_class: str | None,
-        attribute_templates: dict[str, template.Template],
         unique_id: str | None,
-        state_class: str | None,
     ) -> None:
         """Initialize the sensor."""
-        super().__init__(
+        super().__init__(config=config)
-            attribute_templates=attribute_templates,
+        if (object_id := config.get(CONF_OBJECT_ID)) is not None:
-            availability_template=availability_template,
-            icon_template=icon_template,
-            entity_picture_template=entity_picture_template,
-        )
-        if object_id is not None:
             self.entity_id = async_generate_entity_id(
                 ENTITY_ID_FORMAT, object_id, hass=hass
             )
 
-        self._friendly_name_template = friendly_name_template
+        self._friendly_name_template = config.get(CONF_NAME)
 
         self._attr_name = None
         # Try to render the name as it can influence the entity ID
-        if friendly_name_template:
+        if self._friendly_name_template:
-            friendly_name_template.hass = hass
+            self._friendly_name_template.hass = hass
             try:
-                self._attr_name = friendly_name_template.async_render(
+                self._attr_name = self._friendly_name_template.async_render(
                     parse_result=False
                 )
             except template.TemplateError:
                 pass
 
-        self._attr_native_unit_of_measurement = unit_of_measurement
+        self._attr_native_unit_of_measurement = config.get(CONF_UNIT_OF_MEASUREMENT)
-        self._template = state_template
+        self._template = config.get(CONF_STATE)
-        self._attr_device_class = device_class
+        self._attr_device_class = config.get(CONF_DEVICE_CLASS)
-        self._attr_state_class = state_class
+        self._attr_state_class = config.get(CONF_STATE_CLASS)
         self._attr_unique_id = unique_id
 
     async def async_added_to_hass(self):