Added static file directories to extensions

Author: Joel Collins

examples/builder.py

@@ -4,7 +4,8 @@
 import atexit
 import logging
 
-from labthings.server.quick import create_app, property_of
+from labthings.server.quick import create_app
+from labthings.server.view.builder import property_of
 
 from components.pdf_component import PdfComponent
 

examples/simple_extensions.py

@@ -17,6 +17,7 @@
 from labthings.server.find import find_component
 from labthings.server import fields
 from labthings.core.tasks import taskify
+import os
 
 from labthings.server.extensions import BaseExtension
 
@@ -37,7 +38,12 @@ def ext_on_my_component(component):
     logging.info(f"{component} registered and noticed by extension")
 
 
-example_extension = BaseExtension("org.labthings.examples.extension")
+static_folder = os.path.join(os.path.abspath(os.path.dirname(__file__)), "static")
+
+example_extension = BaseExtension(
+    "org.labthings.examples.extension", static_folder=static_folder
+)
+
 example_extension.on_register(ext_on_register)
 example_extension.on_component("org.labthings.example.mycomponent", ext_on_my_component)
 

examples/static/example.json

@@ -0,0 +1,4 @@
+{
+    "app": "python-labthings",
+    "name": "squidward"
+}

labthings/server/extensions.py

@@ -6,6 +6,7 @@
 import os
 import glob
 
+from .view.builder import static_from
 from ..core.utilities import get_docstring, camel_to_snake, snake_to_spine
 
 
@@ -18,7 +19,14 @@ class BaseExtension:
 
     # TODO: Allow adding components to extensions
 
-    def __init__(self, name: str, description="", version="0.0.0"):
+    def __init__(
+        self,
+        name: str,
+        description="",
+        version="0.0.0",
+        static_url_path="/static",
+        static_folder=None,
+    ):
         self._views = (
             {}
         )  # Key: Full, Python-safe ID. Val: Original rule, and view class
@@ -44,6 +52,12 @@ def __init__(self, name: str, description="", version="0.0.0"):
 
         self.methods = {}
 
+        if static_folder:
+            self.static_view_class = static_from(static_folder)
+            self.add_view(self.static_view_class, f"{static_url_path}/<path:path>")
+        else:
+            self.static_view_class = None
+
     @property
     def views(self):
         return self._views

labthings/server/quick.py

@@ -1,13 +1,10 @@
 from flask import Flask
+
 from flask_cors import CORS
 
 from .labthing import LabThing
 from .exceptions import JSONExceptionHandler
 
-from .view import View
-from .types import value_to_field, data_dict_to_schema
-from .decorators import ThingProperty, PropertySchema, Doc
-
 
 def create_app(
     import_name,
@@ -66,58 +63,3 @@ def create_app(
 
     return app, labthing
 
-
-def property_of(
-    property_object, property_name, name: str = None, readonly=False, description=None
-):
-
-    # Create a class name
-    if not name:
-        name = type(property_object).__name__ + f"_{property_name}"
-
-    # Create inner functions
-    def _get(self):
-        return getattr(property_object, property_name)
-
-    def _post(self, args):
-        setattr(property_object, property_name, args)
-        return getattr(property_object, property_name)
-
-    def _put(self, args):
-        getattr(property_object, property_name).update(args)
-        return getattr(property_object, property_name)
-
-    # Generate a basic property class
-    generated_class = type(
-        name,
-        (View, object),
-        {
-            "property_object": property_object,
-            "property_name": property_name,
-            "get": _get,
-        },
-    )
-
-    # Override read-write capabilities
-    if not readonly:
-        generated_class.post = _post
-        # Enable PUT requests for dictionaries
-        if type(getattr(property_object, property_name)) == dict:
-            generated_class.put = _put
-
-    # Add decorators for arguments etc
-    initial_property_value = getattr(property_object, property_name)
-    if type(initial_property_value) == dict:
-        property_schema = data_dict_to_schema(initial_property_value)
-    else:
-        property_schema = value_to_field(initial_property_value)
-
-    generated_class = PropertySchema(property_schema)(generated_class)
-    generated_class = ThingProperty(generated_class)
-
-    if description:
-        generated_class = Doc(description=description, summary=description)(
-            generated_class
-        )
-
-    return generated_class

labthings/server/view.py labthings/server/view/__init__.pylabthings/server/view.py renamed to labthings/server/view/__init__.py

@@ -0,0 +1,79 @@
+from labthings.server.types import value_to_field, data_dict_to_schema
+from labthings.server.decorators import ThingProperty, PropertySchema, Doc
+from . import View
+
+from flask import send_from_directory
+import uuid
+
+
+def property_of(
+    property_object, property_name, name: str = None, readonly=False, description=None
+):
+
+    # Create a class name
+    if not name:
+        name = type(property_object).__name__ + f"_{property_name}"
+
+    # Create inner functions
+    def _get(self):
+        return getattr(property_object, property_name)
+
+    def _post(self, args):
+        setattr(property_object, property_name, args)
+        return getattr(property_object, property_name)
+
+    def _put(self, args):
+        getattr(property_object, property_name).update(args)
+        return getattr(property_object, property_name)
+
+    # Generate a basic property class
+    generated_class = type(
+        name,
+        (View, object),
+        {
+            "property_object": property_object,
+            "property_name": property_name,
+            "get": _get,
+        },
+    )
+
+    # Override read-write capabilities
+    if not readonly:
+        generated_class.post = _post
+        # Enable PUT requests for dictionaries
+        if type(getattr(property_object, property_name)) == dict:
+            generated_class.put = _put
+
+    # Add decorators for arguments etc
+    initial_property_value = getattr(property_object, property_name)
+    if type(initial_property_value) == dict:
+        property_schema = data_dict_to_schema(initial_property_value)
+    else:
+        property_schema = value_to_field(initial_property_value)
+
+    generated_class = PropertySchema(property_schema)(generated_class)
+    generated_class = ThingProperty(generated_class)
+
+    if description:
+        generated_class = Doc(description=description, summary=description)(
+            generated_class
+        )
+
+    return generated_class
+
+
+def static_from(static_folder: str, name=None):
+
+    # Create a class name
+    if not name:
+        uid = uuid.uuid4()
+        name = f"static-{uid}"
+
+    # Create inner functions
+    def _get(self, path):
+        return send_from_directory(static_folder, path)
+
+    # Generate a basic property class
+    generated_class = type(name, (View, object), {"get": _get,},)
+
+    return generated_class