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

Deprecate calling async_listen and async_listen_once with run_immediately #115169

Merged
merged 10 commits into from
Apr 8, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Apr 8, 2024

Proposed change

Calling async_listen or async_listen_once with run_immediately is deprecated, and the keyword argument will be removed in 2025.5. Since its unlikely anyone was calling run_immediately with False as it was only ever in the event helper in core prior to the 2024.5 dev cycle, the default of True will always be used.

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:

needs

@home-assistant home-assistant bot added cla-signed core small-pr PRs with less than 30 lines. labels Apr 8, 2024
homeassistant/core.py Outdated Show resolved Hide resolved
homeassistant/core.py Outdated Show resolved Hide resolved
@bdraco bdraco mentioned this pull request Apr 8, 2024
20 tasks
@bdraco bdraco added the deprecation Indicates a breaking change to happen in the future label Apr 8, 2024
@bdraco bdraco marked this pull request as ready for review April 8, 2024 19:29
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, Nice running immediately is now the default!
Thnx @bdraco 👍

@jbouwh
Copy link
Contributor

jbouwh commented Apr 8, 2024

CI Failure is not related

@bdraco
Copy link
Member Author

bdraco commented Apr 8, 2024

thanks

@bdraco bdraco merged commit ca5ed27 into dev Apr 8, 2024
33 of 34 checks passed
@bdraco bdraco deleted the goodbye_run_immediately branch April 8, 2024 20:07
@github-actions github-actions bot locked and limited conversation to collaborators Apr 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed core deprecation Indicates a breaking change to happen in the future small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants