Explicitly pass in the config_entry in schlage coordinator (#137959)

explicitly pass in the config_entry in coordinator
This commit is contained in:
Michael 2025-02-09 15:41:52 +01:00 committed by GitHub
parent 7d4888920a
commit 42adc5c1e0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 28 additions and 21 deletions

View File

@ -5,12 +5,11 @@ from __future__ import annotations
from pycognito.exceptions import WarrantException from pycognito.exceptions import WarrantException
import pyschlage import pyschlage
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME, Platform from homeassistant.const import CONF_PASSWORD, CONF_USERNAME, Platform
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryAuthFailed from homeassistant.exceptions import ConfigEntryAuthFailed
from .coordinator import SchlageDataUpdateCoordinator from .coordinator import SchlageConfigEntry, SchlageDataUpdateCoordinator
PLATFORMS: list[Platform] = [ PLATFORMS: list[Platform] = [
Platform.BINARY_SENSOR, Platform.BINARY_SENSOR,
@ -20,8 +19,6 @@ PLATFORMS: list[Platform] = [
Platform.SWITCH, Platform.SWITCH,
] ]
type SchlageConfigEntry = ConfigEntry[SchlageDataUpdateCoordinator]
async def async_setup_entry(hass: HomeAssistant, entry: SchlageConfigEntry) -> bool: async def async_setup_entry(hass: HomeAssistant, entry: SchlageConfigEntry) -> bool:
"""Set up Schlage from a config entry.""" """Set up Schlage from a config entry."""
@ -32,7 +29,9 @@ async def async_setup_entry(hass: HomeAssistant, entry: SchlageConfigEntry) -> b
except WarrantException as ex: except WarrantException as ex:
raise ConfigEntryAuthFailed from ex raise ConfigEntryAuthFailed from ex
coordinator = SchlageDataUpdateCoordinator(hass, username, pyschlage.Schlage(auth)) coordinator = SchlageDataUpdateCoordinator(
hass, entry, username, pyschlage.Schlage(auth)
)
entry.runtime_data = coordinator entry.runtime_data = coordinator
await coordinator.async_config_entry_first_refresh() await coordinator.async_config_entry_first_refresh()
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS) await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)

View File

@ -14,8 +14,7 @@ from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import SchlageConfigEntry from .coordinator import LockData, SchlageConfigEntry, SchlageDataUpdateCoordinator
from .coordinator import LockData, SchlageDataUpdateCoordinator
from .entity import SchlageEntity from .entity import SchlageEntity

View File

@ -34,15 +34,28 @@ class SchlageData:
locks: dict[str, LockData] locks: dict[str, LockData]
type SchlageConfigEntry = ConfigEntry[SchlageDataUpdateCoordinator]
class SchlageDataUpdateCoordinator(DataUpdateCoordinator[SchlageData]): class SchlageDataUpdateCoordinator(DataUpdateCoordinator[SchlageData]):
"""The Schlage data update coordinator.""" """The Schlage data update coordinator."""
config_entry: ConfigEntry config_entry: SchlageConfigEntry
def __init__(self, hass: HomeAssistant, username: str, api: Schlage) -> None: def __init__(
self,
hass: HomeAssistant,
config_entry: SchlageConfigEntry,
username: str,
api: Schlage,
) -> None:
"""Initialize the class.""" """Initialize the class."""
super().__init__( super().__init__(
hass, LOGGER, name=f"{DOMAIN} ({username})", update_interval=UPDATE_INTERVAL hass,
LOGGER,
config_entry=config_entry,
name=f"{DOMAIN} ({username})",
update_interval=UPDATE_INTERVAL,
) )
self.data = SchlageData(locks={}) self.data = SchlageData(locks={})
self.api = api self.api = api

View File

@ -6,7 +6,7 @@ from typing import Any
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from . import SchlageConfigEntry from .coordinator import SchlageConfigEntry
async def async_get_config_entry_diagnostics( async def async_get_config_entry_diagnostics(

View File

@ -8,8 +8,7 @@ from homeassistant.components.lock import LockEntity
from homeassistant.core import HomeAssistant, callback from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import SchlageConfigEntry from .coordinator import LockData, SchlageConfigEntry, SchlageDataUpdateCoordinator
from .coordinator import LockData, SchlageDataUpdateCoordinator
from .entity import SchlageEntity from .entity import SchlageEntity

View File

@ -7,8 +7,7 @@ from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import SchlageConfigEntry from .coordinator import LockData, SchlageConfigEntry, SchlageDataUpdateCoordinator
from .coordinator import LockData, SchlageDataUpdateCoordinator
from .entity import SchlageEntity from .entity import SchlageEntity
_DESCRIPTIONS = ( _DESCRIPTIONS = (

View File

@ -8,12 +8,11 @@ from homeassistant.components.sensor import (
SensorEntityDescription, SensorEntityDescription,
SensorStateClass, SensorStateClass,
) )
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import PERCENTAGE, EntityCategory from homeassistant.const import PERCENTAGE, EntityCategory
from homeassistant.core import HomeAssistant, callback from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .coordinator import LockData, SchlageDataUpdateCoordinator from .coordinator import LockData, SchlageConfigEntry, SchlageDataUpdateCoordinator
from .entity import SchlageEntity from .entity import SchlageEntity
_SENSOR_DESCRIPTIONS: list[SensorEntityDescription] = [ _SENSOR_DESCRIPTIONS: list[SensorEntityDescription] = [
@ -29,7 +28,7 @@ _SENSOR_DESCRIPTIONS: list[SensorEntityDescription] = [
async def async_setup_entry( async def async_setup_entry(
hass: HomeAssistant, hass: HomeAssistant,
config_entry: ConfigEntry, config_entry: SchlageConfigEntry,
async_add_entities: AddEntitiesCallback, async_add_entities: AddEntitiesCallback,
) -> None: ) -> None:
"""Set up sensors based on a config entry.""" """Set up sensors based on a config entry."""

View File

@ -14,12 +14,11 @@ from homeassistant.components.switch import (
SwitchEntity, SwitchEntity,
SwitchEntityDescription, SwitchEntityDescription,
) )
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import EntityCategory from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .coordinator import LockData, SchlageDataUpdateCoordinator from .coordinator import LockData, SchlageConfigEntry, SchlageDataUpdateCoordinator
from .entity import SchlageEntity from .entity import SchlageEntity
@ -56,7 +55,7 @@ SWITCHES: tuple[SchlageSwitchEntityDescription, ...] = (
async def async_setup_entry( async def async_setup_entry(
hass: HomeAssistant, hass: HomeAssistant,
config_entry: ConfigEntry, config_entry: SchlageConfigEntry,
async_add_entities: AddEntitiesCallback, async_add_entities: AddEntitiesCallback,
) -> None: ) -> None:
"""Set up switches based on a config entry.""" """Set up switches based on a config entry."""