Enforce async_load_fixture in async test functions #145709
Merged
Conversation
This file contains hidden or 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
|
Hey there @ispysoftware, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
|
Hey there @bieniu, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
|
Hey there @airgradienthq, @joostlek, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
This was referenced May 27, 2025
acbc473 to
a2ab53f
Compare
19 tasks
This was referenced Jun 2, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR enforces asynchronous fixture loading in async test functions by migrating existing calls and introducing a Pylint plugin to catch synchronous fixture usage.
- Replace synchronous
load_fixturecalls withasync_load_fixtureand addawaitin async tests - Introduce
hass_async_load_fixturesPylint plugin to flag any remaining sync fixture loads - Update
pyproject.tomlto load the new plugin
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/util/test_location.py | Migrate load_fixture to async_load_fixture and add hass fixture parameter |
| pyproject.toml | Add hass_async_load_fixtures to load-plugins |
| pylint/plugins/hass_async_load_fixtures.py | New Pylint checker that enforces async fixture loading |
Comments suppressed due to low confidence (3)
pylint/plugins/hass_async_load_fixtures.py:1
- [nitpick] The module docstring is misleading. Update it to reflect that this plugin enforces asynchronous fixture loading in tests.
"""Plugin for logger invocations."""
tests/util/test_location.py:80
- The test function uses
HomeAssistantin its type hint butHomeAssistantis not imported. Addfrom homeassistant.core import HomeAssistantat the top of the file.
hass: HomeAssistant,
pyproject.toml:164
- The Pylint plugin module path should be fully qualified. Change this to
"pylint.plugins.hass_async_load_fixtures"so that Pylint can locate the plugin.
"hass_async_load_fixtures",
edenhaus
approved these changes
Jun 30, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
SSIA, as follow-up to #144534
If a function is async, and
load_fixture, then the call should be migrated toasync_load_fixtureload_json_array_fixture, then the call should be migrated toasync_load_json_array_fixtureload_json_object_fixture, then the call should be migrated toasync_load_json_object_fixtureType of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: