added a couple more tests and docs for state_check_now

Author: craigbarratt

docs/reference.rst

@@ -227,6 +227,9 @@ Optional arguments are:
   to ``True`` or non-zero. Normally the expression is only evaluated when a state variable
   changes, and not when the trigger function is first defined. This option is the same as
   in the ``task.wait_until`` function, except the default value is ``True`` in that case.
+  Note that if you specify ``state_check_now=True``, entries in ``state_trigger`` that are
+  plain state variable names (which mean trigger on any change) are ignored during the initial
+  check - only expressions are checked.
 
 ``state_hold=None``
   A numeric duration in seconds that delays executing the trigger function for this amount of time.
@@ -761,8 +764,8 @@ It takes the following keyword arguments (all are optional):
   immediately to see if it is already ``True``, and will return immediately if so. If
   ``state_check_now=False``, ``task.wait_until()`` waits until a state variable change occurs,
   before checking the expression. Using ``True`` is safer to help avoid race conditions, although
-  ``False`` makes ``task.wait_until()`` behave like ``@state_trigger``, which doesn’t check at
-  startup. However, if you use the default of ``True``, and your function will call
+  ``False`` makes ``task.wait_until()`` behave like ``@state_trigger``, which by default doesn’t check
+  at startup. However, if you use the default of ``True``, and your function will call
   ``task.wait_until()`` again, it’s recommended you set that state variable to some other value
   immediately after ``task.wait_until()`` returns. Otherwise the next call will also return
   immediately. Note that entries in ``state_trigger`` that are plain state variable names

tests/test_function.py

@@ -688,7 +688,8 @@ async def test_state_trigger_check_now(hass, caplog):
     """Test state trigger."""
     notify_q = asyncio.Queue(0)
 
-    hass.states.async_set("pyscript.fstartup", 1)
+    hass.states.async_set("pyscript.fstartup0", 1)
+    hass.states.async_set("pyscript.fstartup2", 0)
 
     await setup_script(
         hass,
@@ -699,27 +700,42 @@ async def test_state_trigger_check_now(hass, caplog):
 from math import sqrt
 from homeassistant.core import Context
 
-seq_num = 0
-
-pyscript.fstartup = 1
-
-@state_trigger("pyscript.fstartup == '1'", state_check_now=True)
-def func_startup_sync(trigger_type=None, var_name=None):
-    global seq_num
-
-    seq_num += 1
-    log.info(f"func_startup_sync setting pyscript.done={seq_num}, trigger_type={trigger_type}, var_name={var_name}")
-    pyscript.done = [seq_num, trigger_type, var_name]
+# should trigger immediately
+@state_trigger("pyscript.fstartup0 == '1'", state_check_now=True)
+def func_startup_sync0(trigger_type=None, var_name=None):
+    log.info(f"func_startup_sync0 setting pyscript.done=0, trigger_type={trigger_type}, var_name={var_name}")
+    pyscript.done = [0, trigger_type, var_name]
+
+# should trigger immediately
+@state_trigger("pyscript.fstartup2 == '0'", state_check_now=True)
+def func_startup_sync1(trigger_type=None, var_name=None):
+    log.info(f"func_startup_sync1 setting pyscript.done=1, trigger_type={trigger_type}, var_name={var_name}")
+    pyscript.done = [1, trigger_type, var_name]
+
+# shouldn't trigger immediately
+@state_trigger("pyscript.fstartup2 == '1'", state_check_now=True)
+def func_startup_sync2(trigger_type=None, var_name=None):
+    log.info(f"func_startup_sync2 setting pyscript.done=2, trigger_type={trigger_type}, var_name={var_name}")
+    pyscript.done = [2, trigger_type, var_name]
 """,
     )
-    seq_num = 0
 
-    seq_num += 1
-    # fire event to start triggers, and handshake when they are running
     hass.bus.async_fire(EVENT_HOMEASSISTANT_STARTED)
-    assert literal_eval(await wait_until_done(notify_q)) == [seq_num, "state", None]
+    #
+    # we should get two results, although they could be in any order
+    #
+    results = [None, None]
+    for _ in range(2):
+        res = literal_eval(await wait_until_done(notify_q))
+        results[res[0]] = res
 
-    seq_num += 1
-    hass.states.async_set("pyscript.fstartup", 0)
-    hass.states.async_set("pyscript.fstartup", 1)
-    assert literal_eval(await wait_until_done(notify_q)) == [seq_num, "state", "pyscript.fstartup"]
+    assert results == [[0, "state", None], [1, "state", None]]
+
+    for _ in range(2):
+        hass.states.async_set("pyscript.fstartup2", 10)
+        hass.states.async_set("pyscript.fstartup2", 1)
+        assert literal_eval(await wait_until_done(notify_q)) == [2, "state", "pyscript.fstartup2"]
+
+        hass.states.async_set("pyscript.fstartup0", 0)
+        hass.states.async_set("pyscript.fstartup0", 1)
+        assert literal_eval(await wait_until_done(notify_q)) == [0, "state", "pyscript.fstartup0"]