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

Use display_precision if suggested_display_precision is None #110270

Merged
merged 8 commits into from
Apr 24, 2024

Conversation

rikroe
Copy link
Contributor

@rikroe rikroe commented Feb 11, 2024

Proposed change

This PR fixes unit conversion behavior for sensors if display_precision is set (by the user) but suggested_display_precision (set by the integration) is None.

Before, a suggested_display_precision of None would always cause the converted value to be rounded to 0 decimal places.

A suggested_display_precision of 0 does not show this behaviour.

Example

native_value: 6
native_unit_of_measurement: L
display_precision: 2 (set in the entity settings via UI)

Converted to gallons:
value: 2.0 - but should be 1.59
native_unit_of_measurement: gal

Cause

This happens due to https://github.com/home-assistant/core/blob/dev/homeassistant/components/sensor/__init__.py#L702-L724 which falls back to deducing the required precision if no suggested precision or sensor option for display precision is set.

_sensor_option_display_precision itself is set by _suggested_precision_or_none() which until now only read the suggested precision and not what the user had stored.

The added test case would fail without the changes to components/sensor/__init__.py as entity's state would be 621.0.

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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format 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 pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign sensor Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Contributor

@lellky lellky left a comment

Choose a reason for hiding this comment

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

Looks good to me!

Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

Thanks a lot @rikroe 👍

@rikroe
Copy link
Contributor Author

rikroe commented Apr 23, 2024

Thanks for looking into it! I can look into that only later tonight if needed.

Copy link
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

@bdraco bdraco merged commit 474a1a3 into home-assistant:dev Apr 24, 2024
38 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 25, 2024
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.

4 participants