Home-Assistant/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-12-24 12:59:34 +00:00
Code Activity

Black

Browse Source
This commit is contained in:
Paulus Schoutsen
2019-07-31 12:25:30 -07:00
parent da05dfe708
commit 4de97abc3a
2676 changed files with 163166 additions and 140084 deletions
Download Patch File Download Diff File Expand all files Collapse all files

161
homeassistant/helpers/script.py
View File

@@ -12,14 +12,18 @@ from homeassistant.core import HomeAssistant, Context, callback, CALLBACK_TYPE
from homeassistant.const import CONF_CONDITION, CONF_TIMEOUT
from homeassistant import exceptions
from homeassistant.helpers import (
service, condition, template as template,
config_validation as cv)
service,
condition,
template as template,
config_validation as cv,
)
from homeassistant.helpers.event import (
async_track_point_in_utc_time, async_track_template)
async_track_point_in_utc_time,
async_track_template,
)
from homeassistant.helpers.typing import ConfigType
import homeassistant.util.dt as date_util
from homeassistant.util.async_ import (
run_coroutine_threadsafe, run_callback_threadsafe)
from homeassistant.util.async_ import run_coroutine_threadsafe, run_callback_threadsafe
# mypy: allow-incomplete-defs, allow-untyped-calls, allow-untyped-defs
@@ -27,23 +31,23 @@ from homeassistant.util.async_ import (
_LOGGER = logging.getLogger(__name__)
CONF_ALIAS = 'alias'
CONF_SERVICE = 'service'
CONF_SERVICE_DATA = 'data'
CONF_SEQUENCE = 'sequence'
CONF_EVENT = 'event'
CONF_EVENT_DATA = 'event_data'
CONF_EVENT_DATA_TEMPLATE = 'event_data_template'
CONF_DELAY = 'delay'
CONF_WAIT_TEMPLATE = 'wait_template'
CONF_CONTINUE = 'continue_on_timeout'
CONF_ALIAS = "alias"
CONF_SERVICE = "service"
CONF_SERVICE_DATA = "data"
CONF_SEQUENCE = "sequence"
CONF_EVENT = "event"
CONF_EVENT_DATA = "event_data"
CONF_EVENT_DATA_TEMPLATE = "event_data_template"
CONF_DELAY = "delay"
CONF_WAIT_TEMPLATE = "wait_template"
CONF_CONTINUE = "continue_on_timeout"
ACTION_DELAY = 'delay'
ACTION_WAIT_TEMPLATE = 'wait_template'
ACTION_CHECK_CONDITION = 'condition'
ACTION_FIRE_EVENT = 'event'
ACTION_CALL_SERVICE = 'call_service'
ACTION_DELAY = "delay"
ACTION_WAIT_TEMPLATE = "wait_template"
ACTION_CHECK_CONDITION = "condition"
ACTION_FIRE_EVENT = "event"
ACTION_CALL_SERVICE = "call_service"
def _determine_action(action):
@@ -63,9 +67,12 @@ def _determine_action(action):
return ACTION_CALL_SERVICE
def call_from_config(hass: HomeAssistant, config: ConfigType,
variables: Optional[Sequence] = None,
context: Optional[Context] = None) -> None:
def call_from_config(
hass: HomeAssistant,
config: ConfigType,
variables: Optional[Sequence] = None,
context: Optional[Context] = None,
) -> None:
"""Call a script based on a config entry."""
Script(hass, cv.SCRIPT_SCHEMA(config)).run(variables, context)
@@ -78,12 +85,16 @@ class _SuspendScript(Exception):
"""Throw if script needs to suspend."""
class Script():
class Script:
"""Representation of a script."""
def __init__(self, hass: HomeAssistant, sequence,
name: Optional[str] = None,
change_listener=None) -> None:
def __init__(
self,
hass: HomeAssistant,
sequence,
name: Optional[str] = None,
change_listener=None,
) -> None:
"""Initialize the script."""
self.hass = hass
self.sequence = sequence
@@ -94,8 +105,10 @@ class Script():
self._exception_step = None # type: Optional[int]
self.last_action = None
self.last_triggered = None # type: Optional[datetime]
self.can_cancel = any(CONF_DELAY in action or CONF_WAIT_TEMPLATE
in action for action in self.sequence)
self.can_cancel = any(
CONF_DELAY in action or CONF_WAIT_TEMPLATE in action
for action in self.sequence
)
self._async_listener = [] # type: List[CALLBACK_TYPE]
self._config_cache = {} # type: Dict[Set[Tuple], Callable[..., bool]]
self._actions = {
@@ -114,17 +127,19 @@ class Script():
def run(self, variables=None, context=None):
"""Run script."""
run_coroutine_threadsafe(
self.async_run(variables, context), self.hass.loop).result()
self.async_run(variables, context), self.hass.loop
).result()
async def async_run(self, variables: Optional[Sequence] = None,
context: Optional[Context] = None) -> None:
async def async_run(
self, variables: Optional[Sequence] = None, context: Optional[Context] = None
) -> None:
"""Run script.
This method is a coroutine.
"""
self.last_triggered = date_util.utcnow()
if self._cur == -1:
self._log('Running script')
self._log("Running script")
self._cur = 0
# Unregister callback if we were in a delay or wait but turn on is
@@ -199,20 +214,25 @@ class Script():
else:
# Print the full stack trace, unknown error
error_desc = 'Unknown error'
error_desc = "Unknown error"
meth = logger.exception
error = ""
if error is None:
error = str(exception)
meth("%s. %s for %s at pos %s: %s",
message_base, error_desc, action_type, step + 1, error)
meth(
"%s. %s for %s at pos %s: %s",
message_base,
error_desc,
action_type,
step + 1,
error,
)
async def _handle_action(self, action, variables, context):
"""Handle an action."""
await self._actions[_determine_action(action)](
action, variables, context)
await self._actions[_determine_action(action)](action, variables, context)
async def _async_delay(self, action, variables, context):
"""Handle delay."""
@@ -226,34 +246,28 @@ class Script():
with suppress(ValueError):
self._async_listener.remove(unsub)
self.hass.async_create_task(
self.async_run(variables, context))
self.hass.async_create_task(self.async_run(variables, context))
delay = action[CONF_DELAY]
try:
if isinstance(delay, template.Template):
delay = vol.All(
cv.time_period,
cv.positive_timedelta)(
delay.async_render(variables))
delay = vol.All(cv.time_period, cv.positive_timedelta)(
delay.async_render(variables)
)
elif isinstance(delay, dict):
delay_data = {}
delay_data.update(
template.render_complex(delay, variables))
delay_data.update(template.render_complex(delay, variables))
delay = cv.time_period(delay_data)
except (exceptions.TemplateError, vol.Invalid) as ex:
_LOGGER.error("Error rendering '%s' delay template: %s",
self.name, ex)
_LOGGER.error("Error rendering '%s' delay template: %s", self.name, ex)
raise _StopScript
self.last_action = action.get(
CONF_ALIAS, 'delay {}'.format(delay))
self.last_action = action.get(CONF_ALIAS, "delay {}".format(delay))
self._log("Executing step %s" % self.last_action)
unsub = async_track_point_in_utc_time(
self.hass, async_script_delay,
date_util.utcnow() + delay
self.hass, async_script_delay, date_util.utcnow() + delay
)
self._async_listener.append(unsub)
raise _SuspendScript
@@ -264,28 +278,27 @@ class Script():
wait_template = action[CONF_WAIT_TEMPLATE]
wait_template.hass = self.hass
self.last_action = action.get(CONF_ALIAS, 'wait template')
self.last_action = action.get(CONF_ALIAS, "wait template")
self._log("Executing step %s" % self.last_action)
# check if condition already okay
if condition.async_template(
self.hass, wait_template, variables):
if condition.async_template(self.hass, wait_template, variables):
return
@callback
def async_script_wait(entity_id, from_s, to_s):
"""Handle script after template condition is true."""
self._async_remove_listener()
self.hass.async_create_task(
self.async_run(variables, context))
self.hass.async_create_task(self.async_run(variables, context))
self._async_listener.append(async_track_template(
self.hass, wait_template, async_script_wait, variables))
self._async_listener.append(
async_track_template(self.hass, wait_template, async_script_wait, variables)
)
if CONF_TIMEOUT in action:
self._async_set_timeout(
action, variables, context,
action.get(CONF_CONTINUE, True))
action, variables, context, action.get(CONF_CONTINUE, True)
)
raise _SuspendScript
@@ -294,14 +307,15 @@ class Script():
This method is a coroutine.
"""
self.last_action = action.get(CONF_ALIAS, 'call service')
self.last_action = action.get(CONF_ALIAS, "call service")
self._log("Executing step %s" % self.last_action)
await service.async_call_from_config(
self.hass, action,
self.hass,
action,
blocking=True,
variables=variables,
validate_config=False,
context=context
context=context,
)
async def _async_fire_event(self, action, variables, context):
@@ -311,13 +325,13 @@ class Script():
event_data = dict(action.get(CONF_EVENT_DATA, {}))
if CONF_EVENT_DATA_TEMPLATE in action:
try:
event_data.update(template.render_complex(
action[CONF_EVENT_DATA_TEMPLATE], variables))
event_data.update(
template.render_complex(action[CONF_EVENT_DATA_TEMPLATE], variables)
)
except exceptions.TemplateError as ex:
_LOGGER.error('Error rendering event data template: %s', ex)
_LOGGER.error("Error rendering event data template: %s", ex)
self.hass.bus.async_fire(action[CONF_EVENT],
event_data, context=context)
self.hass.bus.async_fire(action[CONF_EVENT], event_data, context=context)
async def _async_check_condition(self, action, variables, context):
"""Test if condition is matching."""
@@ -334,8 +348,7 @@ class Script():
if not check:
raise _StopScript
def _async_set_timeout(self, action, variables, context,
continue_on_timeout):
def _async_set_timeout(self, action, variables, context, continue_on_timeout):
"""Schedule a timeout to abort or continue script."""
timeout = action[CONF_TIMEOUT]
unsub = None
@@ -349,15 +362,13 @@ class Script():
# Check if we want to continue to execute
# the script after the timeout
if continue_on_timeout:
self.hass.async_create_task(
self.async_run(variables, context))
self.hass.async_create_task(self.async_run(variables, context))
else:
self._log("Timeout reached, abort script.")
self.async_stop()
unsub = async_track_point_in_utc_time(
self.hass, async_script_timeout,
date_util.utcnow() + timeout
self.hass, async_script_timeout, date_util.utcnow() + timeout
)
self._async_listener.append(unsub)