Extract shared base entity for Subaru#176246
Open
jpettitt wants to merge 3 commits into
Open
Conversation
Owns device_info, unique_id, and has_entity_name so every platform doesn't repeat the boilerplate. Two base classes since button/lock aren't coordinator-backed: SubaruEntity (device_info/unique_id/ has_entity_name) and SubaruCoordinatorEntity (adds the coordinator polling lifecycle and availability gating on top). Adopted by sensor, button, lock, and device_tracker. Pure refactor, no behavior change. Closes home-assistant#172844.
Contributor
|
Hey there @G-Two, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
Contributor
There was a problem hiding this comment.
Pull request overview
Extracts shared Subaru entity initialization and availability behavior into reusable base classes.
Changes:
- Adds base entity classes.
- Migrates four Subaru entity platforms.
- Preserves platform-specific tracker availability logic.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
button.py |
Uses SubaruEntity. |
device_tracker.py |
Uses coordinator base entity. |
entity.py |
Adds shared base classes. |
lock.py |
Uses SubaruEntity. |
sensor.py |
Uses coordinator base entity. |
Availability is gated on the relevant status keys being present, not on their values being non-None (test_device_tracker_none_data covers this) -- the previous wording overstated the guarantee.
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
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
Closes
common-modules(#172844, shape approved by @joostlek: two base classes, since button/lock aren'tCoordinatorEntity-backed).Extracts the device-info/unique-id/
has_entity_name/availability boilerplate that was duplicated acrosssensor.py,button.py,lock.py, anddevice_tracker.pyinto a newentity.py(SubaruEntity+SubaruCoordinatorEntity). Pure refactor, no behavior change.Type 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: