Added action builder and function signature to schema builder

Author: Joel Collins

examples/builder.py

@@ -5,7 +5,7 @@
 import logging
 
 from labthings.server.quick import create_app
-from labthings.server.view.builder import property_of
+from labthings.server.view.builder import property_of, action_from
 
 from components.pdf_component import PdfComponent
 
@@ -42,6 +42,10 @@ def cleanup():
     ),
     "/dictionary",
 )
+labthing.add_view(
+    action_from(my_component.average_data, description="Take an averaged measurement"),
+    "/average",
+)
 
 atexit.register(cleanup)
 

examples/components/pdf_component.py

@@ -2,6 +2,8 @@
 import math
 import time
 
+from typing import List
+
 """
 Class for our lab component functionality. This could include serial communication,
 equipment API calls, network requests, or a "virtual" device as seen here.
@@ -38,7 +40,7 @@ def data(self):
         """Return a 1D data trace."""
         return [self.noisy_pdf(x) for x in self.x_range]
 
-    def average_data(self, n: int):
+    def average_data(self, n: int = 10, optlist: List[int] = [1, 2, 3]):
         """Average n-sets of data. Emulates a measurement that may take a while."""
         summed_data = self.data
 

examples/simple_extensions.py

@@ -40,7 +40,6 @@ def ext_on_my_component(component):
 
 
 static_folder = path_relative_to(__file__, "static")
-print(static_folder)
 
 example_extension = BaseExtension(
     "org.labthings.examples.extension", static_folder=static_folder

labthings/core/tasks/thread.py

@@ -158,12 +158,10 @@ def check_thread(self, record):
 
     def emit(self, record):
         """Do something with a logged message"""
-        print("emitting a log")
         record_dict = {"message": record.getMessage()}
         for k in ["created", "levelname", "levelno", "lineno", "filename"]:
             record_dict[k] = getattr(record, k)
         self.dest.append(record_dict)
-        print(self.thread.log)
         # FIXME: make sure this doesn't become a memory disaster!
         # We probably need to check the size of the list...
         # TODO: think about whether any of the keys are security flaws

labthings/server/logging.py

@@ -9,7 +9,6 @@ def __init__(self, labthing):
 
     def emit(self, record):
         log_event = self.rest_format_record(record)
-        print(log_event)
 
         # Broadcast to subscribers
         subscribers = getattr(self.labthing, "subscribers", [])

labthings/server/types.py

@@ -0,0 +1,2 @@
+from .properties import value_to_field, data_dict_to_schema
+from .annotations import function_signature_to_schema

labthings/server/types/__init__.py

@@ -0,0 +1,77 @@
+from .registry import TypeRegistry
+from labthings.server import fields
+
+from typing import Dict, List, Tuple, Union
+from inspect import Parameter
+from marshmallow.base import FieldABC
+
+import inspect
+
+NoneType = type(None)
+
+
+class AnnotationConverter:
+    def __init__(self):
+        self._registry = TypeRegistry()
+        self._registry.register(List, self._list_converter)
+        self._registry.register(list, self._list_converter)
+
+    def _list_converter(self, subtypes: Tuple[type], **opts) -> FieldABC:
+        sub_opts = opts.pop("_interior", {})
+        return fields.List(self.convert(subtypes[0], **sub_opts), **opts)
+
+    def convert(self, parameter, **kwargs) -> FieldABC:
+        # sane defaults
+        allow_none = False
+        required = True
+        optional = False
+        subtypes = ()
+
+        if isinstance(parameter, Parameter):
+            typehint = parameter.annotation
+            optional = not (parameter.default is parameter.empty)
+        elif isinstance(parameter, type):
+            typehint = parameter
+        else:
+            typehint = type(parameter)
+
+        if optional:
+            allow_none = True
+            required = False
+
+        if isinstance(parameter, Parameter):
+            # Get subtypes
+            subtypes = getattr(typehint, "__args__", ())
+            if subtypes != ():
+                typehint = typehint.__origin__
+
+            # Get default
+            if not (parameter.default is parameter.empty):
+                kwargs.setdefault("default", parameter.default)
+                kwargs.setdefault("example", parameter.default)
+
+        kwargs.setdefault("allow_none", allow_none)
+        kwargs.setdefault("required", required)
+
+        field_constructor = self._registry.get(typehint)
+        return field_constructor(subtypes, **kwargs)
+
+
+def function_signature_to_schema(function: callable):
+    """
+    """
+    converter = AnnotationConverter()
+
+    schema_dict = {}
+    params = inspect.signature(function).parameters
+
+    for k, p in params.items():
+        schema_dict[k] = converter.convert(p)
+
+    return schema_dict
+
+
+def param_to_field(value):
+    converter = AnnotationConverter()
+
+    return converter.convert(value)