113 lines
3.8 KiB
Python
113 lines
3.8 KiB
Python
|
"""Helpers to make instant statistics about your history."""
|
||
|
|
from __future__ import annotations
|
||
|
|
|
||
|
|
import datetime
|
||
|
|
import logging
|
||
|
|
import math
|
||
|
|
|
||
|
|
from homeassistant.core import callback
|
||
|
|
from homeassistant.exceptions import TemplateError
|
||
|
|
from homeassistant.helpers.template import Template
|
||
|
|
import homeassistant.util.dt as dt_util
|
||
|
|
|
||
|
|
_LOGGER = logging.getLogger(__name__)
|
||
|
|
|
||
|
|
|
||
|
|
@callback
|
||
|
|
def async_calculate_period(
|
||
|
|
duration: datetime.timedelta | None,
|
||
|
|
start_template: Template | None,
|
||
|
|
end_template: Template | None,
|
||
|
|
) -> tuple[datetime.datetime, datetime.datetime] | None:
|
||
|
|
"""Parse the templates and return the period."""
|
||
|
|
start: datetime.datetime | None = None
|
||
|
|
end: datetime.datetime | None = None
|
||
|
|
|
||
|
|
# Parse start
|
||
|
|
if start_template is not None:
|
||
|
|
try:
|
||
|
|
start_rendered = start_template.async_render()
|
||
|
|
except (TemplateError, TypeError) as ex:
|
||
|
|
HistoryStatsHelper.handle_template_exception(ex, "start")
|
||
|
|
return None
|
||
|
|
if isinstance(start_rendered, str):
|
||
|
|
start = dt_util.parse_datetime(start_rendered)
|
||
|
|
if start is None:
|
||
|
|
try:
|
||
|
|
start = dt_util.as_local(
|
||
|
|
dt_util.utc_from_timestamp(math.floor(float(start_rendered)))
|
||
|
|
)
|
||
|
|
except ValueError:
|
||
|
|
_LOGGER.error("Parsing error: start must be a datetime or a timestamp")
|
||
|
|
return None
|
||
|
|
|
||
|
|
# Parse end
|
||
|
|
if end_template is not None:
|
||
|
|
try:
|
||
|
|
end_rendered = end_template.async_render()
|
||
|
|
except (TemplateError, TypeError) as ex:
|
||
|
|
HistoryStatsHelper.handle_template_exception(ex, "end")
|
||
|
|
return None
|
||
|
|
if isinstance(end_rendered, str):
|
||
|
|
end = dt_util.parse_datetime(end_rendered)
|
||
|
|
if end is None:
|
||
|
|
try:
|
||
|
|
end = dt_util.as_local(
|
||
|
|
dt_util.utc_from_timestamp(math.floor(float(end_rendered)))
|
||
|
|
)
|
||
|
|
except ValueError:
|
||
|
|
_LOGGER.error("Parsing error: end must be a datetime or a timestamp")
|
||
|
|
return None
|
||
|
|
|
||
|
|
# Calculate start or end using the duration
|
||
|
|
if start is None:
|
||
|
|
assert end is not None
|
||
|
|
assert duration is not None
|
||
|
|
start = end - duration
|
||
|
|
if end is None:
|
||
|
|
assert start is not None
|
||
|
|
assert duration is not None
|
||
|
|
end = start + duration
|
||
|
|
|
||
|
|
return start, end
|
||
|
|
|
||
|
|
|
||
|
|
class HistoryStatsHelper:
|
||
|
|
"""Static methods to make the HistoryStatsSensor code lighter."""
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def pretty_duration(hours):
|
||
|
|
"""Format a duration in days, hours, minutes, seconds."""
|
||
|
|
seconds = int(3600 * hours)
|
||
|
|
days, seconds = divmod(seconds, 86400)
|
||
|
|
hours, seconds = divmod(seconds, 3600)
|
||
|
|
minutes, seconds = divmod(seconds, 60)
|
||
|
|
if days > 0:
|
||
|
|
return "%dd %dh %dm" % (days, hours, minutes)
|
||
|
|
if hours > 0:
|
||
|
|
return "%dh %dm" % (hours, minutes)
|
||
|
|
return "%dm" % minutes
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def pretty_ratio(value, period):
|
||
|
|
"""Format the ratio of value / period duration."""
|
||
|
|
if len(period) != 2 or period[0] == period[1]:
|
||
|
|
return 0.0
|
||
|
|
|
||
|
|
ratio = 100 * 3600 * value / (period[1] - period[0]).total_seconds()
|
||
|
|
return round(ratio, 1)
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def handle_template_exception(ex, field):
|
||
|
|
"""Log an error nicely if the template cannot be interpreted."""
|
||
|
|
if ex.args and ex.args[0].startswith("UndefinedError: 'None' has no attribute"):
|
||
|
|
# Common during HA startup - so just a warning
|
||
|
|
_LOGGER.warning(ex)
|
||
|
|
return
|
||
|
|
_LOGGER.error("Error parsing template for field %s", field, exc_info=ex)
|
||
|
|
|
||
|
|
|
||
|
|
def floored_timestamp(incoming_dt: datetime.datetime) -> float:
|
||
|
|
"""Calculate the floored value of a timestamp."""
|
||
|
|
return math.floor(dt_util.as_timestamp(incoming_dt))
|