Merge pull request #110 from labthings/simpler-spec

Schemas without decorators

Author: jtc42

codecov.yml

@@ -3,12 +3,12 @@ coverage:
     project:
       default:
         # basic
-        target: 95%
-        threshold: 1%
+        target: auto
+        threshold: 5%
         base: auto
     patch:
       default:
         # basic
-        target: auto
-        threshold: 1%
+        target: 80%
+        threshold: 5%
         base: auto

examples/builder.py

@@ -16,7 +16,6 @@
 # Create LabThings Flask app
 app, labthing = create_app(
     __name__,
-    prefix="/api",
     title="My Lab Device API",
     description="Test LabThing-based API",
     version="0.1.0",

examples/nested_thing.py

@@ -5,7 +5,7 @@
 
 from labthings.server.quick import create_app
 from labthings.server.decorators import ThingProperty, PropertySchema
-from labthings.server.view import View
+from labthings.server.view import PropertyView
 from labthings.server.find import find_component
 from labthings.server.schema import Schema
 from labthings.server import fields
@@ -64,19 +64,15 @@ class MyComponentSchema(Schema):
 """
 
 
-# Register this view as a Thing Property
-@ThingProperty
-# Define the data we're going to output (get), and what to expect in (post)
-@PropertySchema(
-    fields.Integer(
+class DenoiseProperty(PropertyView):
+
+    schema = fields.Integer(
         required=True,
         example=200,
         minimum=100,
         maximum=500,
         description="Value of magic_denoise",
     )
-)
-class DenoiseProperty(View):
 
     # Main function to handle GET requests (read)
     def get(self):
@@ -104,10 +100,11 @@ def post(self, new_property_value):
 """
 
 
-@ThingProperty
-@PropertySchema(MyComponentSchema())
-class MyComponentProperty(View):
+class MyComponentProperty(PropertyView):
     # Main function to handle GET requests
+
+    schema = MyComponentSchema()
+
     def get(self):
         """Show the current data value"""
 

examples/properties_dictionary.py

@@ -3,15 +3,7 @@
 import logging
 
 from labthings.server.quick import create_app
-from labthings.server.decorators import (
-    ThingProperty,
-    PropertySchema,
-    ThingAction,
-    use_args,
-    marshal_task,
-    doc,
-)
-from labthings.server.view import View
+from labthings.server.view import ActionView, PropertyView
 from labthings.server.find import find_component
 from labthings.server import fields
 from labthings.core.utilities import path_relative_to
@@ -28,26 +20,16 @@
 """
 
 
-@ThingAction
-class ExtensionMeasurementAction(View):
-    # Expect JSON parameters in the request body.
-    # Pass to post function as dictionary argument.
-    @use_args(
-        {
-            "averages": fields.Integer(
-                missing=10,
-                example=10,
-                description="Number of data sets to average over",
-            )
-        }
-    )
-    # Shorthand to say we're always going to return a Task object
-    @marshal_task
-    @doc(title="Averaged Measurement")
-    # Main function to handle POST requests
-    def post(self, args):
-        """Start an averaged measurement"""
+class ExtensionMeasurementAction(ActionView):
+    """Start an averaged measurement"""
+
+    args = {
+        "averages": fields.Integer(
+            missing=10, example=10, description="Number of data sets to average over",
+        )
+    }
 
+    def post(self, args):
         # Find our attached component
         my_component = find_component("org.labthings.example.mycomponent")
 
@@ -115,17 +97,15 @@ def data(self):
 """
 
 
-@ThingProperty  # Register this view as a Thing Property
-@PropertySchema(  # Define the data we're going to output (get), and what to expect in (post)
-    fields.Integer(
+class DenoiseProperty(PropertyView):
+
+    schema = fields.Integer(
         required=True,
         example=200,
         minimum=100,
         maximum=500,
         description="Value of magic_denoise",
     )
-)
-class DenoiseProperty(View):
 
     # Main function to handle GET requests (read)
     def get(self):
@@ -153,9 +133,10 @@ def post(self, new_property_value):
 """
 
 
-@ThingProperty
-@PropertySchema(fields.List(fields.Float()))
-class QuickDataProperty(View):
+class QuickDataProperty(PropertyView):
+
+    schema = fields.List(fields.Float())
+
     # Main function to handle GET requests
     def get(self):
         """Show the current data value"""

examples/simple_extensions.py

@@ -13,7 +13,6 @@
 import atexit
 
 from labthings.server.quick import create_app
-from labthings.server.decorators import PropertySchema, use_args, marshal_with, Doc
 from labthings.server import semantics
 from labthings.server.view import ActionView, PropertyView
 from labthings.server.find import find_component
@@ -73,23 +72,17 @@ def average_data(self, n: int):
 """
 
 
-# Define the data we're going to output (get), and what to expect in (post)
+# Wrap in a semantic annotation to autmatically set schema and args
 @semantics.moz.LevelProperty(100, 500, example=200)
-@Doc(description="Value of magic_denoise",)
 class DenoiseProperty(PropertyView):
+    """Value of magic_denoise"""
 
-    # Main function to handle GET requests (read)
     def get(self):
-        """Show the current magic_denoise value"""
-
         # When a GET request is made, we'll find our attached component
         my_component = find_component("org.labthings.example.mycomponent")
         return my_component.magic_denoise
 
-    # Main function to handle POST requests (write)
-    def post(self, new_property_value):
-        """Change the current magic_denoise value"""
-
+    def put(self, new_property_value):
         # Find our attached component
         my_component = find_component("org.labthings.example.mycomponent")
 
@@ -104,12 +97,13 @@ def post(self, new_property_value):
 """
 
 
-@PropertySchema(fields.List(fields.Float()))
 class QuickDataProperty(PropertyView):
-    # Main function to handle GET requests
-    def get(self):
-        """Show the current data value"""
+    """Show the current data value"""
+
+    # Marshal the response as a list of floats
+    schema = fields.List(fields.Float())
 
+    def get(self):
         # Find our attached component
         my_component = find_component("org.labthings.example.mycomponent")
         return my_component.data
@@ -123,17 +117,14 @@ def get(self):
 class MeasurementAction(ActionView):
     # Expect JSON parameters in the request body.
     # Pass to post function as dictionary argument.
-    @use_args(
-        {
-            "averages": fields.Integer(
-                missing=20,
-                example=20,
-                description="Number of data sets to average over",
-            )
-        }
-    )
-    # Output schema
-    @marshal_with(fields.List(fields.Number))
+    args = {
+        "averages": fields.Integer(
+            missing=20, example=20, description="Number of data sets to average over",
+        )
+    }
+    # Marshal the response as a list of numbers
+    schema = fields.List(fields.Number)
+
     # Main function to handle POST requests
     def post(self, args):
         """Start an averaged measurement"""

examples/simple_thing.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "labthings"
-version = "0.6.7"
+version = "0.7.0-beta.0"
 description = "Python implementation of LabThings, based on the Flask microframework"
 readme = "README.md"
 repository = "https://github.com/labthings/python-labthings/"

pyproject.toml

@@ -38,7 +38,7 @@ def __call__(self, timeout=sentinel, blocking=True):
         yield result
         if result:
             self.release()
-        
+
     def locked(self):
         return self._lock.locked()
 
@@ -96,7 +96,7 @@ def __call__(self, timeout=sentinel, blocking=True):
         yield result
         if result:
             self.release()
-        
+
     def acquire(self, blocking=True, timeout=sentinel):
         if timeout is sentinel:
             timeout = self.timeout