Tidied up static path generation

Author: Joel Collins

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
+from labthings.core.utilities import path_relative_to
 import os
 
 from labthings.server.extensions import BaseExtension
@@ -38,7 +39,8 @@ def ext_on_my_component(component):
     logging.info(f"{component} registered and noticed by extension")
 
 
-static_folder = os.path.join(os.path.abspath(os.path.dirname(__file__)), "static")
+static_folder = path_relative_to(__file__, "static")
+print(static_folder)
 
 example_extension = BaseExtension(
     "org.labthings.examples.extension", static_folder=static_folder

labthings/core/utilities.py

@@ -2,6 +2,7 @@
 import re
 import operator
 import sys
+import os
 from functools import reduce
 
 PY3 = sys.version_info > (3,)
@@ -189,3 +190,12 @@ def snake_to_camel(snake_str):
     components = snake_str.split("_")
     return components[0] + "".join(x.title() for x in components[1:])
 
+
+def path_relative_to(source_file, *paths):
+    """Given a python module __file__, return an absolute path relative to its location
+    
+    Args:
+        source_file: Module __file__ attribute
+        paths {str} -- Paths to add to source file location
+    """
+    return os.path.join(os.path.abspath(os.path.dirname(source_file)), *paths)

labthings/server/extensions.py

@@ -53,6 +53,7 @@ def __init__(
         self.methods = {}
 
         if static_folder:
+            print(f"Adding route for {static_folder}")
             self.static_view_class = static_from(static_folder)
             self.add_view(self.static_view_class, f"{static_url_path}/<path:path>")
         else:
@@ -71,7 +72,12 @@ def add_view(self, view_class, rule, **kwargs):
         # Expand the rule to include extension name
         full_rule = "/{}/{}".format(self._name_uri_safe, cleaned_rule)
 
-        view_id = cleaned_rule.replace("/", "_").replace("<", "").replace(">", "")
+        view_id = (
+            cleaned_rule.replace("/", "_")
+            .replace("<", "")
+            .replace(">", "")
+            .replace(":", "_")
+        )
 
         # Store route information in a dictionary
         d = {"rule": full_rule, "view": view_class, "kwargs": kwargs}