hass.tibber_prices/custom_components/tibber_prices/sensor/attributes/future.py

"""Future price/trend attribute builders for Tibber Prices sensors."""

from __future__ import annotations

from typing import TYPE_CHECKING

from custom_components.tibber_prices.const import get_display_unit_factor
from custom_components.tibber_prices.coordinator.helpers import get_intervals_for_day_offsets

if TYPE_CHECKING:
    from custom_components.tibber_prices.coordinator.core import (
        TibberPricesDataUpdateCoordinator,
    )
    from custom_components.tibber_prices.coordinator.time_service import TibberPricesTimeService
    from custom_components.tibber_prices.data import TibberPricesConfigEntry

from .helpers import add_alternate_average_attribute

# Constants
MAX_FORECAST_INTERVALS = 8  # Show up to 8 future intervals (2 hours with 15-min intervals)


def add_next_avg_attributes(  # noqa: PLR0913
    attributes: dict,
    key: str,
    coordinator: TibberPricesDataUpdateCoordinator,
    *,
    time: TibberPricesTimeService,
    cached_data: dict | None = None,
    config_entry: TibberPricesConfigEntry | None = None,
) -> None:
    """
    Add attributes for next N hours average price sensors.

    Args:
        attributes: Dictionary to add attributes to
        key: The sensor entity key
        coordinator: The data update coordinator
        time: TibberPricesTimeService instance (required)
        cached_data: Optional cached data dictionary for median values
        config_entry: Optional config entry for user preferences

    """
    # Extract hours from sensor key (e.g., "next_avg_3h" -> 3)
    try:
        hours = int(key.rsplit("_", maxsplit=1)[-1].replace("h", ""))
    except (ValueError, AttributeError):
        return

    # Use TimeService to get the N-hour window starting from next interval
    next_interval_start, window_end = time.get_next_n_hours_window(hours)

    # Get all intervals (yesterday, today, tomorrow) via helper
    all_prices = get_intervals_for_day_offsets(coordinator.data, [-1, 0, 1])

    if not all_prices:
        return
    # Find all intervals in the window
    intervals_in_window = []
    for price_data in all_prices:
        starts_at = time.get_interval_time(price_data)
        if starts_at is None:
            continue
        if next_interval_start <= starts_at < window_end:
            intervals_in_window.append(price_data)

    # Add timestamp attribute (start of next interval - where calculation begins)
    if intervals_in_window:
        attributes["timestamp"] = intervals_in_window[0].get("startsAt")
        attributes["interval_count"] = len(intervals_in_window)
        attributes["hours"] = hours

        # Add alternate average attribute if available in cached_data
        if cached_data and config_entry:
            base_key = f"next_avg_{hours}h"
            add_alternate_average_attribute(
                attributes,
                cached_data,
                base_key,
                config_entry=config_entry,
            )


def get_future_prices(
    coordinator: TibberPricesDataUpdateCoordinator,
    max_intervals: int | None = None,
    *,
    time: TibberPricesTimeService,
    config_entry: TibberPricesConfigEntry,
) -> list[dict] | None:
    """
    Get future price data for multiple upcoming intervals.

    Args:
        coordinator: The data update coordinator.
        max_intervals: Maximum number of future intervals to return.
        time: TibberPricesTimeService instance (required).
        config_entry: Config entry to get display unit configuration.

    Returns:
        List of upcoming price intervals with timestamps and prices.

    """
    if not coordinator.data:
        return None

    # Get all intervals (yesterday, today, tomorrow) via helper
    all_prices = get_intervals_for_day_offsets(coordinator.data, [-1, 0, 1])

    if not all_prices:
        return None

    # Initialize the result list
    future_prices = []

    # Track the maximum intervals to return
    intervals_to_return = MAX_FORECAST_INTERVALS if max_intervals is None else max_intervals

    # Get current date for day key determination
    now = time.now()
    today_date = now.date()
    tomorrow_date = time.get_local_date(offset_days=1)

    for price_data in all_prices:
        starts_at = time.get_interval_time(price_data)
        if starts_at is None:
            continue

        interval_end = starts_at + time.get_interval_duration()

        # Use TimeService to check if interval is in future
        if time.is_in_future(starts_at):
            # Determine which day this interval belongs to
            interval_date = starts_at.date()
            if interval_date == today_date:
                day_key = "today"
            elif interval_date == tomorrow_date:
                day_key = "tomorrow"
            else:
                day_key = "unknown"

            # Convert to display currency unit based on configuration
            price_major = float(price_data["total"])
            factor = get_display_unit_factor(config_entry)
            price_display = round(price_major * factor, 2)

            future_prices.append(
                {
                    "interval_start": starts_at,
                    "interval_end": interval_end,
                    "price": price_major,
                    "price_minor": price_display,
                    "level": price_data.get("level", "NORMAL"),
                    "rating": price_data.get("difference", None),
                    "rating_level": price_data.get("rating_level"),
                    "day": day_key,
                }
            )

    # Sort by start time
    future_prices.sort(key=lambda x: x["interval_start"])

    # Limit to the requested number of intervals
    return future_prices[:intervals_to_return] if future_prices else None