Merge pull request #328 from kratz00/#179

SensorInfo: Add 'suggested_display_precision' (fixes #179)

Author: kratz00

ha_mqtt_discoverable/sensors.py

@@ -18,7 +18,7 @@
 
 import json
 import logging
-from typing import Any, Optional
+from typing import Annotated, Any, Optional
 
 from pydantic import Field
 
@@ -68,6 +68,10 @@ class SensorInfo(EntityInfo):
     When last_reset_value_template is set, the state_class option must be total.
     Available variables: entity_id.
     The entity_id can be used to reference the entity’s attributes."""
+    suggested_display_precision: None | Annotated[int, Field(ge=0)] = None
+    """
+    The number of decimals which should be used in the sensor’s state after rounding.
+    """
 
 
 class SwitchInfo(EntityInfo):

tests/test_sensor.py

@@ -16,35 +16,38 @@
 from unittest.mock import patch
 
 import pytest
+from pydantic import ValidationError
 
 from ha_mqtt_discoverable import Settings
 from ha_mqtt_discoverable.sensors import Sensor, SensorInfo
 
 
-@pytest.fixture(params=["°C", "kWh"])
-def sensor(request) -> Sensor:
-    mqtt_settings = Settings.MQTT(host="localhost")
-    sensor_info = SensorInfo(name="test", unit_of_measurement=request.param)
-    settings = Settings(mqtt=mqtt_settings, entity=sensor_info)
-    return Sensor(settings)
+@pytest.fixture
+def make_sensor():
+    def _make_sensor(suggested_display_precision: None | int = 2):
+        mqtt_settings = Settings.MQTT(host="localhost")
+        sensor_info = SensorInfo(name="test", unit_of_measurement="kWh", suggested_display_precision=suggested_display_precision)
+        settings = Settings(mqtt=mqtt_settings, entity=sensor_info)
+        return Sensor(settings)
 
+    return _make_sensor
 
-def test_required_config():
-    mqtt_settings = Settings.MQTT(host="localhost")
-    sensor_info = SensorInfo(name="test")
-    settings = Settings(mqtt=mqtt_settings, entity=sensor_info)
-    sensor = Sensor(settings)
+
+@pytest.fixture
+def sensor(make_sensor) -> Sensor:
+    return make_sensor()
+
+
+def test_required_config(sensor: Sensor):
     assert sensor is not None
 
 
 def test_generate_config(sensor: Sensor):
     config = sensor.generate_config()
 
     assert config is not None
-    # If we have defined a custom unit of measurement, check that is part of the
-    # output config
-    if sensor._entity.unit_of_measurement:
-        assert config["unit_of_measurement"] == sensor._entity.unit_of_measurement
+    assert config["unit_of_measurement"] == sensor._entity.unit_of_measurement
+    assert config["suggested_display_precision"] == sensor._entity.suggested_display_precision
 
 
 def test_update_state(sensor: Sensor):
@@ -66,3 +69,8 @@ def test_update_state_with_last_reset(sensor: Sensor):
 
         parameter_json = json.loads(parameter)
         assert parameter_json["last_reset"] == midnight.isoformat()
+
+
+def test_invalid_suggested_display_precision(make_sensor):
+    with pytest.raises(ValidationError):
+        make_sensor(suggested_display_precision=-1)