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 mqtt callback typing #118104

Merged
merged 3 commits into from
May 25, 2024
Merged

Fix mqtt callback typing #118104

merged 3 commits into from
May 25, 2024

Conversation

cdce8p
Copy link
Member

@cdce8p cdce8p commented May 25, 2024

Proposed change

Replace AsyncMessageCallbackType | MessageCallbackType with Callable[[ReceiveMessage], Coroutine[Any, Any, None] | None].

The former can cause issues when the type passed to HassJob. Since the return type is stored separately, the return type of the union of callables is combined to Coroutine[Any, Any, None] | None which then causes problems when the job is passed to a method only accepting AsyncMessageCallbackType | MessageCallbackType.

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:

@home-assistant
Copy link

Hey there @emontnemery, @jbouwh, @bdraco, mind taking a look at this pull request as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt 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 mqtt Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@jbouwh
Copy link
Contributor

jbouwh commented May 25, 2024

Thanx @cdce8p , We are working on the callbacks for all platforms and also the subscribe functions. I'll ping @bdraco to have a look at this one.

@cdce8p
Copy link
Member Author

cdce8p commented May 25, 2024

Thanx @cdce8p , We are working on the callbacks for all platforms and also the subscribe functions. I'll ping @bdraco to have a look at this one.

It will only be an error with the next mypy-dev version, so we could wait a bit if necessary. Just wanted to get a head start and fix it.

Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

LGTM,
Thanx @cdce8p 👍

@cdce8p cdce8p merged commit 2f16c3a into home-assistant:dev May 25, 2024
38 checks passed
@cdce8p cdce8p deleted the fix-mqtt-typing branch May 25, 2024 16:59
@github-actions github-actions bot locked and limited conversation to collaborators May 26, 2024
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