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

Fix inner callback decorators with partials #102873

Merged
merged 2 commits into from Oct 28, 2023
Merged

Fix inner callback decorators with partials #102873

merged 2 commits into from Oct 28, 2023

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Oct 26, 2023

Proposed change

The partials were wrapped with @callback, but the inner function needed to be wrapped with @callback instead. The check in async_listen was wrong and did not match the check in HassJob. Everything worked ok because the incorrectly decorated function were all run_immediately which always ran them as callbacks anyways.

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

To help with the load of incoming pull requests:

The partials were wrapped with @callback, but the inner function needed
to be wrapped with @callback instead. The check in async_listen was wrong
and did not match the check in HassJob
@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 (websocket_api) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of websocket_api 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 websocket_api Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@bdraco
Copy link
Member Author

bdraco commented Oct 26, 2023

Still something wrong here.. will have to look later though as out of time right now

@bdraco
Copy link
Member Author

bdraco commented Oct 26, 2023

I think this was actually working as expected because the check was wrong in both places so while it reported it would be run in the executor in in the repr it wouldn't actually be

Ie problem is mostly cosmetic but it does result in an extra asyncio.iscoroutine call every time a websocket subscription is made.

@bdraco bdraco removed this from the 2023.11.0 milestone Oct 26, 2023
@bdraco
Copy link
Member Author

bdraco commented Oct 26, 2023

Going to spend some more time digging at this to clean it up more.

@bdraco bdraco marked this pull request as ready for review October 27, 2023 02:03
@bdraco bdraco requested a review from a team as a code owner October 27, 2023 02:03
Copy link
Contributor

@elupus elupus left a comment

Choose a reason for hiding this comment

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

Lgtm

@bdraco
Copy link
Member Author

bdraco commented Oct 28, 2023

thanks

@bdraco bdraco merged commit 009dc91 into dev Oct 28, 2023
53 checks passed
@bdraco bdraco deleted the callback_func branch October 28, 2023 13:38
@github-actions github-actions bot locked and limited conversation to collaborators Oct 29, 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.

None yet

2 participants