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

Mark unique_id() virtual method as deprecated #4538

Merged
merged 2 commits into from
Mar 9, 2023

Conversation

oxan
Copy link
Member

@oxan oxan commented Mar 8, 2023

What does this implement/fix?

These old-style methods are only present for (text) sensors and not for all other types of entities. They are overridden and implemented by only a handful of sensors; the vast majority use the automatic unique ID generation. We'll likely never be able to remove them due to backwards compatibility, but let's stop the bleeding and mark them as deprecated so that we don't get any more components that implement them.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other

Related issue or feature (if applicable): fixes

Pull request in esphome-docs with documentation (if applicable): esphome/esphome-docs#

Test Environment

  • ESP32
  • ESP32 IDF
  • ESP8266
  • RP2040

Example entry for config.yaml:

# Example config.yaml

Checklist:

  • The code change is tested and works locally.
  • Tests have been added to verify that the new code works (under tests/ folder).

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

@probot-esphome
Copy link

probot-esphome bot commented Mar 8, 2023

Hey there @esphome/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!
(message by CodeOwnersMention)

@jesserockz jesserockz added this pull request to the merge queue Mar 9, 2023
Merged via the queue into esphome:dev with commit afc1c83 Mar 9, 2023
@oxan oxan deleted the misc/deprecate-unique_id-override branch March 9, 2023 07:49
@github-actions github-actions bot locked and limited conversation to collaborators Mar 11, 2023
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.

2 participants