Handle kwargs when calling methods in the component view.

Author: adamghill

django_unicorn/call_method_parser.py

@@ -141,28 +141,27 @@ def parse_call_method_name(call_method_name: str) -> Tuple[str, List[Any]]:
         Tuple of method_name and a list of arguments.
     """
 
-    dollar_func = False
+    is_special_method = False
+    args: List[Any] = []
+    kwargs: Dict[str, Any] = {}
+    method_name = call_method_name
 
     # Deal with special methods that start with a "$"
-    if call_method_name.startswith("$"):
-        dollar_func = True
-        call_method_name = call_method_name[1:]
+    if method_name.startswith("$"):
+        is_special_method = True
+        method_name = method_name[1:]
 
-    tree = ast.parse(call_method_name, "eval")
-    method_name = call_method_name
-    args: List[Any] = []
-    kwargs: Dict[str, Any] = {}
+    tree = ast.parse(method_name, "eval")
+    statement = tree.body[0].value
 
-    if tree.body and isinstance(tree.body[0].value, ast.Call):
+    if tree.body and isinstance(statement, ast.Call):
         call = tree.body[0].value
         method_name = call.func.id
         args = [eval_value(arg) for arg in call.args]
-
-        # Not returned, but might be usable
         kwargs = {kw.arg: eval_value(kw.value) for kw in call.keywords}
 
     # Add "$" back to special functions
-    if dollar_func:
+    if is_special_method:
         method_name = f"${method_name}"
 
     return (method_name, args, kwargs)

django_unicorn/views.py

@@ -225,21 +225,28 @@ def _get_property_value(component: UnicornView, property_name: str) -> Any:
 
 
 @timed
-def _call_method_name(component: UnicornView, method_name: str, args: List[Any]) -> Any:
+def _call_method_name(
+    component: UnicornView, method_name: str, args: List[Any], kwargs: Dict[str, Any]
+) -> Any:
     """
     Calls the method name with parameters.
 
     Args:
         param component: Component to call method on.
         param method_name: Method name to call.
         param args: List of arguments for the method.
+        param kwargs: Dictionary of kwargs for the method.
     """
 
     if method_name is not None and hasattr(component, method_name):
         func = getattr(component, method_name)
 
-        if args:
-            return func(*args)
+        if args and kwargs:
+            return func(*args, **kwargs)
+        elif args:
+            return func(*args, **kwargs)
+        elif kwargs:
+            return func(**kwargs)
         else:
             return func()
 
@@ -420,7 +427,9 @@ def _process_component_request(
                     validate_all_fields = True
                 else:
                     component.calling(method_name, args)
-                    return_data.value = _call_method_name(component, method_name, args)
+                    return_data.value = _call_method_name(
+                        component, method_name, args, kwargs
+                    )
                     component.called(method_name, args)
         else:
             raise UnicornViewError(f"Unknown action_type '{action_type}'")

example/unicorn/templates/unicorn/text-inputs.html

@@ -61,7 +61,8 @@
     <button unicorn:click="set_name('')">set_name('')</button>
     <button unicorn:click="set_name('blob 2')">set_name('blob 2')</button>
     <button unicorn:click="set_name('abc{}.def')">set_name('abc{}.def')</button>
-    <button unicorn:click="name='human'">name='human'</button>
+    <button unicorn:click="name='howdy'">name='human'</button>
+    <button unicorn:click="set_name(name='test kwarg')">set_name(name='test kwarg')</button>
 
     <br /><br />
     <button unicorn:click='set_name($event.target.value.trim())' value=' button value '>set_name($event.target.value.trim())</button>

tests/views/fake_components.py

@@ -18,17 +18,20 @@ class FakeComponent(UnicornView):
     method_count = 0
     check = False
     nested = {"check": False, "another": {"bool": False}}
-    method_param = ""
+    method_arg = ""
 
     def test_method(self):
         self.method_count += 1
 
-    def test_method_params(self, count):
+    def test_method_args(self, count):
         self.method_count = count
 
-    def test_method_string_param(self, param):
+    def test_method_string_arg(self, param):
         self.method_count += 1
-        self.method_param = param
+        self.method_arg = param
+
+    def test_method_kwargs(self, count=-1):
+        self.method_count = count
 
     def test_redirect(self):
         return redirect("/something-here")

tests/views/message/test_call_method.py

@@ -270,11 +270,11 @@ def test_message_call_method_nested_toggle(client):
     assert body["data"].get("nested").get("check") == True
 
 
-def test_message_call_method_params(client):
+def test_message_call_method_args(client):
     data = {"method_count": 0}
     message = {
         "actionQueue": [
-            {"payload": {"name": "test_method_params(3)"}, "type": "callMethod",}
+            {"payload": {"name": "test_method_args(3)"}, "type": "callMethod",}
         ],
         "data": data,
         "checksum": generate_checksum(orjson.dumps(data)),
@@ -293,6 +293,29 @@ def test_message_call_method_params(client):
     assert body["data"].get("method_count") == 3
 
 
+def test_message_call_method_kwargs(client):
+    data = {"method_count": 0}
+    message = {
+        "actionQueue": [
+            {"payload": {"name": "test_method_kwargs(count=99)"}, "type": "callMethod",}
+        ],
+        "data": data,
+        "checksum": generate_checksum(orjson.dumps(data)),
+        "id": shortuuid.uuid()[:8],
+        "epoch": time.time(),
+    }
+
+    response = client.post(
+        "/message/tests.views.fake_components.FakeComponent",
+        message,
+        content_type="application/json",
+    )
+
+    body = orjson.loads(response.content)
+
+    assert body["data"].get("method_count") == 99
+
+
 def test_message_call_method_no_validation(client):
     data = {}
     message = {

tests/views/message/test_set_property.py

@@ -52,12 +52,12 @@ def test_nested_setter(client):
 
 
 def test_equal_sign(client):
-    data = {"nested": {"check": False}, "method_param": ""}
+    data = {"nested": {"check": False}, "method_arg": ""}
     message = {
         "actionQueue": [
             {
                 "type": "callMethod",
-                "payload": {"name": "test_method_string_param('does=thiswork?')"},
+                "payload": {"name": "test_method_string_arg('does=thiswork?')"},
             },
         ],
         "data": data,
@@ -69,4 +69,4 @@ def test_equal_sign(client):
     body = _post_message_and_get_body(client, message)
 
     assert not body["errors"]
-    assert body["data"]["method_param"] == "does=thiswork?"
+    assert body["data"]["method_arg"] == "does=thiswork?"