Add apply to make macros/callables useful in filters and tests
Breaking change
Proposed change
This PR implements the following architectural choice: https://github.com/home-assistant/architecture/discussions/1221
I frequently built utility macros for myself (and am excited for the folks supplying them through HACS), but one of my biggest frustrations has been the inability to use them as filters. This change makes it possible for people building such macros to use them (and any other callable) in settings where filters may be used by adding the apply filter.
The simplest example is using a macro in a map() call:
{%- macro greet(name) -%}
Hello, {{ name }}!
{%- endmacro -%}
{{ ["Alice", "Bob"] | map('apply', greet) | list }}
Which would print ["Hello, Alice!", "Hello, Bob!"]
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/38730
- Link to developer documentation pull request:
- Link to frontend pull request:
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:
- [x] Documentation added/updated for www.home-assistant.io
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 runningpython3 -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:
- [ ] I have reviewed two other open pull requests in this repository.
LGTM. But since I am not too deep into templates, another pair of eyes would be nice.
@abmantis thanks for the review! Also worth noting that this PR was broken out from this one (in case you want to take a look -- the features are more useful together): https://github.com/home-assistant/core/pull/142033
Any suggestions around other possible reviewers?
@depoll Please have patience. There are many more older pull requests open than this one. There is no need to push for it.
For more information about our review processes see: https://developers.home-assistant.io/docs/review-process
Thanks 👍
../Frenck
Looks good to me! 👍
../Frenck