Added automatic URL generation for interaction builders

Author: jtc42

examples/builder.py

@@ -29,15 +29,13 @@
 labthing.build_property(
     my_component,  # Python object
     "magic_denoise",  # Objects attribute name
-    "/denoise",  # URL to bind the property to
     description="A magic denoise property",
     semtype=semantics.moz.LevelProperty(100, 500, example=200),
 )
 
 labthing.build_property(
     my_component,  # Python object
     "magic_dictionary",  # Objects attribute name
-    "/dictionary",  # URL to bind the property to
     description="A big dictionary of little properties",
     schema={  # Property is a dictionary, with these value types
         "voltage": fields.Int(),
@@ -51,7 +49,6 @@
 
 labthing.build_action(
     my_component.average_data,  # Python function
-    "/average",  # URL to bind the action to
     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?,
@@ -60,7 +57,6 @@
     },
 )
 
-
 # Start the app
 if __name__ == "__main__":
     from labthings.server.wsgi import Server

src/labthings/labthing.py

@@ -33,7 +33,7 @@
 from .default_views.root import RootView
 from .default_views.sockets import socket_handler
 
-from .utilities import camel_to_snake
+from .utilities import camel_to_snake, url_for_property, url_for_action
 
 from typing import Callable
 
@@ -394,11 +394,15 @@ def add_root_link(self, view, rel, kwargs=None, params=None):
 
     # Convenience methods
     def build_property(
-        self, property_object: object, property_name: str, *urls, **kwargs
+        self, property_object: object, property_name: str, urls: list = None, **kwargs
     ):
+        if urls is None:
+            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, **kwargs):
+    def build_action(self, function: Callable, urls: list = None, **kwargs):
+        if urls is None:
+            urls = [url_for_action(function)]
         self.add_view(action_from(function, **kwargs), *urls)
 
     def spawn_action(self, *args, **kwargs):

src/labthings/utilities.py

@@ -9,7 +9,9 @@
 import copy
 import time
 import typing
+import inspect
 from functools import reduce
+from typing import Callable
 
 PY3 = sys.version_info > (3,)
 
@@ -302,3 +304,20 @@ def path_relative_to(source_file, *paths):
         paths {str} -- Paths to add to source file location
     """
     return os.path.join(os.path.abspath(os.path.dirname(source_file)), *paths)
+
+
+def get_class_that_defined_method(meth):
+    for cls in inspect.getmro(meth.im_class):
+        if meth.__name__ in cls.__dict__:
+            return cls
+    return None
+
+
+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):
+    full_name = getattr(function, "__qualname__", None) or function.__name__
+    full_name_safe = full_name.replace(".", "/")
+    return f"/actions/{full_name_safe}"