Skip to content

Allow templating a list for target.device_id#149911

Closed
Ongy wants to merge 1 commit into
home-assistant:devfrom
Ongy:allow-lists-in-target-device-id
Closed

Allow templating a list for target.device_id#149911
Ongy wants to merge 1 commit into
home-assistant:devfrom
Ongy:allow-lists-in-target-device-id

Conversation

@Ongy
Copy link
Copy Markdown
Contributor

@Ongy Ongy commented Aug 3, 2025

Proposed change

Fix the way templates work with service targets.
Currently something like:

target:
  device_id: '{{ [var1, var2] }}'

Will fail with a type error. This change allows to use templates here.
Without this change, a possible workaround is:

target: '{{ "device_id": [var1, var2] }}'

Which is a lot less ergonomic.

I consider this PR mostly an RFC, I think the code sucks, but I can't think of a better way to solve this.
Potentially it might make sense to reduce the power of the normalization and only do it when there's a strict [[...]] and don't allow for multiple list members to be flattened in a mixed way.

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

  • 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. (partially)

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:

@Ongy Ongy requested a review from a team as a code owner August 3, 2025 19:06
Copy link
Copy Markdown
Contributor

@home-assistant home-assistant Bot left a comment

Choose a reason for hiding this comment

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

Hello @Ongy,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <email@address.com>"
      
      (substituting "Author Name" and "email@address.com" for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Aug 3, 2025

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

Learn more about our pull request process.

@home-assistant home-assistant Bot marked this pull request as draft August 3, 2025 19:06
This allows something like:
target:
  device_id: '{{ [var1, var2] }}'

Previous code forces the string containing the template to be a (singleton) list of strings.
This only works for simple templates, not for more complex ones.

We don't have type information about the Template render result before it ran
This function is more powerful than necessary and flattes list entries of the target entry lists instead of just unwrapping one list layer.
@Ongy Ongy force-pushed the allow-lists-in-target-device-id branch from faf4f26 to 8ca50eb Compare August 3, 2025 19:07
@Ongy Ongy marked this pull request as ready for review August 3, 2025 19:11
@arturpragacz
Copy link
Copy Markdown
Member

arturpragacz commented Aug 5, 2025

#150239 should solve this problem.

@Ongy
Copy link
Copy Markdown
Contributor Author

Ongy commented Aug 7, 2025

@arturpragacz while you seem to have the same change in, I don't see any tests that validate the new behavior :/

@github-actions
Copy link
Copy Markdown

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 github-actions Bot added the stale label Oct 25, 2025
@emontnemery
Copy link
Copy Markdown
Contributor

emontnemery commented Oct 27, 2025

Not stale, it's waiting for #150239

@github-actions github-actions Bot removed the stale label Oct 27, 2025
@emontnemery
Copy link
Copy Markdown
Contributor

emontnemery commented Nov 3, 2025

I'm closing this PR since #150239, which adds the same feature for all target fields instead of only to device, is approved.
Thanks @Ongy for the contribution 👍

@emontnemery emontnemery closed this Nov 3, 2025
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 4, 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.

3 participants