Switched action builder to the same API as property builder

Author: Joel Collins

examples/builder.py

@@ -48,7 +48,8 @@
 )
 
 labthing.build_action(
-    my_component.average_data,  # Python function
+    my_component,  # Python object
+    "average_data",  # Objects method name
     description="Take an averaged measurement",
     safe=True,  # Is the state of the Thing unchanged by calling the action?
     idempotent=True,  # Can the action be called repeatedly with the same result?,

src/labthings/labthing.py

@@ -547,14 +547,17 @@ def build_property(
             urls = [url_for_property(property_object, property_name)]
         self.add_view(property_of(property_object, property_name, **kwargs), *urls)
 
-    def build_action(self, function: Callable, urls: list = None, **kwargs):
+    def build_action(
+        self, action_object: object, action_name: str, urls: list = None, **kwargs
+    ):
         """
 
-        :param function: Callable: 
+        :param action_object: object: 
+        :param action_name: str: 
         :param urls: list:  (Default value = None)
         :param **kwargs: 
 
         """
         if urls is None:
-            urls = [url_for_action(function)]
+            urls = [url_for_action(action_object, action_name)]
         self.add_view(action_from(function, **kwargs), *urls)

src/labthings/utilities.py

@@ -29,6 +29,7 @@
 
 class TimeoutTracker:
     """ """
+
     def __init__(self, timeout: int):
         self.timeout_time = time.time() + timeout
 
@@ -358,12 +359,11 @@ def url_for_property(property_object: object, property_name: str):
     return f"/properties/{property_object.__class__.__name__}/{property_name}"
 
 
-def url_for_action(function: Callable):
+def url_for_action(action_object: object, action_name: str):
     """
 
-    :param function: Callable: 
+    :param action_object: object: 
+    :param action_name: str: 
 
     """
-    full_name = getattr(function, "__qualname__", None) or function.__name__
-    full_name_safe = full_name.replace(".", "/")
-    return f"/actions/{full_name_safe}"
+    return f"/actions/{action_object.__class__.__name__}/{action_name}"

src/labthings/views/builder.py

@@ -100,7 +100,8 @@ def _update(self, args):
 
 
 def action_from(
-    function,
+    action_object: object,
+    action_name: str,
     name: str = None,
     description=None,
     safe=False,
@@ -111,8 +112,8 @@ def action_from(
 ):
     """
 
-    :param function: 
-    :param name: str:  (Default value = None)
+    :param action_object: object: 
+    :param action_name: str: 
     :param description:  (Default value = None)
     :param safe:  (Default value = False)
     :param idempotent:  (Default value = False)
@@ -124,20 +125,28 @@ def action_from(
 
     # Create a class name
     if not name:
-        name = f"{function.__name__}_action"
+        name = type(action_object).__name__ + f"_{action_name}"
+
+    # Get pointer to action function
+    action_f = getattr(action_object, action_name)
+    # Ensure action function is actually a function
+    if not callable(action_f):
+        raise TypeError(
+            f"Attribute {action_name} of {action_object} must be a callable"
+        )
 
     # Create inner functions
     def _post(self):
         """ """
-        return function()
+        return action_f()
 
     def _post_with_args(self, args):
         """
 
         :param args: 
 
         """
-        return function(**args)
+        return action_f(**args)
 
     # Add decorators for arguments etc
     if args is not None:

tests/test_views_builder.py

@@ -117,7 +117,9 @@ def test_action_from(debug_app, debug_client):
     def f():
         return "response"
 
-    GeneratedClass = builder.action_from(f)
+    obj = type("obj", (object,), {"f": f})
+
+    GeneratedClass = builder.action_from(obj, "f")
     debug_app.add_url_rule("/", view_func=GeneratedClass.as_view("index"))
 
     with debug_client as c:
@@ -129,8 +131,10 @@ def test_action_from_with_args(app, client):
     def f(arg1, arg2=0):
         return {"arg1": arg1, "arg2": arg2}
 
+    obj = type("obj", (object,), {"f": f})
+
     GeneratedClass = builder.action_from(
-        f, args={"arg1": fields.Int(), "arg2": fields.Int(required=False)}
+        obj, "f", args={"arg1": fields.Int(), "arg2": fields.Int(required=False)}
     )
     app.add_url_rule("/", view_func=GeneratedClass.as_view("index"))
 
@@ -145,7 +149,9 @@ def test_action_from_with_schema(app, client):
     def f():
         return "response"
 
-    GeneratedClass = builder.action_from(f, schema=fields.String())
+    obj = type("obj", (object,), {"f": f})
+
+    GeneratedClass = builder.action_from(obj, "f", schema=fields.String())
     app.add_url_rule("/", view_func=GeneratedClass.as_view("index"))
 
     with client as c:
@@ -158,8 +164,11 @@ def test_action_from_with_options(app):
     def f():
         return "response"
 
+    obj = type("obj", (object,), {"f": f})
+
     assert builder.action_from(
-        f,
+        obj,
+        "f",
         name="action_name",
         description="action_description",
         safe=True,
@@ -171,7 +180,9 @@ def test_action_from_semtype_string():
     def f():
         return "response"
 
-    GeneratedClass = builder.action_from(f, semtype="SemanticType")
+    obj = type("obj", (object,), {"f": f})
+
+    GeneratedClass = builder.action_from(obj, "f", semtype="SemanticType")
 
     assert GeneratedClass.semtype == "SemanticType"
 
@@ -180,9 +191,11 @@ def test_action_from_semtype_semantic():
     def f():
         return "response"
 
+    obj = type("obj", (object,), {"f": f})
+
     semantic_annotation = Semantic()
 
-    GeneratedClass = builder.action_from(f, semtype=semantic_annotation)
+    GeneratedClass = builder.action_from(obj, "f", semtype=semantic_annotation)
 
     assert GeneratedClass.semtype == "Semantic"
 
@@ -191,10 +204,12 @@ def test_action_from_semtype_invalid():
     def f():
         return "response"
 
+    obj = type("obj", (object,), {"f": f})
+
     semantic_annotation = object
 
     with pytest.raises(TypeError):
-        GeneratedClass = builder.action_from(f, semtype=semantic_annotation)
+        GeneratedClass = builder.action_from(obj, "f", semtype=semantic_annotation)
 
 
 def test_static_from(app, client, app_ctx, static_path):