core icon indicating copy to clipboard operation
core copied to clipboard

Adapt template sensors to use the same plural trigger/condition/action definitions as automations

Open chammp opened this issue 1 year ago • 3 comments

Proposed change

This MR adapts template entities with triggers to the new plural-ish syntax used by automations starting with 2024.10. Also here the plural forms will be the default in the internal configuration view, and the old syntax is still fully compatible, and there are probably no plans to remove the legacy singular form, at least not by me 😉

So, this kind of configs are all valid (non-exhaustive list):

template:
  - trigger:
      - platform: time_pattern
        seconds: "*"
    sensor:
      - [...]

  - triggers:
      - trigger: time_pattern
        seconds: "*"
    conditions:
      - condition: state
        entity_id: input_boolean.test
        state: 'on'
    actions:
      - action: input_boolean.toggle
        target:
          entity_id: input_boolean.updated_by_template_sensor_action
    sensor:
      - [...]

I also refactored some shared constants and code to a new automation helper file. I also thought about using a common "execution definition" scheme that could be used by automations and template entities for their own schemas, but for now decided not to go down that road.

Type of change

  • [ ] Dependency upgrade
  • [ ] Bugfix (non-breaking change which fixes an issue)
  • [ ] New integration (thank you!)
  • [x] 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: https://github.com/home-assistant/home-assistant.io/pull/35133

Checklist

  • [x] The code change is tested and works locally.
  • [x] Local tests pass. Your PR cannot be merged unless tests pass
  • [x] There is no commented out code in this PR.
  • [x] I have followed the development checklist
  • [x] I have followed the perfect PR recommendations
  • [x] The code has been formatted using Ruff (ruff format homeassistant tests)
  • [x] Tests have been added to verify that the new code works.

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:

chammp avatar Oct 07 '24 18:10 chammp

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

Code owner commands

Code owners of 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 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[bot] avatar Oct 07 '24 18:10 home-assistant[bot]

Hey there @phracturedblue, @tetienne, @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 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 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[bot] avatar Oct 07 '24 18:10 home-assistant[bot]

Added docs-missing label, as there is no documentation PR attached that adjusts our documentation accordingly.

frenck avatar Oct 08 '24 07:10 frenck

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes. Thank you for your contribution!

github-actions[bot] avatar Jan 07 '25 23:01 github-actions[bot]

Un-Stale

chammp avatar Jan 08 '25 04:01 chammp

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

home-assistant[bot] avatar Apr 28 '25 12:04 home-assistant[bot]

I'm happy with the PR now, but since I did some modifications a second pair of eyes would be good

emontnemery avatar Apr 29 '25 08:04 emontnemery