Home Assistant Unofficial Reference 2024.12.1
script.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.helpers.script._AbortScript
 
class  homeassistant.helpers.script._ChooseData
 
class  homeassistant.helpers.script._ConditionFail
 
class  homeassistant.helpers.script._HaltScript
 
class  homeassistant.helpers.script._IfData
 
class  homeassistant.helpers.script._QueuedScriptRun
 
class  homeassistant.helpers.script._ScriptRun
 
class  homeassistant.helpers.script._StopScript
 
class  homeassistant.helpers.script.Script
 
class  homeassistant.helpers.script.ScriptData
 
class  homeassistant.helpers.script.ScriptRunResult
 
class  homeassistant.helpers.script.ScriptStoppedError
 

Namespaces

 homeassistant.helpers.script
 

Functions

None homeassistant.helpers.script._async_stop_scripts_after_shutdown (HomeAssistant hass, datetime point_in_time)
 
None homeassistant.helpers.script._async_stop_scripts_at_shutdown (HomeAssistant hass, Event event)
 
None homeassistant.helpers.script._referenced_extract_ids (Any data, str key, set[str] found)
 
None homeassistant.helpers.script._schedule_stop_scripts_after_shutdown (HomeAssistant hass)
 
None homeassistant.helpers.script._set_result_unless_done (asyncio.Future[None] future)
 
TraceElement homeassistant.helpers.script.action_trace_append (dict[str, Any] variables, str path)
 
ConfigType homeassistant.helpers.script.async_validate_action_config (HomeAssistant hass, ConfigType config)
 
list[ConfigType] homeassistant.helpers.script.async_validate_actions_config (HomeAssistant hass, list[ConfigType] actions)
 
None homeassistant.helpers.script.breakpoint_clear (HomeAssistant hass, str key, str|None run_id, str node)
 
None homeassistant.helpers.script.breakpoint_clear_all (HomeAssistant hass)
 
list[dict[str, Any]] homeassistant.helpers.script.breakpoint_list (HomeAssistant hass)
 
None homeassistant.helpers.script.breakpoint_set (HomeAssistant hass, str key, str|None run_id, str node)
 
None homeassistant.helpers.script.debug_continue (HomeAssistant hass, str key, str run_id)
 
None homeassistant.helpers.script.debug_step (HomeAssistant hass, str key, str run_id)
 
None homeassistant.helpers.script.debug_stop (HomeAssistant hass, str key, str run_id)
 
vol.Schema homeassistant.helpers.script.make_script_schema (Mapping[Any, Any] schema, str default_script_mode, int extra=vol.PREVENT_EXTRA)
 
AsyncGenerator[TraceElement] homeassistant.helpers.script.trace_action (HomeAssistant hass, _ScriptRun script_run, asyncio.Future[None] stop, dict[str, Any] variables)
 

Variables

int homeassistant.helpers.script._LOG_EXCEPTION = logging.ERROR + 1
 
 homeassistant.helpers.script._LOGGER = logging.getLogger(__name__)
 
list homeassistant.helpers.script._MAX_EXCEEDED_CHOICES = [*LOGSEVERITY, "SILENT"]
 
int homeassistant.helpers.script._SHUTDOWN_MAX_WAIT = 60
 
string homeassistant.helpers.script._TIMEOUT_MSG = "Timeout reached, abort script."
 
 homeassistant.helpers.script._VarsType
 
int homeassistant.helpers.script.ACTION_TRACE_NODE_MAX_LEN = 20
 
string homeassistant.helpers.script.ATTR_CUR = "current"
 
string homeassistant.helpers.script.ATTR_MAX = "max"
 
string homeassistant.helpers.script.CONF_MAX = "max"
 
string homeassistant.helpers.script.CONF_MAX_EXCEEDED = "max_exceeded"
 
 homeassistant.helpers.script.default
 
int homeassistant.helpers.script.DEFAULT_MAX = 10
 
string homeassistant.helpers.script.DEFAULT_MAX_EXCEEDED = "WARNING"
 
string homeassistant.helpers.script.DEFAULT_SCRIPT_MODE = SCRIPT_MODE_SINGLE
 
string homeassistant.helpers.script.NODE_ANY = "*"
 
int homeassistant.helpers.script.REPEAT_TERMINATE_ITERATIONS = 10000
 
int homeassistant.helpers.script.REPEAT_WARN_ITERATIONS = 5000
 
string homeassistant.helpers.script.RUN_ID_ANY = "*"
 
 homeassistant.helpers.script.SCRIPT_BREAKPOINT_HIT = SignalType[str, str, str]("script_breakpoint_hit")
 
string homeassistant.helpers.script.SCRIPT_DEBUG_CONTINUE_ALL = "script_debug_continue_all"
 
list homeassistant.helpers.script.SCRIPT_MODE_CHOICES
 
string homeassistant.helpers.script.SCRIPT_MODE_PARALLEL = "parallel"
 
string homeassistant.helpers.script.SCRIPT_MODE_QUEUED = "queued"
 
string homeassistant.helpers.script.SCRIPT_MODE_RESTART = "restart"
 
string homeassistant.helpers.script.SCRIPT_MODE_SINGLE = "single"
 
tuple homeassistant.helpers.script.STATIC_VALIDATION_ACTION_TYPES