evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add mixin classes for required keys in EntityDescription (#53610)

Browse source
This commit is contained in:
Marc Mueller 2021-07-28 11:50:13 +02:00 • committed by GitHub
parent 6d13466f8a
commit 553521a76b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 60 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
homeassistant/components/climacell/const.py
View file

@ -170,9 +170,6 @@ class ClimaCellSensorEntityDescription(SensorEntityDescription):
"`unit_imperial` and `unit_metric` both need to be None or both need " "`unit_imperial` and `unit_metric` both need to be None or both need "
"to be defined." "to be defined."
) )
if self.name is None: # pragma: no cover
raise TypeError
self.name_ = self.name
CC_SENSOR_TYPES = ( CC_SENSOR_TYPES = (

2
homeassistant/components/climacell/sensor.py
View file

@ -65,7 +65,7 @@ class BaseClimaCellSensorEntity(ClimaCellEntity, SensorEntity):
self._attr_entity_registry_enabled_default = False self._attr_entity_registry_enabled_default = False
self._attr_name = f"{self._config_entry.data[CONF_NAME]} - {description.name}" self._attr_name = f"{self._config_entry.data[CONF_NAME]} - {description.name}"
self._attr_unique_id = ( self._attr_unique_id = (
f"{self._config_entry.unique_id}_{slugify(description.name_)}" f"{self._config_entry.unique_id}_{slugify(description.name)}"
) )
self._attr_extra_state_attributes = {ATTR_ATTRIBUTION: self.attribution} self._attr_extra_state_attributes = {ATTR_ATTRIBUTION: self.attribution}
self._attr_unit_of_measurement = ( self._attr_unit_of_measurement = (

52
homeassistant/components/melcloud/sensor.py
View file

@ -22,21 +22,19 @@ from .const import DOMAIN
@dataclass @dataclass
class MelcloudSensorEntityDescription(SensorEntityDescription): class MelcloudRequiredKeysMixin:
"""Mixin for required keys."""
value_fn: Callable[[Any], float]
enabled: Callable[[Any], bool]
@dataclass
class MelcloudSensorEntityDescription(
SensorEntityDescription, MelcloudRequiredKeysMixin
):
"""Describes Melcloud sensor entity.""" """Describes Melcloud sensor entity."""
_value_fn: Callable[[Any], float] | None = None
_enabled: Callable[[Any], bool] | None = None
def __post_init__(self) -> None:
"""Ensure all required fields are set."""
if self._value_fn is None: # pragma: no cover
raise TypeError
if self._enabled is None: # pragma: no cover
raise TypeError
self.value_fn = self._value_fn
self.enabled = self._enabled
ATA_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = ( ATA_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
MelcloudSensorEntityDescription( MelcloudSensorEntityDescription(
@ -45,8 +43,8 @@ ATA_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
icon="mdi:thermometer", icon="mdi:thermometer",
unit_of_measurement=TEMP_CELSIUS, unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE, device_class=DEVICE_CLASS_TEMPERATURE,
_value_fn=lambda x: x.device.room_temperature, value_fn=lambda x: x.device.room_temperature,
_enabled=lambda x: True, enabled=lambda x: True,
), ),
MelcloudSensorEntityDescription( MelcloudSensorEntityDescription(
key="energy", key="energy",
@ -54,8 +52,8 @@ ATA_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
icon="mdi:factory", icon="mdi:factory",
unit_of_measurement=ENERGY_KILO_WATT_HOUR, unit_of_measurement=ENERGY_KILO_WATT_HOUR,
device_class=DEVICE_CLASS_ENERGY, device_class=DEVICE_CLASS_ENERGY,
_value_fn=lambda x: x.device.total_energy_consumed, value_fn=lambda x: x.device.total_energy_consumed,
_enabled=lambda x: x.device.has_energy_consumed_meter, enabled=lambda x: x.device.has_energy_consumed_meter,
), ),
) )
ATW_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = ( ATW_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
@ -65,8 +63,8 @@ ATW_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
icon="mdi:thermometer", icon="mdi:thermometer",
unit_of_measurement=TEMP_CELSIUS, unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE, device_class=DEVICE_CLASS_TEMPERATURE,
_value_fn=lambda x: x.device.outside_temperature, value_fn=lambda x: x.device.outside_temperature,
_enabled=lambda x: True, enabled=lambda x: True,
), ),
MelcloudSensorEntityDescription( MelcloudSensorEntityDescription(
key="tank_temperature", key="tank_temperature",
@ -74,8 +72,8 @@ ATW_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
icon="mdi:thermometer", icon="mdi:thermometer",
unit_of_measurement=TEMP_CELSIUS, unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE, device_class=DEVICE_CLASS_TEMPERATURE,
_value_fn=lambda x: x.device.tank_temperature, value_fn=lambda x: x.device.tank_temperature,
_enabled=lambda x: True, enabled=lambda x: True,
), ),
) )
ATW_ZONE_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = ( ATW_ZONE_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
@ -85,8 +83,8 @@ ATW_ZONE_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
icon="mdi:thermometer", icon="mdi:thermometer",
unit_of_measurement=TEMP_CELSIUS, unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE, device_class=DEVICE_CLASS_TEMPERATURE,
_value_fn=lambda zone: zone.room_temperature, value_fn=lambda zone: zone.room_temperature,
_enabled=lambda x: True, enabled=lambda x: True,
), ),
MelcloudSensorEntityDescription( MelcloudSensorEntityDescription(
key="flow_temperature", key="flow_temperature",
@ -94,8 +92,8 @@ ATW_ZONE_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
icon="mdi:thermometer", icon="mdi:thermometer",
unit_of_measurement=TEMP_CELSIUS, unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE, device_class=DEVICE_CLASS_TEMPERATURE,
_value_fn=lambda zone: zone.flow_temperature, value_fn=lambda zone: zone.flow_temperature,
_enabled=lambda x: True, enabled=lambda x: True,
), ),
MelcloudSensorEntityDescription( MelcloudSensorEntityDescription(
key="return_temperature", key="return_temperature",
@ -103,8 +101,8 @@ ATW_ZONE_SENSORS: tuple[MelcloudSensorEntityDescription, ...] = (
icon="mdi:thermometer", icon="mdi:thermometer",
unit_of_measurement=TEMP_CELSIUS, unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE, device_class=DEVICE_CLASS_TEMPERATURE,
_value_fn=lambda zone: zone.return_temperature, value_fn=lambda zone: zone.return_temperature,
_enabled=lambda x: True, enabled=lambda x: True,
), ),
) )

63
homeassistant/components/netatmo/sensor.py
View file

@ -62,23 +62,22 @@ SUPPORTED_PUBLIC_SENSOR_TYPES: tuple[str, ...] = (
@dataclass @dataclass
class NetatmoSensorEntityDescription(SensorEntityDescription): class NetatmoRequiredKeysMixin:
"""Mixin for required keys."""
netatmo_name: str
@dataclass
class NetatmoSensorEntityDescription(SensorEntityDescription, NetatmoRequiredKeysMixin):
"""Describes Netatmo sensor entity.""" """Describes Netatmo sensor entity."""
_netatmo_name: str | None = None
def __post_init__(self) -> None:
"""Ensure all required attributes are set."""
if self._netatmo_name is None: # pragma: no cover
raise TypeError
self.netatmo_name = self._netatmo_name
SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = ( SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="temperature", key="temperature",
name="Temperature", name="Temperature",
_netatmo_name="Temperature", netatmo_name="Temperature",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
unit_of_measurement=TEMP_CELSIUS, unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE, device_class=DEVICE_CLASS_TEMPERATURE,
@ -86,14 +85,14 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="temp_trend", key="temp_trend",
name="Temperature trend", name="Temperature trend",
_netatmo_name="temp_trend", netatmo_name="temp_trend",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
icon="mdi:trending-up", icon="mdi:trending-up",
), ),
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="co2", key="co2",
name="CO2", name="CO2",
_netatmo_name="CO2", netatmo_name="CO2",
unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION, unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
device_class=DEVICE_CLASS_CO2, device_class=DEVICE_CLASS_CO2,
@ -101,7 +100,7 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="pressure", key="pressure",
name="Pressure", name="Pressure",
_netatmo_name="Pressure", netatmo_name="Pressure",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
unit_of_measurement=PRESSURE_MBAR, unit_of_measurement=PRESSURE_MBAR,
device_class=DEVICE_CLASS_PRESSURE, device_class=DEVICE_CLASS_PRESSURE,
@ -109,14 +108,14 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="pressure_trend", key="pressure_trend",
name="Pressure trend", name="Pressure trend",
_netatmo_name="pressure_trend", netatmo_name="pressure_trend",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
icon="mdi:trending-up", icon="mdi:trending-up",
), ),
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="noise", key="noise",
name="Noise", name="Noise",
_netatmo_name="Noise", netatmo_name="Noise",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
unit_of_measurement=SOUND_PRESSURE_DB, unit_of_measurement=SOUND_PRESSURE_DB,
icon="mdi:volume-high", icon="mdi:volume-high",
@ -124,7 +123,7 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="humidity", key="humidity",
name="Humidity", name="Humidity",
_netatmo_name="Humidity", netatmo_name="Humidity",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
unit_of_measurement=PERCENTAGE, unit_of_measurement=PERCENTAGE,
device_class=DEVICE_CLASS_HUMIDITY, device_class=DEVICE_CLASS_HUMIDITY,
@ -132,7 +131,7 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="rain", key="rain",
name="Rain", name="Rain",
_netatmo_name="Rain", netatmo_name="Rain",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
unit_of_measurement=LENGTH_MILLIMETERS, unit_of_measurement=LENGTH_MILLIMETERS,
icon="mdi:weather-rainy", icon="mdi:weather-rainy",
@ -140,7 +139,7 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="sum_rain_1", key="sum_rain_1",
name="Rain last hour", name="Rain last hour",
_netatmo_name="sum_rain_1", netatmo_name="sum_rain_1",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
unit_of_measurement=LENGTH_MILLIMETERS, unit_of_measurement=LENGTH_MILLIMETERS,
icon="mdi:weather-rainy", icon="mdi:weather-rainy",
@ -148,7 +147,7 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="sum_rain_24", key="sum_rain_24",
name="Rain today", name="Rain today",
_netatmo_name="sum_rain_24", netatmo_name="sum_rain_24",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
unit_of_measurement=LENGTH_MILLIMETERS, unit_of_measurement=LENGTH_MILLIMETERS,
icon="mdi:weather-rainy", icon="mdi:weather-rainy",
@ -156,7 +155,7 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="battery_percent", key="battery_percent",
name="Battery Percent", name="Battery Percent",
_netatmo_name="battery_percent", netatmo_name="battery_percent",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
unit_of_measurement=PERCENTAGE, unit_of_measurement=PERCENTAGE,
device_class=DEVICE_CLASS_BATTERY, device_class=DEVICE_CLASS_BATTERY,
@ -164,14 +163,14 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="windangle", key="windangle",
name="Direction", name="Direction",
_netatmo_name="WindAngle", netatmo_name="WindAngle",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
icon="mdi:compass-outline", icon="mdi:compass-outline",
), ),
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="windangle_value", key="windangle_value",
name="Angle", name="Angle",
_netatmo_name="WindAngle", netatmo_name="WindAngle",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
unit_of_measurement=DEGREE, unit_of_measurement=DEGREE,
icon="mdi:compass-outline", icon="mdi:compass-outline",
@ -179,7 +178,7 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="windstrength", key="windstrength",
name="Wind Strength", name="Wind Strength",
_netatmo_name="WindStrength", netatmo_name="WindStrength",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
unit_of_measurement=SPEED_KILOMETERS_PER_HOUR, unit_of_measurement=SPEED_KILOMETERS_PER_HOUR,
icon="mdi:weather-windy", icon="mdi:weather-windy",
@ -187,14 +186,14 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="gustangle", key="gustangle",
name="Gust Direction", name="Gust Direction",
_netatmo_name="GustAngle", netatmo_name="GustAngle",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
icon="mdi:compass-outline", icon="mdi:compass-outline",
), ),
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="gustangle_value", key="gustangle_value",
name="Gust Angle", name="Gust Angle",
_netatmo_name="GustAngle", netatmo_name="GustAngle",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
unit_of_measurement=DEGREE, unit_of_measurement=DEGREE,
icon="mdi:compass-outline", icon="mdi:compass-outline",
@ -202,7 +201,7 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="guststrength", key="guststrength",
name="Gust Strength", name="Gust Strength",
_netatmo_name="GustStrength", netatmo_name="GustStrength",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
unit_of_measurement=SPEED_KILOMETERS_PER_HOUR, unit_of_measurement=SPEED_KILOMETERS_PER_HOUR,
icon="mdi:weather-windy", icon="mdi:weather-windy",
@ -210,21 +209,21 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="reachable", key="reachable",
name="Reachability", name="Reachability",
_netatmo_name="reachable", netatmo_name="reachable",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
icon="mdi:signal", icon="mdi:signal",
), ),
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="rf_status", key="rf_status",
name="Radio", name="Radio",
_netatmo_name="rf_status", netatmo_name="rf_status",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
icon="mdi:signal", icon="mdi:signal",
), ),
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="rf_status_lvl", key="rf_status_lvl",
name="Radio Level", name="Radio Level",
_netatmo_name="rf_status", netatmo_name="rf_status",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT, unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
device_class=DEVICE_CLASS_SIGNAL_STRENGTH, device_class=DEVICE_CLASS_SIGNAL_STRENGTH,
@ -232,14 +231,14 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="wifi_status", key="wifi_status",
name="Wifi", name="Wifi",
_netatmo_name="wifi_status", netatmo_name="wifi_status",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
icon="mdi:wifi", icon="mdi:wifi",
), ),
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="wifi_status_lvl", key="wifi_status_lvl",
name="Wifi Level", name="Wifi Level",
_netatmo_name="wifi_status", netatmo_name="wifi_status",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT, unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
device_class=DEVICE_CLASS_SIGNAL_STRENGTH, device_class=DEVICE_CLASS_SIGNAL_STRENGTH,
@ -247,7 +246,7 @@ SENSOR_TYPES: tuple[NetatmoSensorEntityDescription, ...] = (
NetatmoSensorEntityDescription( NetatmoSensorEntityDescription(
key="health_idx", key="health_idx",
name="Health", name="Health",
_netatmo_name="health_idx", netatmo_name="health_idx",
entity_registry_enabled_default=True, entity_registry_enabled_default=True,
icon="mdi:cloud", icon="mdi:cloud",
), ),

4
homeassistant/util/__init__.py
View file

@ -79,9 +79,9 @@ def sanitize_path(path: str) -> str:
return path return path
def slugify(text: str, *, separator: str = "_") -> str: def slugify(text: str | None, *, separator: str = "_") -> str:
"""Slugify a given text.""" """Slugify a given text."""
if text == "": if text == "" or text is None:
return "" return ""
slug = unicode_slug.slugify(text, separator=separator) slug = unicode_slug.slugify(text, separator=separator)
return "unknown" if slug == "" else slug return "unknown" if slug == "" else slug

1
tests/util/test_init.py
View file

@ -74,6 +74,7 @@ def test_slugify():
assert util.slugify("$$$") == "unknown" assert util.slugify("$$$") == "unknown"
assert util.slugify("$something") == "something" assert util.slugify("$something") == "something"
assert util.slugify("") == "" assert util.slugify("") == ""
assert util.slugify(None) == ""
def test_repr_helper(): def test_repr_helper():