Address late comment for NextDNS (#74365)

* Simplify code

* Use async_config_entry_first_refresh()

* Use lambda to get value
This commit is contained in:
Maciej Bieniek 2022-07-06 05:12:09 +02:00 committed by GitHub
parent f5e3344bfc
commit a2a4361d6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 10 deletions

View File

@ -153,8 +153,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
except (ApiError, ClientConnectorError, asyncio.TimeoutError) as err: except (ApiError, ClientConnectorError, asyncio.TimeoutError) as err:
raise ConfigEntryNotReady from err raise ConfigEntryNotReady from err
hass.data.setdefault(DOMAIN, {}) hass.data.setdefault(DOMAIN, {})[entry.entry_id] = {}
hass.data[DOMAIN].setdefault(entry.entry_id, {})
tasks = [] tasks = []
@ -165,7 +164,9 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
hass, nextdns, profile_id, update_interval hass, nextdns, profile_id, update_interval
) )
tasks.append( tasks.append(
hass.data[DOMAIN][entry.entry_id][coordinator_name].async_refresh() hass.data[DOMAIN][entry.entry_id][
coordinator_name
].async_config_entry_first_refresh()
) )
await asyncio.gather(*tasks) await asyncio.gather(*tasks)

View File

@ -1,8 +1,9 @@
"""Support for the NextDNS service.""" """Support for the NextDNS service."""
from __future__ import annotations from __future__ import annotations
from collections.abc import Callable
from dataclasses import dataclass from dataclasses import dataclass
from typing import cast from typing import Any, cast
from homeassistant.components.sensor import ( from homeassistant.components.sensor import (
SensorEntity, SensorEntity,
@ -14,6 +15,7 @@ from homeassistant.const import PERCENTAGE
from homeassistant.core import HomeAssistant, callback from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity import EntityCategory from homeassistant.helpers.entity import EntityCategory
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import StateType
from homeassistant.helpers.update_coordinator import CoordinatorEntity from homeassistant.helpers.update_coordinator import CoordinatorEntity
from . import NextDnsUpdateCoordinator from . import NextDnsUpdateCoordinator
@ -34,6 +36,7 @@ class NextDnsSensorRequiredKeysMixin:
"""Class for NextDNS entity required keys.""" """Class for NextDNS entity required keys."""
coordinator_type: str coordinator_type: str
value: Callable[[Any], StateType]
@dataclass @dataclass
@ -52,6 +55,7 @@ SENSORS = (
name="{profile_name} DNS Queries", name="{profile_name} DNS Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.all_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="blocked_queries", key="blocked_queries",
@ -61,6 +65,7 @@ SENSORS = (
name="{profile_name} DNS Queries Blocked", name="{profile_name} DNS Queries Blocked",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.blocked_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="relayed_queries", key="relayed_queries",
@ -70,6 +75,7 @@ SENSORS = (
name="{profile_name} DNS Queries Relayed", name="{profile_name} DNS Queries Relayed",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.relayed_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="blocked_queries_ratio", key="blocked_queries_ratio",
@ -79,6 +85,7 @@ SENSORS = (
name="{profile_name} DNS Queries Blocked Ratio", name="{profile_name} DNS Queries Blocked Ratio",
native_unit_of_measurement=PERCENTAGE, native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.blocked_queries_ratio,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="doh_queries", key="doh_queries",
@ -89,6 +96,7 @@ SENSORS = (
name="{profile_name} DNS-over-HTTPS Queries", name="{profile_name} DNS-over-HTTPS Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.doh_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="dot_queries", key="dot_queries",
@ -99,6 +107,7 @@ SENSORS = (
name="{profile_name} DNS-over-TLS Queries", name="{profile_name} DNS-over-TLS Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.dot_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="doq_queries", key="doq_queries",
@ -109,6 +118,7 @@ SENSORS = (
name="{profile_name} DNS-over-QUIC Queries", name="{profile_name} DNS-over-QUIC Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.doq_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="udp_queries", key="udp_queries",
@ -119,6 +129,7 @@ SENSORS = (
name="{profile_name} UDP Queries", name="{profile_name} UDP Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.udp_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="doh_queries_ratio", key="doh_queries_ratio",
@ -129,6 +140,7 @@ SENSORS = (
name="{profile_name} DNS-over-HTTPS Queries Ratio", name="{profile_name} DNS-over-HTTPS Queries Ratio",
native_unit_of_measurement=PERCENTAGE, native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.doh_queries_ratio,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="dot_queries_ratio", key="dot_queries_ratio",
@ -139,6 +151,7 @@ SENSORS = (
name="{profile_name} DNS-over-TLS Queries Ratio", name="{profile_name} DNS-over-TLS Queries Ratio",
native_unit_of_measurement=PERCENTAGE, native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.dot_queries_ratio,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="doq_queries_ratio", key="doq_queries_ratio",
@ -149,6 +162,7 @@ SENSORS = (
name="{profile_name} DNS-over-QUIC Queries Ratio", name="{profile_name} DNS-over-QUIC Queries Ratio",
native_unit_of_measurement=PERCENTAGE, native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.doq_queries_ratio,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="udp_queries_ratio", key="udp_queries_ratio",
@ -159,6 +173,7 @@ SENSORS = (
name="{profile_name} UDP Queries Ratio", name="{profile_name} UDP Queries Ratio",
native_unit_of_measurement=PERCENTAGE, native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.udp_queries_ratio,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="encrypted_queries", key="encrypted_queries",
@ -169,6 +184,7 @@ SENSORS = (
name="{profile_name} Encrypted Queries", name="{profile_name} Encrypted Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.encrypted_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="unencrypted_queries", key="unencrypted_queries",
@ -179,6 +195,7 @@ SENSORS = (
name="{profile_name} Unencrypted Queries", name="{profile_name} Unencrypted Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.unencrypted_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="encrypted_queries_ratio", key="encrypted_queries_ratio",
@ -189,6 +206,7 @@ SENSORS = (
name="{profile_name} Encrypted Queries Ratio", name="{profile_name} Encrypted Queries Ratio",
native_unit_of_measurement=PERCENTAGE, native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.encrypted_queries_ratio,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="ipv4_queries", key="ipv4_queries",
@ -199,6 +217,7 @@ SENSORS = (
name="{profile_name} IPv4 Queries", name="{profile_name} IPv4 Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.ipv4_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="ipv6_queries", key="ipv6_queries",
@ -209,6 +228,7 @@ SENSORS = (
name="{profile_name} IPv6 Queries", name="{profile_name} IPv6 Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.ipv6_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="ipv6_queries_ratio", key="ipv6_queries_ratio",
@ -219,6 +239,7 @@ SENSORS = (
name="{profile_name} IPv6 Queries Ratio", name="{profile_name} IPv6 Queries Ratio",
native_unit_of_measurement=PERCENTAGE, native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.ipv6_queries_ratio,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="validated_queries", key="validated_queries",
@ -229,6 +250,7 @@ SENSORS = (
name="{profile_name} DNSSEC Validated Queries", name="{profile_name} DNSSEC Validated Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.validated_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="not_validated_queries", key="not_validated_queries",
@ -239,6 +261,7 @@ SENSORS = (
name="{profile_name} DNSSEC Not Validated Queries", name="{profile_name} DNSSEC Not Validated Queries",
native_unit_of_measurement="queries", native_unit_of_measurement="queries",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.not_validated_queries,
), ),
NextDnsSensorEntityDescription( NextDnsSensorEntityDescription(
key="validated_queries_ratio", key="validated_queries_ratio",
@ -249,6 +272,7 @@ SENSORS = (
name="{profile_name} DNSSEC Validated Queries Ratio", name="{profile_name} DNSSEC Validated Queries Ratio",
native_unit_of_measurement=PERCENTAGE, native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value=lambda data: data.validated_queries_ratio,
), ),
) )
@ -278,7 +302,7 @@ class NextDnsSensor(CoordinatorEntity, SensorEntity):
def __init__( def __init__(
self, self,
coordinator: NextDnsUpdateCoordinator, coordinator: NextDnsUpdateCoordinator,
description: SensorEntityDescription, description: NextDnsSensorEntityDescription,
) -> None: ) -> None:
"""Initialize.""" """Initialize."""
super().__init__(coordinator) super().__init__(coordinator)
@ -287,13 +311,11 @@ class NextDnsSensor(CoordinatorEntity, SensorEntity):
self._attr_name = cast(str, description.name).format( self._attr_name = cast(str, description.name).format(
profile_name=coordinator.profile_name profile_name=coordinator.profile_name
) )
self._attr_native_value = getattr(coordinator.data, description.key) self._attr_native_value = description.value(coordinator.data)
self.entity_description = description self.entity_description: NextDnsSensorEntityDescription = description
@callback @callback
def _handle_coordinator_update(self) -> None: def _handle_coordinator_update(self) -> None:
"""Handle updated data from the coordinator.""" """Handle updated data from the coordinator."""
self._attr_native_value = getattr( self._attr_native_value = self.entity_description.value(self.coordinator.data)
self.coordinator.data, self.entity_description.key
)
self.async_write_ha_state() self.async_write_ha_state()