calendar.py

Go to the documentation of this file.

"""Calendar platform for a Epic Games Store."""
 
from __future__ import annotations
 
from collections import namedtuple
from datetime import datetime
from typing import Any
 
from homeassistant.components.calendar import CalendarEntity, CalendarEvent
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from .const import DOMAIN, CalendarType
from .coordinator import EGSCalendarUpdateCoordinator
 
DateRange = namedtuple("DateRange", ["start", "end"])  # noqa: PYI024
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the local calendar platform."""
    coordinator: EGSCalendarUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
 
    entities = [
        EGSCalendar(coordinator, entry.entry_id, CalendarType.FREE),
        EGSCalendar(coordinator, entry.entry_id, CalendarType.DISCOUNT),
    ]
    async_add_entities(entities)
 
 
class EGSCalendar(CoordinatorEntity[EGSCalendarUpdateCoordinator], CalendarEntity):
    """A calendar entity by Epic Games Store."""
 
    _attr_has_entity_name = True
 
    def __init__(
        self,
        coordinator: EGSCalendarUpdateCoordinator,
        config_entry_id: str,
        cal_type: CalendarType,
    ) -> None:
        """Initialize EGSCalendar."""
        super().__init__(coordinator)
        self._cal_type_cal_type = cal_type
        self._attr_translation_key_attr_translation_key = f"{cal_type}_games"
        self._attr_unique_id_attr_unique_id = f"{config_entry_id}-{cal_type}"
        self._attr_device_info_attr_device_info = DeviceInfo(
            entry_type=DeviceEntryType.SERVICE,
            identifiers={(DOMAIN, config_entry_id)},
            manufacturer="Epic Games Store",
            name="Epic Games Store",
        )
 
    @property
    def event(self) -> CalendarEvent | None:
        """Return the next upcoming event."""
        if event := self.coordinator.data[self._cal_type_cal_type]:
            return _get_calendar_event(event[0])
        return None
 
    async def async_get_events(
        self, hass: HomeAssistant, start_date: datetime, end_date: datetime
    ) -> list[CalendarEvent]:
        """Get all events in a specific time frame."""
        events = filter(
            lambda game: _are_date_range_overlapping(
                DateRange(start=game["discount_start_at"], end=game["discount_end_at"]),
                DateRange(start=start_date, end=end_date),
            ),
            self.coordinator.data[self._cal_type_cal_type],
        )
        return [_get_calendar_event(event) for event in events]
 
 
def _get_calendar_event(event: dict[str, Any]) -> CalendarEvent:
    """Return a CalendarEvent from an API event."""
    return CalendarEvent(
        summary=event["title"],
        start=event["discount_start_at"],
        end=event["discount_end_at"],
        description=f"{event['description']}\n\n{event['url']}",
    )
 
 
def _are_date_range_overlapping(range1: DateRange, range2: DateRange) -> bool:
    """Return a CalendarEvent from an API event."""
    latest_start = max(range1.start, range2.start)
    earliest_end = min(range1.end, range2.end)
    delta = (earliest_end - latest_start).days + 1
    overlap = max(0, delta)
    return overlap > 0