First draft of auto-property builder

Author: Joel Collins

examples/builder.py

@@ -0,0 +1,78 @@
+import uuid
+
+from labthings.server.quick import create_app
+from labthings.server.view import View
+from labthings.server.decorators import (
+    ThingProperty,
+    PropertySchema,
+    use_args,
+)
+
+from labthings.server.types import value_to_field
+
+from components.pdf_component import PdfComponent
+
+
+class BasePropertyResource(View):
+    def __init__(self):
+        super().__init__()
+        """
+        Properties to be added by constructor function:
+        property_object: Object containing the property
+        property_name: String name of property of object
+        """
+
+    def get(self):
+        return getattr(self.property_object, self.property_name)
+
+    def post(self, args):
+        setattr(self.property_object, self.property_name, args)
+        return getattr(self.property_object, self.property_name)
+
+
+def gen_property(property_object, property_name, name: str = None, post=True):
+
+    # Create a class name
+    if not name:
+        name = type(property_object).__name__ + f"_{property_name}"
+
+    # Generate a basic property class
+    generated_class = type(
+        name,
+        (BasePropertyResource, object),
+        {"property_object": property_object, "property_name": property_name,},
+    )
+
+    # Override read-write capabilities
+    if not post:
+        generated_class.post = None
+
+    # Add decorators for arguments etc
+    initial_property_value = getattr(property_object, property_name)
+    generated_class = PropertySchema(value_to_field(initial_property_value))(
+        generated_class
+    )
+    generated_class = ThingProperty(generated_class)
+
+    return generated_class
+
+
+# Create LabThings Flask app
+app, labthing = create_app(
+    __name__,
+    prefix="/api",
+    title=f"My Lab Device API",
+    description="Test LabThing-based API",
+    version="0.1.0",
+)
+
+# Attach an instance of our component
+my_component = PdfComponent()
+labthing.add_component(my_component, "org.labthings.example.mycomponent")
+
+# Add routes for the API views we created
+labthing.add_view(gen_property(my_component, "magic_denoise"), "/denoise")
+
+# Start the app
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port="5000", threaded=True, debug=True, use_reloader=False)

examples/components/__init__.py

@@ -0,0 +1,43 @@
+import random
+import math
+import time
+
+"""
+Class for our lab component functionality. This could include serial communication,
+equipment API calls, network requests, or a "virtual" device as seen here.
+"""
+
+
+class PdfComponent:
+    def __init__(self):
+        self.x_range = range(-100, 100)
+        self.magic_denoise = 200
+
+    def noisy_pdf(self, x, mu=0.0, sigma=25.0):
+        """
+        Generate a noisy gaussian function (to act as some pretend data)
+        
+        Our noise is inversely proportional to self.magic_denoise
+        """
+        x = float(x - mu) / sigma
+        return (
+            math.exp(-x * x / 2.0) / math.sqrt(2.0 * math.pi) / sigma
+            + (1 / self.magic_denoise) * random.random()
+        )
+
+    @property
+    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):
+        """Average n-sets of data. Emulates a measurement that may take a while."""
+        summed_data = self.data
+
+        for i in range(n):
+            summed_data = [summed_data[i] + el for i, el in enumerate(self.data)]
+            time.sleep(0.25)
+
+        summed_data = [i / n for i in summed_data]
+
+        return summed_data