Skip to content

Unload scripts and conditions created by template entities#169366

Merged
frenck merged 10 commits intodevfrom
template_unload_scripts_conditions
May 6, 2026
Merged

Unload scripts and conditions created by template entities#169366
frenck merged 10 commits intodevfrom
template_unload_scripts_conditions

Conversation

@emontnemery
Copy link
Copy Markdown
Contributor

Proposed change

Unload scripts and conditions created by template entities, and use the modern explicit API to evaluate conditions.

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:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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 diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings April 28, 2026 12:03
@emontnemery emontnemery requested a review from a team as a code owner April 28, 2026 12:03
@home-assistant home-assistant Bot added cla-signed code-quality has-tests integration: template small-pr PRs with less than 30 lines. Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage Top 50 Integration is ranked within the top 50 by usage labels Apr 28, 2026
@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @Petro31, @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (template) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of template can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign template Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aims to improve lifecycle management for resources created by template (trigger-based) entities by unloading associated scripts/conditions and by switching condition evaluation to the explicit ConditionsChecker.async_check() API.

Changes:

  • Add coordinator shutdown cleanup for the trigger-based template coordinator and evaluate conditions via ConditionsChecker.async_check(...).
  • Unload action scripts when a template entity is removed from Home Assistant.
  • Add tests covering coordinator shutdown cleanup and entity removal script unloading.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
tests/components/template/test_trigger_entity.py Adds regression tests asserting scripts/conditions are unloaded during coordinator shutdown and entity removal.
homeassistant/components/template/entity.py Adds async_will_remove_from_hass to unload per-entity action scripts on removal.
homeassistant/components/template/coordinator.py Types _cond_func as ConditionsChecker, uses async_check, and introduces async_shutdown cleanup.

Comment thread homeassistant/components/template/coordinator.py Outdated
Comment thread homeassistant/components/template/coordinator.py Outdated
Comment thread homeassistant/components/template/entity.py Outdated
Comment thread homeassistant/components/template/entity.py Outdated
Copy link
Copy Markdown
Contributor

@Petro31 Petro31 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@emontnemery
Copy link
Copy Markdown
Contributor Author

The bot comments about making sure the script is stopped before it's unloaded is valid. Set to draft until fixed.

@emontnemery emontnemery marked this pull request as draft April 28, 2026 14:02
Copilot AI review requested due to automatic review settings April 29, 2026 08:40
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comment thread homeassistant/components/template/coordinator.py Outdated
@emontnemery
Copy link
Copy Markdown
Contributor Author

Changes which addressed pre-existing behavior split out to #169480

@emontnemery emontnemery added this to the 2026.5.0 milestone Apr 29, 2026
@emontnemery emontnemery mentioned this pull request May 5, 2026
21 tasks
Copilot AI review requested due to automatic review settings May 5, 2026 09:18
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comment thread tests/components/template/test_trigger_entity.py
Copilot AI review requested due to automatic review settings May 6, 2026 11:19
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

Comment thread homeassistant/components/template/entity.py
Comment thread homeassistant/components/template/coordinator.py
@emontnemery emontnemery marked this pull request as ready for review May 6, 2026 11:49
Copilot AI review requested due to automatic review settings May 6, 2026 11:49
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comment on lines +253 to +261
mock_script = Mock(spec=Script)
mock_cond = Mock(spec=condition.ConditionsChecker)
coordinator._script = mock_script
coordinator._cond_func = mock_cond

await coordinator.async_shutdown()

mock_script.async_unload.assert_called_once()
mock_cond.async_unload.assert_called_once()
@frenck frenck merged commit 923e099 into dev May 6, 2026
48 checks passed
@frenck frenck deleted the template_unload_scripts_conditions branch May 6, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

by-code-owner cherry-picked cla-signed code-quality has-tests integration: template Quality Scale: internal small-pr PRs with less than 30 lines. Top 50 Integration is ranked within the top 50 by usage Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants