Skip to content

Add apply to make macros/callables useful in filters and tests #144227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
May 26, 2025

Conversation

depoll
Copy link
Contributor

@depoll depoll commented May 4, 2025

Breaking change

Proposed change

This PR implements the following architectural choice: home-assistant/architecture#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!)
  • 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

  • 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.

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:

@depoll depoll requested a review from a team as a code owner May 4, 2025 18:57
@depoll depoll changed the title Add apply filter to make macros useful in filters Add apply filter to make macros useful in filters and tests May 4, 2025
@depoll depoll changed the title Add apply filter to make macros useful in filters and tests Add apply filter to make macros useful in filters May 4, 2025
@depoll depoll changed the title Add apply filter to make macros useful in filters Add apply filter to make macros/callables useful in filters and tests May 4, 2025
@depoll depoll changed the title Add apply filter to make macros/callables useful in filters and tests Add apply to make macros/callables useful in filters and tests May 4, 2025
@abmantis
Copy link
Member

abmantis commented May 5, 2025

LGTM. But since I am not too deep into templates, another pair of eyes would be nice.

@depoll
Copy link
Contributor Author

depoll commented May 5, 2025

@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): #142033

@depoll
Copy link
Contributor Author

depoll commented May 20, 2025

Any suggestions around other possible reviewers?

@frenck
Copy link
Member

frenck commented May 20, 2025

@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

@abmantis abmantis added the second-opinion-wanted Add this label when a reviewer needs a second opinion from another member. label May 23, 2025
@frenck
Copy link
Member

frenck commented May 26, 2025

Looks good to me! 👍

../Frenck

@frenck frenck merged commit 13d7234 into home-assistant:dev May 26, 2025
48 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators May 27, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed core new-feature second-opinion-wanted Add this label when a reviewer needs a second opinion from another member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants