github/ha-core
1
Fork 0
mirror of https://github.com/home-assistant/core synced 2024-08-28 03:36:46 +02:00
Code Releases Activity

Add support for attribute caching to the datetime platform (#106340)

Browse Source
This commit is contained in:
J. Nick Koston 2023-12-23 15:14:48 -10:00 committed by GitHub
parent b5e1074062
commit 2a52453f5d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
homeassistant/components/datetime/__init__.py
View File

@ -3,7 +3,7 @@ from __future__ import annotations
from datetime import UTC, datetime, timedelta from datetime import UTC, datetime, timedelta
import logging import logging
from typing import final from typing import TYPE_CHECKING, final
import voluptuous as vol import voluptuous as vol
@ -21,6 +21,11 @@ from homeassistant.util import dt as dt_util
from .const import ATTR_DATETIME, DOMAIN, SERVICE_SET_VALUE from .const import ATTR_DATETIME, DOMAIN, SERVICE_SET_VALUE
if TYPE_CHECKING:
from functools import cached_property
else:
from homeassistant.backports.functools import cached_property
SCAN_INTERVAL = timedelta(seconds=30) SCAN_INTERVAL = timedelta(seconds=30)
ENTITY_ID_FORMAT = DOMAIN + ".{}" ENTITY_ID_FORMAT = DOMAIN + ".{}"
@ -74,7 +79,12 @@ class DateTimeEntityDescription(EntityDescription, frozen_or_thawed=True):
"""A class that describes date/time entities.""" """A class that describes date/time entities."""
class DateTimeEntity(Entity): CACHED_PROPERTIES_WITH_ATTR_ = {
"native_value",
}
class DateTimeEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
"""Representation of a Date/time entity.""" """Representation of a Date/time entity."""
entity_description: DateTimeEntityDescription entity_description: DateTimeEntityDescription
@ -82,13 +92,13 @@ class DateTimeEntity(Entity):
_attr_state: None = None _attr_state: None = None
_attr_native_value: datetime | None _attr_native_value: datetime | None
@property @cached_property
@final @final
def device_class(self) -> None: def device_class(self) -> None:
"""Return entity device class.""" """Return entity device class."""
return None return None
@property @cached_property
@final @final
def state_attributes(self) -> None: def state_attributes(self) -> None:
"""Return the state attributes.""" """Return the state attributes."""
@ -108,7 +118,7 @@ class DateTimeEntity(Entity):
return value.astimezone(UTC).isoformat(timespec="seconds") return value.astimezone(UTC).isoformat(timespec="seconds")
@property @cached_property
def native_value(self) -> datetime | None: def native_value(self) -> datetime | None:
"""Return the value reported by the datetime.""" """Return the value reported by the datetime."""
return self._attr_native_value return self._attr_native_value