-
Notifications
You must be signed in to change notification settings - Fork 878
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
Add asyncio thread safety docs #2171
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bdraco
added a commit
to home-assistant/core
that referenced
this pull request
May 14, 2024
20 tasks
marcelveldt
reviewed
May 14, 2024
marcelveldt
reviewed
May 14, 2024
marcelveldt
reviewed
May 14, 2024
This reverts commit 1283d52.
bdraco
commented
May 14, 2024
frenck
approved these changes
May 14, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, thanks, @bdraco 👍
../Frenck
Thanks. It's already being used by custom component devs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Add asyncio thread safety docs.
Since introducing the thread safety checks in 2024.5, I've been watching for matching GitHub issues. Some changes to custom components refer to these checks as "undocumented breaking changes" in Home Assistant. These comments show that developers need help understanding
asyncio
concepts and thread safety. If they do not realize they have been using the wrong APIs or doing unsafe thread operations and think the check is a breaking change, they may likely create new non-thread-safe operations.I've also seen some custom components bypass the checks by switching to
asyncio.ensure_future
or callingloop.create_task
directly, which sadly makes the problem worse because the unsafe operation is now harder to find, and users end up reporting crashes that are hard to link to the component.We should help them determine which API calls should replace the non-thread-safe call to increase the chance the issues will get solved and make developing for Home Assistant easier.
Type of change
Additional information