jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-04-24 09:17:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Validate state class and unit of measurement for non-numeric sensors (#83344)

Browse Source 
* Validate state class and unit of measurement for non-numeric sensors

* Remove duration

* Fix rest tests
This commit is contained in:
Franck Nijhof 2022-12-06 00:07:02 +01:00 committed by GitHub
parent 91cdf0ecf7
commit 762eb57636
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 51 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
homeassistant/components/sensor/__init__.py
View File

@ -718,7 +718,6 @@ class SensorEntity(Entity):
unit_of_measurement = self.unit_of_measurement
value = self.native_value
device_class = self.device_class
state_class = self.state_class
# Received a datetime
if value is not None and device_class == DEVICE_CLASS_TIMESTAMP:
@ -755,6 +754,27 @@ class SensorEntity(Entity):
f"but provides state {value}:{type(value)} resulting in '{err}'"
) from err
# Sensors with device classes indicating a non-numeric value
# should not have a state class or unit of measurement
if device_class in {
SensorDeviceClass.DATE,
SensorDeviceClass.ENUM,
SensorDeviceClass.TIMESTAMP,
}:
if self.state_class:
raise ValueError(
f"Sensor {self.entity_id} has a state class and thus indicating "
"it has a numeric value; however, it has the non-numeric "
f"device class: {device_class}"
)
if unit_of_measurement:
raise ValueError(
f"Sensor {self.entity_id} has a unit of measurement and thus "
"indicating it has a numeric value; however, it has the "
f"non-numeric device class: {device_class}"
)
# Enum checks
if value is not None and (
device_class == SensorDeviceClass.ENUM or self.options is not None
@ -767,19 +787,6 @@ class SensorEntity(Entity):
f"Sensor {self.entity_id} is providing enum options, but {reason}"
)
if state_class:
raise ValueError(
f"Sensor {self.entity_id} has an state_class and thus indicating "
"it has a numeric value; however, it has the enum device class"
)
if unit_of_measurement:
raise ValueError(
f"Sensor {self.entity_id} has an unit of measurement and thus "
"indicating it has a numeric value; "
"however, it has the enum device class"
)
if (options := self.options) and value not in options:
raise ValueError(
f"Sensor {self.entity_id} provides state value '{value}', "

2
tests/components/rest/test_sensor.py
View File

@ -243,7 +243,6 @@ async def test_setup_timestamp(
"method": "GET",
"value_template": "{{ value_json.key }}",
"device_class": SensorDeviceClass.TIMESTAMP,
"state_class": SensorStateClass.MEASUREMENT,
}
},
)
@ -255,7 +254,6 @@ async def test_setup_timestamp(
state = hass.states.get("sensor.rest_sensor")
assert state.state == "2021-11-11T11:39:00+00:00"
assert state.attributes[ATTR_DEVICE_CLASS] == SensorDeviceClass.TIMESTAMP
assert state.attributes[ATTR_STATE_CLASS] is SensorStateClass.MEASUREMENT
assert "sensor.rest_sensor rendered invalid timestamp" not in caplog.text
assert "sensor.rest_sensor rendered timestamp without timezone" not in caplog.text

42
tests/components/sensor/test_init.py
View File

@ -1018,18 +1018,27 @@ async def test_invalid_enumeration_entity_without_device_class(
) in caplog.text
async def test_invalid_enumeration_with_state_class(
@pytest.mark.parametrize(
"device_class",
{
SensorDeviceClass.DATE,
SensorDeviceClass.ENUM,
SensorDeviceClass.TIMESTAMP,
},
)
async def test_non_numeric_device_class_with_state_class(
hass: HomeAssistant,
caplog: pytest.LogCaptureFixture,
enable_custom_integrations: None,
device_class: SensorDeviceClass,
):
"""Test warning on numeric entities that provide an enum."""
"""Test error on numeric entities that provide an state class."""
platform = getattr(hass.components, "test.sensor")
platform.init(empty=True)
platform.ENTITIES["0"] = platform.MockSensor(
name="Test",
native_value=42,
device_class=SensorDeviceClass.ENUM,
native_value=None,
device_class=device_class,
state_class=SensorStateClass.MEASUREMENT,
options=["option1", "option2"],
)
@ -1038,23 +1047,32 @@ async def test_invalid_enumeration_with_state_class(
await hass.async_block_till_done()
assert (
"Sensor sensor.test has an state_class and thus indicating "
"it has a numeric value; however, it has the enum device class"
"Sensor sensor.test has a state class and thus indicating it has a numeric "
f"value; however, it has the non-numeric device class: {device_class}"
) in caplog.text
async def test_invalid_enumeration_with_unit_of_measurement(
@pytest.mark.parametrize(
"device_class",
{
SensorDeviceClass.DATE,
SensorDeviceClass.ENUM,
SensorDeviceClass.TIMESTAMP,
},
)
async def test_non_numeric_device_class_with_unit_of_measurement(
hass: HomeAssistant,
caplog: pytest.LogCaptureFixture,
enable_custom_integrations: None,
device_class: SensorDeviceClass,
):
"""Test warning on numeric entities that provide an enum."""
"""Test error on numeric entities that provide an unit of measurement."""
platform = getattr(hass.components, "test.sensor")
platform.init(empty=True)
platform.ENTITIES["0"] = platform.MockSensor(
name="Test",
native_value=42,
device_class=SensorDeviceClass.ENUM,
native_value=None,
device_class=device_class,
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
options=["option1", "option2"],
)
@ -1063,6 +1081,6 @@ async def test_invalid_enumeration_with_unit_of_measurement(
await hass.async_block_till_done()
assert (
"Sensor sensor.test has an unit of measurement and thus indicating "
"it has a numeric value; however, it has the enum device class"
"Sensor sensor.test has a unit of measurement and thus indicating it has "
f"a numeric value; however, it has the non-numeric device class: {device_class}"
) in caplog.text