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

Migrate binary sensor device classes to StrEnum #60651

Merged
merged 3 commits into from
Dec 1, 2021
Merged

Conversation

frenck
Copy link
Member

@frenck frenck commented Nov 30, 2021

Breaking change

This PR deprecates the use of the DEVICE_CLASS_* constants and DEVICE_CLASSES constant for binary_sensor entities. Use the BinarySensorDeviceClass enum instead.

Proposed change

Replaces the device class constants of the binary sensor platform with a StrEnum.

The old CONST is currently still accepted and working (backward compatible). This gives core and custom integration time to adjust.

At this point, I've not set a deprecation period as it is hard to indicate how long this would take.

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)
  • 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-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 (demo) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@probot-home-assistant
Copy link

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

@probot-home-assistant
Copy link

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

@frenck frenck marked this pull request as draft November 30, 2021 18:20
@frenck frenck marked this pull request as ready for review November 30, 2021 20:23
@@ -29,3 +33,5 @@ async def async_setup_entry(

class UpCloudBinarySensor(UpCloudServerEntity, BinarySensorEntity):
"""Representation of an UpCloud server sensor."""

_attr_device_class = BinarySensorDeviceClass.POWER
Copy link
Member

Choose a reason for hiding this comment

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

I don't know this integration, is this correct?

Copy link
Member Author

Choose a reason for hiding this comment

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

Previously it used a hard coded string in its parent class to "power" for all iets platforms...

So this makes it specific on this platform to fix that (and make mypy happy as it now has catches this bug)

@frenck frenck merged commit 2b8f245 into dev Dec 1, 2021
@frenck frenck deleted the frenck-2021-3134 branch December 1, 2021 07:12
@github-actions github-actions bot locked and limited conversation to collaborators Dec 2, 2021
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