Add availability template to config flow #147623
Conversation
|
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
|
cc @epenet |
|
Not ready for review, missing tests. Code for functionality is complete. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds an “Availability” template option under an “Advanced Options” section for all template entities in the config flow and refactors schema definitions across the template platform to merge those advanced options into each component’s config entry schema.
- Introduce
advanced_optionswith a collapsible “Availability” template selector inconfig_flow.py - Create a helper to flatten
advanced_optionsinto top-level options and update all template components to use it - Refactor base and feature schemas in
trigger_template_entity.pyand eachhomeassistant/components/template/*.pyto extend a shared common config-entry schema
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| helpers.py | Added rewrite_configy_entry_to_options_config to merge advanced options into options |
| config_flow.py | Added an advanced_options section for availability templates |
| helpers/trigger_template_entity.py | Split and renamed sensor base schema for advanced options support |
| template_entity.py & individual component files (sensor, switch, select, number, image, button, binary_sensor, alarm_control_panel) | Updated each schema to extend the new common config-entry schema and call the helper |
| strings.json | Added “Advanced Options” and “Availability” translations under each entity section |
Comments suppressed due to low confidence (2)
homeassistant/components/template/helpers.py:21
- The function name
rewrite_configy_entry_to_options_configcontains a typo. Rename it torewrite_config_entry_to_options_configfor clarity and consistency.
def rewrite_configy_entry_to_options_config(config_entry: ConfigEntry) -> ConfigType:
homeassistant/components/template/helpers.py:21
- Add unit tests for
rewrite_configy_entry_to_options_configto verify that mergingadvanced_optionsbehaves as expected and that options are flattened correctly.
def rewrite_configy_entry_to_options_config(config_entry: ConfigEntry) -> ConfigType:
| @@ -98,6 +146,14 @@ | |||
| "data_description": { | |||
| "device_id": "Select a device to link to this entity." | |||
There was a problem hiding this comment.
[nitpick] This hard-coded English string bypasses the standard translation key used elsewhere. Consider replacing it with the translation reference ([%key:component::template::config::step::sensor::data_description::device_id%]) for consistency.
| "device_id": "Select a device to link to this entity." | |
| "device_id": "[%key:component::template::config::step::sensor::data_description::device_id%]" |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
This should be in a separate PR
|
@Petro31 The function name rewrite_configy_entry_to_options_config contains a typo in helpers.py. |
| @@ -98,6 +146,14 @@ | |||
| "data_description": { | |||
| "device_id": "Select a device to link to this entity." | |||
| }, | |||
| "sections": { | |||
| "advanced_options": { | |||
| "name": "Advanced Options", | |||
There was a problem hiding this comment.
Sentence-casing:
| "name": "Advanced Options", | |
| "name": "Advanced options", |
Breaking change
Proposed change
Add availability template to config flow inside advanced options.
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: