Added LabThing-level property and action builders

Author: jtc42

examples/builder.py

@@ -28,27 +28,25 @@
 labthing.add_component(my_component, "org.labthings.example.mycomponent")
 
 # Add routes for the API views we created
-labthing.add_view(
-    property_of(my_component, "magic_denoise", description="A magic denoise property"),
-    "/denoise",
+
+labthing.build_property(
+    my_component, "magic_denoise", "/denoise", description="A magic denoise property",
 )
-labthing.add_view(
-    property_of(
-        my_component,
-        "magic_dictionary",
-        description="A big dictionary of little properties",
-    ),
+
+labthing.build_property(
+    my_component,
+    "magic_dictionary",
     "/dictionary",
+    description="A big dictionary of little properties",
 )
-labthing.add_view(
-    action_from(
-        my_component.average_data,
-        description="Take an averaged measurement",
-        task=True,  # Is the action a long-running task?
-        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?
-    ),
+
+labthing.build_action(
+    my_component.average_data,
     "/average",
+    description="Take an averaged measurement",
+    task=True,  # Is the action a long-running task?
+    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?
 )
 
 

labthings/server/labthing.py

@@ -19,12 +19,16 @@
 from .decorators import tag
 from .sockets import Sockets
 
+from .view.builder import property_of, action_from
+
 from .default_views.extensions import ExtensionList
 from .default_views.tasks import TaskList, TaskView
 from .default_views.docs import docs_blueprint, SwaggerUIView
 from .default_views.root import RootView
 from .default_views.sockets import socket_handler
 
+from typing import Callable
+
 import weakref
 import logging
 
@@ -333,3 +337,12 @@ def add_root_link(self, view, rel, kwargs=None, params=None):
         if params is None:
             params = {}
         self.thing_description.add_link(view, rel, kwargs=kwargs, params=params)
+
+    # Convenience methods
+    def build_property(
+        self, property_object: object, property_name: str, *urls, **kwargs
+    ):
+        self.add_view(property_of(property_object, property_name, **kwargs), *urls)
+
+    def build_action(self, function: Callable, *urls, **kwargs):
+        self.add_view(action_from(function, **kwargs), *urls)