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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate switch device classes to StrEnum #60658

Merged
merged 2 commits into from Nov 30, 2021
Merged

Migrate switch device classes to StrEnum #60658

merged 2 commits into from Nov 30, 2021

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 switch entities. Use the SwitchDeviceClass enum instead.

Proposed change

Replaces the device class constants of the switch 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)

@project-bot project-bot bot added this to Needs review in Dev Nov 30, 2021
@frenck frenck marked this pull request as ready for review November 30, 2021 20:23
@frenck frenck requested review from scop and a team as code owners November 30, 2021 20:23
Dev automation moved this from Needs review to Reviewer approved Nov 30, 2021
@balloob balloob merged commit 542aef2 into dev Nov 30, 2021
@balloob balloob deleted the frenck-2021-3138 branch November 30, 2021 23:38
Dev automation moved this from Reviewer approved to Done Nov 30, 2021
@scop
Copy link
Member

scop commented Dec 1, 2021

Strictly speaking a mere deprecation is not yet a breaking change. Do we want to highlight this as such as a kind of a warning anyway?

It's unfortunate if we don't have anywhere to put a deprecation warning about using the old constants, with just a comment it's likely that few people will notice. Then again labeling as breaking change already now could help some.

@frenck
Copy link
Member Author

frenck commented Dec 1, 2021

Strictly speaking a mere deprecation is not yet a breaking change.

We generally mark all deprecation as breaking; As that makes it show up when we compile release notes at that point we can decide what to do.

@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
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants