coordinator.py

Go to the documentation of this file.

"""Proxy to handle account communication with Renault servers."""
 
from __future__ import annotations
 
import asyncio
from collections.abc import Awaitable, Callable
from datetime import timedelta
import logging
from typing import TypeVar
 
from renault_api.kamereon.exceptions import (
    AccessDeniedException,
    KamereonResponseException,
    NotSupportedException,
)
from renault_api.kamereon.models import KamereonVehicleDataAttributes
 
from homeassistant.core import HomeAssistant
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
T = TypeVar("T", bound=KamereonVehicleDataAttributes | None)
 
# We have potentially 7 coordinators per vehicle
_PARALLEL_SEMAPHORE = asyncio.Semaphore(1)
 
 
class RenaultDataUpdateCoordinator(DataUpdateCoordinator[T]):
    """Handle vehicle communication with Renault servers."""
 
    def __init__(
        self,
        hass: HomeAssistant,
        logger: logging.Logger,
        *,
        name: str,
        update_interval: timedelta,
        update_method: Callable[[], Awaitable[T]],
    ) -> None:
        """Initialise coordinator."""
        super().__init__(
            hass,
            logger,
            name=name,
            update_interval=update_interval,
            update_method=update_method,
        )
        self.access_deniedaccess_denied = False
        self.not_supportednot_supported = False
        self._has_already_worked_has_already_worked = False
 
    async def _async_update_data(self) -> T:
        """Fetch the latest data from the source."""
        if self.update_methodupdate_method is None:
            raise NotImplementedError("Update method not implemented")
        try:
            async with _PARALLEL_SEMAPHORE:
                data = await self.update_methodupdate_method()
 
        except AccessDeniedException as err:
            # This can mean both a temporary error or a permanent error. If it has
            # worked before, make it temporary, if not disable the update interval.
            if not self._has_already_worked_has_already_worked:
                self.update_intervalupdate_intervalupdate_intervalupdate_intervalupdate_interval = None
                self.access_deniedaccess_denied = True
            raise UpdateFailed(f"This endpoint is denied: {err}") from err
 
        except NotSupportedException as err:
            # Disable because the vehicle does not support this Renault endpoint.
            self.update_intervalupdate_intervalupdate_intervalupdate_intervalupdate_interval = None
            self.not_supportednot_supported = True
            raise UpdateFailed(f"This endpoint is not supported: {err}") from err
 
        except KamereonResponseException as err:
            # Other Renault errors.
            raise UpdateFailed(f"Error communicating with API: {err}") from err
 
        self._has_already_worked_has_already_worked = True
        return data
 
    async def async_config_entry_first_refresh(self) -> None:
        """Refresh data for the first time when a config entry is setup.
 
        Contrary to base implementation, we are not raising ConfigEntryNotReady
        but only updating the `access_denied` and `not_supported` flags.
        """
        await self._async_refresh_async_refresh(log_failures=False, raise_on_auth_failed=True)