Skip to content
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

Add template method: (is_)on #550

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
"""Spook - Not your homie."""
from __future__ import annotations

from typing import TYPE_CHECKING, Any

from homeassistant.helpers.template import is_state

from ....templating import AbstractSpookTemplateFunction

if TYPE_CHECKING:
from collections.abc import Callable


class SpookTemplateFunction(AbstractSpookTemplateFunction):
"""Spook template function to test if an entity is "on"."""

name = "is_on"
test_name = "on"

is_filter = True
is_global = True
is_test = True

def _function(
self,
entity_id: str | list[str],
) -> bool:
"""Check if the current state of an entity is."""
if isinstance(entity_id, list):
return all(
entity_id == "on" or is_state(self.hass, entity, "on")
for entity in entity_id
)
return entity_id == "on" or is_state(self.hass, entity_id, "on")

def function(self) -> Callable[..., Any]:
"""Return the python method that runs this template function."""
return self._function
Loading