add payload_obj to list of optional trigger kwargs; fixed unexpected keyword arg exception; fixes #170

Author: craigbarratt

custom_components/pyscript/eval.py

@@ -65,6 +65,7 @@
     "event_type",
     "old_value",
     "payload",
+    "payload_obj",
     "qos",
     "topic",
     "trigger_type",
@@ -705,9 +706,8 @@ async def call(self, ast_ctx, *args, **kwargs):
             # don't raise an exception for extra trigger keyword parameters;
             # it's difficult to apply this exception to just trigger functions
             # since they could have non-trigger decorators too
-            raise TypeError(
-                f"{self.name}() called with unexpected keyword arguments: {', '.join(sorted(kwargs.keys()))}"
-            )
+            unexpected = ", ".join(sorted(set(kwargs.keys()) - TRIGGER_KWARGS))
+            raise TypeError(f"{self.name}() called with unexpected keyword arguments: {unexpected}")
         if self.func_def.args.vararg:
             if len(args) > len(self.func_def.args.args):
                 sym_table[self.func_def.args.vararg.arg] = tuple(args[len(self.func_def.args.args) :])

docs/reference.rst

@@ -749,6 +749,7 @@ variables:
 - ``payload`` is set to the string payload of the message
 - ``payload_obj`` if the payload was valid JSON, this will be set to the native python object
   representing that payload.
+- ``qos`` is set to the message QoS.
 
 When the ``@mqtt_trigger`` occurs, those same variables are passed as keyword arguments to the
 function in case it needs them. Additional keyword parameters can be specified by setting the

tests/test_unit_eval.py

@@ -1427,6 +1427,15 @@ async def test_eval(hass):
         "def func(*a, b):\n    pass\nfunc(1, 2)",
         "Exception in test line 3 column 8: func() missing required keyword-only arguments",
     ],
+    [
+        """
+def func(b=1):
+    pass
+
+func(a=2, trigger_type=1)
+""",
+        "Exception in test line 5 column 23: func() called with unexpected keyword arguments: a",
+    ],
     [
         "from .xyz import abc",
         "Exception in test line 1 column 0: attempted relative import with no known parent package",