Skip to content

Conversation

@arturpragacz
Copy link
Contributor

@arturpragacz arturpragacz commented Dec 16, 2025

Proposed change

Modernise condition checker in condition helper.

This PR cleans up and improves the new condition interface. In this it is a little similar to #152772, that adjusted the triggers.

The new condition interface is documented as experimental and not yet used by custom components, so we can still make these changes without problems.

It does the following improvements:

  • Drops the unneeded suffix: ConditionCheckerType -> ConditionChecker
  • Automatically calls trace_condition_function
  • Adjusts the signature of ConditionChecker
    • Removes superfluous hass argument
    • Types arguments as kwargs, to allow for future extensibility
    • Returns bool, as integrations should never return None from the check

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 link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

Code owners of device_automation can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign device_automation Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@home-assistant
Copy link

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

Code owner commands

Code owners of light can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign light Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@home-assistant
Copy link

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

Code owner commands

Code owners of zone can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign zone Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@home-assistant
Copy link

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

Code owner commands

Code owners of sun can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign sun Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
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 modernizes the condition checker interface in Home Assistant's helper module, making it more consistent, extensible, and type-safe. The changes rename ConditionCheckerType to ConditionChecker, remove the hass parameter from the new interface (conditions now use self._hass), switch to kwargs-based parameters for future extensibility, and automatically apply tracing through a wrapper function.

Key changes:

  • New ConditionChecker Protocol with typed kwargs using ConditionCheckParams TypedDict for extensibility
  • Backward compatibility maintained via ConditionCheckerType and ConditionCheckerTypeOptional for legacy code
  • Integration conditions (zone, sun, light, device_automation) updated to use new interface pattern with **kwargs: Unpack[ConditionCheckParams]

Reviewed changes

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

Show a summary per file
File Description
homeassistant/helpers/condition.py Introduces new ConditionChecker Protocol with TypedDict params, adds wrapper function _async_get_checker to automatically apply tracing, maintains backward compatibility types
homeassistant/helpers/script.py Updates type annotations to use ConditionCheckerTypeOptional for backward compatibility with existing script code
homeassistant/components/zone/condition.py Migrates to new interface: removes hass parameter, uses **kwargs: Unpack[ConditionCheckParams], accesses self._hass instead, removes manual trace_condition_function call
homeassistant/components/sun/condition.py Migrates to new interface: removes hass parameter, uses **kwargs: Unpack[ConditionCheckParams], accesses self._hass instead, removes manual trace_condition_function call
homeassistant/components/light/condition.py Migrates to new interface: removes hass parameter, uses **kwargs: Unpack[ConditionCheckParams], accesses self._hass instead, removes manual trace_condition_function call
homeassistant/components/device_automation/condition.py Updates to bridge old platform API (returns ConditionCheckerType) with new interface, implements wrapper to handle backward compatibility
tests/helpers/test_condition.py Updates test mocks to use new ConditionChecker type and **kwargs parameter pattern

@arturpragacz arturpragacz force-pushed the h/condition/modernise-condition-checker branch from 536f1bb to 3af6a70 Compare December 16, 2025 08:11
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Looks good!

@MartinHjelmare
Copy link
Member

Do we need to update any dev docs?

@MartinHjelmare MartinHjelmare marked this pull request as draft December 16, 2025 09:32
@arturpragacz
Copy link
Contributor Author

Dev docs for conditions are not merged yet: home-assistant/developers.home-assistant#2885

I'll make a comment there about the required changes.

@arturpragacz arturpragacz marked this pull request as ready for review December 16, 2025 09:43
@arturpragacz arturpragacz merged commit 2d33a72 into home-assistant:dev Dec 16, 2025
66 checks passed
@arturpragacz arturpragacz deleted the h/condition/modernise-condition-checker branch December 16, 2025 09:46
kennedyshead pushed a commit to kennedyshead/hass-core that referenced this pull request Dec 16, 2025
heindrichpaul pushed a commit to heindrichpaul/core that referenced this pull request Dec 17, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Dec 17, 2025
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.

2 participants