raise an exception when a function is called with unexpected keyword parameters that

don't have corresponding keyword argyment (however, the trigger parameter names
are excluded from this check, since trigger functions are allowed to have any subset
of keyword arguments)

Author: craigbarratt

custom_components/pyscript/eval.py

@@ -60,6 +60,19 @@
     "pyscript_executor",
 }
 
+TRIGGER_KWARGS = {
+    "context",
+    "event_type",
+    "old_value",
+    "payload",
+    "qos",
+    "topic",
+    "trigger_type",
+    "trigger_time",
+    "var_name",
+    "value",
+}
+
 
 def ast_eval_exec_factory(ast_ctx, mode):
     """Generate a function that executes eval() or exec() with given ast_ctx."""
@@ -633,6 +646,13 @@ async def call(self, ast_ctx, *args, **kwargs):
             sym_table[var_name] = val
         if self.func_def.args.kwarg:
             sym_table[self.func_def.args.kwarg.arg] = kwargs
+        elif not set(kwargs.keys()).issubset(TRIGGER_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()))}"
+            )
         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) :])

custom_components/pyscript/trigger.py

@@ -884,6 +884,7 @@ def stop(self):
         if self.run_on_shutdown:
             notify_type = "shutdown"
             notify_info = {"trigger_type": "time", "trigger_time": "shutdown"}
+            notify_info.update(self.time_trigger_kwargs.get("kwargs", {}))
             action_future = self.call_action(notify_type, notify_info, run_task=False)
             Function.waiter_await(action_future)
 

docs/new_features.rst

@@ -26,7 +26,6 @@ Planned new features post 1.2.1 include:
   share pyscripts. The ``print`` function only logs a message, rather than implements the real ``print`` features,
   such as specifying an output file handle. Support might be added in the future using an executor job, perhaps
   enabled when ``allow_all_imports`` is set.
-- Consider adding an option argument to ``@pyscript_compile`` that wraps the function with ``task.executor``.
 
 The new features since 1.2.1 in master include:
 
@@ -51,3 +50,6 @@ Bug fixes since 1.2.1 include:
 
 - Fixed subscripts when running python 3.9.x.
 - When exception text is created, ensure lineno is inside code_list[]; with lambda function or eval it might not be.
+- An exception is raised when a function is called with unexpected keyword parameters that don't have corresponding
+  keyword arguments (however, the trigger parameter names are excluded from this check, since trigger functions
+  are allowed to have any subset of keyword arguments).