Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sensor unit of measurement validation for device classes #84366

Merged
merged 2 commits into from
Dec 21, 2022

Conversation

frenck
Copy link
Member

@frenck frenck commented Dec 21, 2022

Proposed change

This PR adds validation for the units of measurement used by sensor entities when those entities have a device class.

Device classes limit their use of units, as documented in our end-user and developer documentation.

The idea is that this would help with strange/inconsistent occurrences and reduce the need to watch out for these things in code reviews.

In the future (e.g., 2023.6), we could change this to raise instead of a warning. Each warning is currently logged just once.

Example warning;

2022-12-21 13:08:06.195 WARNING (MainThread) [homeassistant.components.sensor] Entity sensor.today_energy (<class 'homeassistant.components.demo.sensor.DemoSumSensor'>) is using native unit of measurement 'cows' which is not a valid unit for the device class ('energy') it is using; 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+demo%22

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 #
  • This PR is related to issue:
  • Link to documentation pull request:

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:

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:

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (sensor) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of sensor 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 sensor Removes the current integration label and assignees on the issue, add the integration domain after the command.

@@ -453,6 +478,74 @@ class SensorStateClass(StrEnum):
SensorDeviceClass.WIND_SPEED: SpeedConverter,
}

DEVICE_CLASS_UNITS: dict[SensorDeviceClass, set[type[StrEnum] | str | None]] = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to have the same validation for number entities?
And would it make sense to have this dict shared somewhere?

Copy link
Member Author

@frenck frenck Dec 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have no validations on numbers whatsoever at this point. But yes, we can add more validation there too.

I suggest doing that at a later point.

Essentially, those are not the same device classes... (we can enforce keeping them in sync though)

UnitOfVolume.CUBIC_METERS,
},
SensorDeviceClass.HUMIDITY: {PERCENTAGE},
SensorDeviceClass.ILLUMINANCE: {LIGHT_LUX, "lm"},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if lm should be kept here. Lumen is a unit of Luminous flux, not a unit of Illuminance

I have opened an architecture discussion about it in home-assistant/architecture#843

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is not adding something new, the discussion is fine, but it doesn't have to block this.

@frenck frenck merged commit c832982 into dev Dec 21, 2022
@frenck frenck deleted the frenck-2022-2301 branch December 21, 2022 15:14
@github-actions github-actions bot locked and limited conversation to collaborators Dec 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants