Converted view class tags to set()

Author: Joel Collins

labthings/server/decorators.py

@@ -8,7 +8,7 @@
 
 from marshmallow import Schema as _Schema
 
-from .spec.utilities import update_spec
+from .spec.utilities import update_spec, tag_spec
 from .schema import TaskSchema, Schema, FieldSchema
 from .fields import Field
 from .view import View
@@ -100,8 +100,7 @@ def ThingAction(viewcls: View):
         View: View class with Action spec tags
     """
     # Update Views API spec
-    update_spec(viewcls, {"tags": ["actions"]})
-    update_spec(viewcls, {"_groups": ["actions"]})
+    tag_spec(viewcls, "actions")
     return viewcls
 
 
@@ -173,8 +172,7 @@ def wrapped(*args, **kwargs):
         viewcls.put = property_notify(viewcls.put)
 
     # Update Views API spec
-    update_spec(viewcls, {"tags": ["properties"]})
-    update_spec(viewcls, {"_groups": ["properties"]})
+    tag_spec(viewcls, "properties")
     return viewcls
 
 
@@ -281,16 +279,11 @@ def __call__(self, f):
 
 class Tag:
     def __init__(self, tags):
-        if isinstance(tags, str):
-            self.tags = [tags]
-        elif isinstance(tags, list) and all([isinstance(e, str) for e in tags]):
-            self.tags = tags
-        else:
-            raise TypeError("Tags must be a string or list of strings")
+        self.tags = tags
 
     def __call__(self, f):
         # Pass params to call function attribute for external access
-        update_spec(f, {"tags": self.tags})
+        tag_spec(f, self.tags)
         return f
 
 

labthings/server/labthing.py

@@ -303,11 +303,11 @@ def _register_view(self, app, view, *urls, endpoint=None, **kwargs):
 
         # Handle resource groups listed in API spec
         view_spec = get_spec(view)
-        view_groups = view_spec.get("_groups", [])
-        if "actions" in view_groups:
+        view_tags = view_spec.get("tags", set())
+        if "actions" in view_tags:
             self.thing_description.action(flask_rules, view)
             self._action_views[view.endpoint] = view
-        if "properties" in view_groups:
+        if "properties" in view_tags:
             self.thing_description.property(flask_rules, view)
             self._property_views[view.endpoint] = view
 

labthings/server/spec/apispec.py

@@ -168,8 +168,8 @@ def build_spec(view, inherit_from=None):
     )
 
     # Build tags
-    tags = getattr(view, "__apispec__").get("tags", [])
-    tags.extend(inherited_spec.get("tags", []))
+    tags = getattr(view, "__apispec__").get("tags", set())
+    tags = tags.union(inherited_spec.get("tags", set()))
 
     return update_spec(
         view, {"description": description, "summary": summary, "tags": tags}

labthings/server/spec/utilities.py

@@ -21,6 +21,18 @@ def update_spec(obj, spec: dict):
     return obj.__apispec__ or {}
 
 
+def tag_spec(obj, tags, add_group: bool = True):
+    obj.__apispec__ = obj.__dict__.get("__apispec__", {})
+
+    if "tags" not in obj.__apispec__:
+        obj.__apispec__["tags"] = set()
+
+    if isinstance(tags, set) or isinstance(tags, list):
+        obj.__apispec__["tags"] = obj.__apispec__["tags"].union(tags)
+    else:
+        obj.__apispec__["tags"].add(tags)
+
+
 def get_spec(obj):
     """
     Get the __apispec__ dictionary, created by LabThings decorators,