Statistics component fix device_class for incremental source sensors #88096

ThomDietrich · 2023-02-14T15:06:27Z

Proposed change

Fixes errors shown since 2023.02: #87376

This PR implements the proposal explained here: #87376 (comment)

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes Entity ... (<class 'homeassistant.components.statistics.sensor.StatisticsSensor'>) is using state class 'measurement' which is impossible considering device class ('energy') it is using #87376
This PR is related to issue: Entity ... (<class 'homeassistant.components.statistics.sensor.StatisticsSensor'>) is using state class 'measurement' which is impossible considering device class ('energy') it is using #87376
Link to documentation pull request: Not needed.

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

home-assistant · 2023-02-14T15:06:56Z

Hey there @fabaff, mind taking a look at this pull request as it has been labeled with an integration (statistics) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of statistics can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Change the title of the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign statistics Removes the current integration label and assignees on the issue, add the integration domain after the command.

ThomDietrich · 2023-02-14T15:07:52Z

@emontnemery thanks for your review!

homeassistant/components/statistics/sensor.py

emontnemery

Looks good, just a minor comment + question

homeassistant/components/statistics/sensor.py

emontnemery · 2023-02-15T08:29:56Z

homeassistant/components/statistics/sensor.py

+                self._update_listener()  # pragma: no cover
+                self._update_listener = None  # pragma: no cover


When does this happen?

Can't exactly tell you. I did not develop this part of the code. Pytest always showed missing coverage for these two lines, hence the comment. Maybe the code can be removed or changed, but I didn't feel the need.

There shouldn't be any pragma: no cover in homeassistant code.
It is better to have reduced coverage than invalid coverage.

Opened #88173

I do not agree and don't see how it would make sense in this particular case. Anyhow, understand the incentive generally and won't fight with you.

If the code is there, there must be a reason...

If it is dead code that can't be reached, then it should be removed

If it is not dead code, then we need to be reminded that coverage should be improved

The only time when no cover is in use is when we raise an exception for unreachable code.

There is not reason to introduce fake coverage. Epenet is right here, it should not have had these flags. I've therefore merged the PR to remove them.

On second thought @epenet I agree with you. I did not develop this code nor did I ever touch it. I believe it's "dead code" as you called it and will do some tests and provide a fix in a future PR.

emontnemery

Thanks, @ThomDietrich 👍

frenck · 2023-02-15T14:10:57Z

homeassistant/components/statistics/sensor.py

+            if sensor_device_class is None:
+                return None


Can we add coverage for this one?

Will do! This wasn't raised by pytest before the changes regarding DEVICE_CLASS_STATE_CLASSES

frenck · 2023-02-15T14:12:59Z

homeassistant/components/statistics/sensor.py

+            sensor_device_class = try_parse_enum(SensorDeviceClass, source_device_class)
+            if sensor_device_class is None:


Wallrus could have been used.

Could certainly, but then black will line-break this logic into oblivion!? I already had arguably better code locally.
You wanna suggest something? Maybe you have a better idea than me

My suggestion was already above, just wallrus it. We don't worry about formatting, that is what black is for.

Doesn't that contradict the wish for easily readable and maintainable code?

I'll have a look

Sure, that is what black is for. You dont' have to agree with its style, but it is the style we are using consistently. The formatting is maintained by black and thus not a concern.

homeassistant/components/statistics/sensor.py

frenck · 2023-02-15T14:14:06Z

homeassistant/components/statistics/sensor.py

+            sensor_state_classes = DEVICE_CLASS_STATE_CLASSES.get(
+                sensor_device_class, set()
+            )


The creation of an empty set() here is not needed.

frenck · 2023-02-15T14:14:28Z

homeassistant/components/statistics/sensor.py

+            sensor_state_classes = DEVICE_CLASS_STATE_CLASSES.get(
+                sensor_device_class, set()
+            )
+            if SensorStateClass.MEASUREMENT not in sensor_state_classes:


Wallrus could have been used.

frenck · 2023-02-15T14:15:19Z

homeassistant/components/statistics/sensor.py

+            if self.is_binary
+            else f"_stat_{characteristic}",


We don't allow the use of multi-line inline if-statements; as they become hard to read. Please adjust this in a followup PR to have a regular if statement.

frenck · 2023-02-15T14:18:30Z

homeassistant/components/statistics/sensor.py

+            source_device_class = source_state.attributes.get(ATTR_DEVICE_CLASS)
+            if source_device_class is None:
+                return None
+            sensor_device_class = try_parse_enum(SensorDeviceClass, source_device_class)


We do not need to parse the enum to try to look it up in DEVICE_CLASS_STATE_CLASSES.

ThomDietrich · 2023-02-15T15:26:46Z

@frenck thanks for the detailed feedback. I will provide a follow-up PR and reference you in a few days time. Cheers

…88096) * Return None device_class for incremental source sensors * Ignore linting error * Fix ignore linting error * Fix ignore linting error * Fix ignore linting error * Catch potential parsing error with enum

ianfretwell · 2023-02-16T09:13:32Z

I was assuming this PR was supposed to fix the following type of log entry - this is from 2023.2.5 - and so it hasn't. Or was I missing the point ?

And despite the log entry all these sensors appear to work just fine for me.

(I have no idea how else to paste this log entry in - this is the way it copies it to clipboard direct from the HA interface)

Logger: homeassistant.components.sensor
Source: components/sensor/init.py:503
Integration: Sensor (documentation, issues)
First occurred: 08:34:11 (13 occurrences)
Last logged: 08:34:13

Entity sensor.smart_meter_gas_import_this_week (<class 'homeassistant.components.mqtt.sensor.MqttSensor'>) is using state class 'measurement' which is impossible considering device class ('energy') it is using; expected None or one of 'total', 'total_increasing'; Please update your configuration if your entity is manually configured, otherwise create a bug report at https://github.com/home-assistant/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22integration%3A+mqtt%22
Entity sensor.smart_meter_gas_import_this_month (<class 'homeassistant.components.mqtt.sensor.MqttSensor'>) is using state class 'measurement' which is impossible considering device class ('energy') it is using; expected None or one of 'total', 'total_increasing'; Please update your configuration if your entity is manually configured, otherwise create a bug report at https://github.com/home-assistant/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22integration%3A+mqtt%22
Entity sensor.smart_meter_gas_import_unit_rate (<class 'homeassistant.components.mqtt.sensor.MqttSensor'>) is using state class 'measurement' which is impossible considering device class ('monetary') it is using; expected None or one of 'total'; Please update your configuration if your entity is manually configured, otherwise create a bug report at https://github.com/home-assistant/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22integration%3A+mqtt%22
Entity sensor.smart_meter_gas_import_standing_charge (<class 'homeassistant.components.mqtt.sensor.MqttSensor'>) is using state class 'measurement' which is impossible considering device class ('monetary') it is using; expected None or one of 'total'; Please update your configuration if your entity is manually configured, otherwise create a bug report at https://github.com/home-assistant/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22integration%3A+mqtt%22
Entity sensor.electric_cost_today_mercers (<class 'custom_components.hildebrandglow_dcc.sensor.Cost'>) is using state class 'total_increasing' which is impossible considering device class ('monetary') it is using; expected None or one of 'total'; Please update your configuration if your entity is manually configured, otherwise report it to the custom integration author.

frenck · 2023-02-16T09:14:25Z

@ianfretwell This is a merged PR. If you experience issues, please raise an issue in the issue tracker. Merged PR aren't trackable as an issue.

Thanks 👍

Return None device_class for incremental source sensors

1a53624

ThomDietrich requested a review from fabaff as a code owner February 14, 2023 15:06

home-assistant bot added bugfix cla-signed has-tests integration: statistics labels Feb 14, 2023

home-assistant bot assigned fabaff Feb 14, 2023

home-assistant bot added by-code-owner Quality Scale: internal labels Feb 14, 2023

emontnemery reviewed Feb 14, 2023

View reviewed changes

homeassistant/components/statistics/sensor.py Show resolved Hide resolved

ThomDietrich added 4 commits February 14, 2023 17:23

Ignore linting error

9b696e4

Fix ignore linting error

ff8aa00

Fix ignore linting error

04611ad

Fix ignore linting error

a47cf68

emontnemery requested changes Feb 15, 2023

View reviewed changes

Catch potential parsing error with enum

7abe544

emontnemery approved these changes Feb 15, 2023

View reviewed changes

emontnemery added this to the 2023.2.5 milestone Feb 15, 2023

emontnemery merged commit a0e0feb into home-assistant:dev Feb 15, 2023

epenet mentioned this pull request Feb 15, 2023

Expose DEVICE_CLASS_STATE_CLASSES sensor constant #88172

Merged

19 tasks

frenck reviewed Feb 15, 2023

View reviewed changes

homeassistant/components/statistics/sensor.py Show resolved Hide resolved

frenck reviewed Feb 15, 2023

View reviewed changes

homeassistant/components/statistics/sensor.py Show resolved Hide resolved

frenck reviewed Feb 15, 2023

View reviewed changes

balloob added the cherry-picked label Feb 15, 2023

balloob mentioned this pull request Feb 15, 2023

2023.2.5 #88190

Merged

github-actions bot locked and limited conversation to collaborators Feb 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Statistics component fix device_class for incremental source sensors #88096

Statistics component fix device_class for incremental source sensors #88096

ThomDietrich commented Feb 14, 2023

home-assistant bot commented Feb 14, 2023

ThomDietrich commented Feb 14, 2023

emontnemery left a comment •

edited

emontnemery Feb 15, 2023

ThomDietrich Feb 15, 2023

epenet Feb 15, 2023

epenet Feb 15, 2023

ThomDietrich Feb 15, 2023

epenet Feb 15, 2023

frenck Feb 15, 2023

ThomDietrich Feb 15, 2023

emontnemery left a comment

frenck Feb 15, 2023

ThomDietrich Feb 15, 2023

frenck Feb 15, 2023

ThomDietrich Feb 15, 2023

frenck Feb 15, 2023 •

edited

ThomDietrich Feb 16, 2023 •

edited

frenck Feb 16, 2023

frenck Feb 15, 2023

frenck Feb 15, 2023

frenck Feb 15, 2023

frenck Feb 15, 2023

ThomDietrich commented Feb 15, 2023

ianfretwell commented Feb 16, 2023

frenck commented Feb 16, 2023

		self._update_listener() # pragma: no cover
		self._update_listener = None # pragma: no cover

		sensor_device_class = try_parse_enum(SensorDeviceClass, source_device_class)
		if sensor_device_class is None:

Statistics component fix device_class for incremental source sensors #88096

Statistics component fix device_class for incremental source sensors #88096

Conversation

ThomDietrich commented Feb 14, 2023

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented Feb 14, 2023

ThomDietrich commented Feb 14, 2023

emontnemery left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emontnemery left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frenck Feb 15, 2023 • edited

Choose a reason for hiding this comment

ThomDietrich Feb 16, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ThomDietrich commented Feb 15, 2023

ianfretwell commented Feb 16, 2023

frenck commented Feb 16, 2023

emontnemery left a comment •

edited

frenck Feb 15, 2023 •

edited

ThomDietrich Feb 16, 2023 •

edited