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

Don't use coordinator for Button and Event #116408

Draft
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

gjohansson-ST
Copy link
Member

Proposed change

Don't use the coordinator for ButtonEntity and EventEntity as they are providing

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:

@gjohansson-ST gjohansson-ST requested a review from a team as a code owner April 29, 2024 16:48
@home-assistant home-assistant bot added cla-signed core new-feature small-pr PRs with less than 30 lines. labels Apr 29, 2024
@elupus
Copy link
Contributor

elupus commented Apr 29, 2024

So this just doesnt make sense? Why use the base class in the first case? If you need it for the availability (which button and event should respect) just ignore the callback.

@gjohansson-ST gjohansson-ST marked this pull request as draft April 29, 2024 19:10
@gjohansson-ST
Copy link
Member Author

So this just doesnt make sense? Why use the base class in the first case? If you need it for the availability (which button and event should respect) just ignore the callback.

That's true but it seems as a pretty common thing to do "by mistake" so this is just to avoid registering for a listener if there is no point in having one.

@gjohansson-ST gjohansson-ST marked this pull request as ready for review May 1, 2024 13:53
super().__init_subclass__(**kwargs)
# ButtonEntity and EventEntity provide their own states
# and should not register to use the coordinator for state updates.
if ButtonEntity in cls.__mro__ or EventEntity in cls.__mro__:
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 think the coordinator should know about platforms. It's up to each integration to implement the coordinator entity or not do that.

Copy link
Member Author

Choose a reason for hiding this comment

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

Comes from the side-discussion here in discord.
It just creates unnecessary overhead by registering listeners for entities which has no use of it.

Copy link
Member

Choose a reason for hiding this comment

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

Integrations shouldn't use the coordinator entity if they shouldn't use it.

@home-assistant home-assistant bot marked this pull request as draft May 1, 2024 17:32
@home-assistant
Copy link

home-assistant bot commented May 1, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants