Skip to content

Load template extensions by class to prevent import deadlock#170995

Merged
balloob merged 1 commit into
devfrom
frenck-2026-0569
May 17, 2026
Merged

Load template extensions by class to prevent import deadlock#170995
balloob merged 1 commit into
devfrom
frenck-2026-0569

Conversation

@frenck
Copy link
Copy Markdown
Member

@frenck frenck commented May 17, 2026

Breaking change

Proposed change

The template integration fails to load on startup with a DeadlockError in the MathExtension Jinja2 extension. This happens because template extensions are registered by import path string (e.g., "homeassistant.helpers.template.extensions.MathExtension"), which causes Jinja2 to call import_module() at runtime. When multiple threads create a TemplateEnvironment simultaneously during startup, the Python import lock deadlocks.

This changes the extension loading to import the classes at module level and pass them directly to add_extension(), avoiding runtime imports entirely. The existing jinja2.ext extensions remain as strings since those are external and always pre-loaded.

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

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:

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 17, 2026 16:34
@frenck frenck requested a review from a team as a code owner May 17, 2026 16:34
@frenck frenck added this to the 2026.5.3 milestone May 17, 2026
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

Fixes a startup deadlock in the template integration by avoiding Jinja2 runtime imports of Home Assistant’s template extensions, which could deadlock when multiple threads create TemplateEnvironment instances concurrently.

Changes:

  • Import Home Assistant template extension classes at module import time.
  • Register Home Assistant extensions with TemplateEnvironment.add_extension() by passing the extension classes directly instead of import-path strings.

@balloob balloob merged commit bdc9d88 into dev May 17, 2026
49 checks passed
@balloob balloob deleted the frenck-2026-0569 branch May 17, 2026 20:55
@github-actions github-actions Bot locked and limited conversation to collaborators May 18, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

template DeadlockError extensions math

3 participants