Moved json.paths functions into json.schemas

Author: Joel Collins

src/labthings/__init__.py

@@ -35,10 +35,27 @@
 from . import json
 
 __all__ = [
+    "LabThing",
+    "create_app",
+    "Server",
     "current_labthing",
     "registered_extensions",
     "registered_components",
     "find_extension",
     "find_component",
+    "StrictLock",
+    "CompositeLock",
+    "ClientEvent",
+    "current_task",
+    "current_task_stopped"
+    "update_task_progress"
+    "update_task_data"
+    "TaskKillException",
+    "extensions",
+    "views",
+    "fields",
+    "schema",
+    "semantics",
+    "json",
 ]
 

src/labthings/apispec/apispec.py

@@ -1,5 +1,5 @@
 from apispec import APISpec
-from ..json.paths import rule_to_path, rule_to_params
+from ..json.schemas import rule_to_path, rule_to_params
 from .utilities import convert_to_schema_or_json
 
 from ..utilities import get_docstring, get_summary

src/labthings/json/paths.py

@@ -1,6 +1,80 @@
+import werkzeug.routing
+import re
 from marshmallow import Schema, fields
-from .marshmallow_jsonschema import JSONSchema
 from collections.abc import Mapping
+from .marshmallow_jsonschema import JSONSchema
+
+
+PATH_RE = re.compile(r"<(?:[^:<>]+:)?([^<>]+)>")
+# Conversion map of werkzeug rule converters to Javascript schema types
+CONVERTER_MAPPING = {
+    werkzeug.routing.UnicodeConverter: ("string", None),
+    werkzeug.routing.IntegerConverter: ("integer", "int32"),
+    werkzeug.routing.FloatConverter: ("number", "float"),
+}
+
+DEFAULT_TYPE = ("string", None)
+
+
+def rule_to_path(rule):
+    """Convert a Flask rule into an JSON schema formatted URL path
+    
+    Args:
+        rule: Flask rule object
+    
+    Returns:
+        str: URL path
+    """
+    return PATH_RE.sub(r"{\1}", rule.rule)
+
+
+def rule_to_params(rule, overrides=None):
+    """Convert a Flask rule into JSON schema URL parameters description
+    
+    Args:
+        rule: Flask rule object
+        overrides (dict, optional): Optional dictionary to override params with
+    
+    Returns:
+        dict: Dictionary of URL parameters
+    """
+    overrides = overrides or {}
+    result = [
+        argument_to_param(argument, rule, overrides.get(argument, {}))
+        for argument in rule.arguments
+    ]
+    for key in overrides.keys():
+        if overrides[key].get("in") in ("header", "query"):
+            overrides[key]["name"] = overrides[key].get("name", key)
+            result.append(overrides[key])
+    return result
+
+
+def argument_to_param(argument, rule, override=None):
+    """Convert a Flask rule into APISpec URL parameters description
+    
+    Args:
+        argument (str): URL argument
+        rule: Flask rule object
+        override (dict, optional): Optional dictionary to override params with
+    
+    Returns:
+        dict: Dictionary of URL parameter description
+    """
+    param = {"in": "path", "name": argument, "required": True}
+    type_, format_ = CONVERTER_MAPPING.get(
+        # skipcq: PYL-W0212
+        type(rule._converters[argument]),
+        DEFAULT_TYPE,
+    )
+    param["schema"] = {}
+    param["schema"]["type"] = type_
+    if format_ is not None:
+        param["format"] = format_
+    if rule.defaults and argument in rule.defaults:
+        param["default"] = rule.defaults[argument]
+    param.update(override or {})
+    return param
 
 
 def field_to_property(field):

src/labthings/json/schemas.py

@@ -10,11 +10,6 @@
 
 __all__ = [
     "Schema",
-    "FieldSchema",
-    "TaskSchema",
-    "ExtensionSchema",
-    "ActionSchema",
-    "build_action_schema",
     "pre_load",
     "pre_dump",
     "validate",

src/labthings/schema.py

@@ -2,8 +2,7 @@
 
 from .views import View
 from .event import Event
-from .json.schemas import schema_to_json
-from .json.paths import rule_to_params, rule_to_path
+from .json.schemas import schema_to_json, rule_to_params, rule_to_path
 from .find import current_labthing
 from .utilities import get_docstring, snake_to_camel
 

src/labthings/td.py

@@ -1,4 +1,4 @@
-from labthings.json import paths
+from labthings.json import schemas
 
 
 def make_rule(app, path, **kwargs):
@@ -17,19 +17,19 @@ def make_param(in_location="path", **kwargs):
 
 def test_rule_to_path(app):
     rule = make_rule(app, "/path/<id>/")
-    assert paths.rule_to_path(rule) == "/path/{id}/"
+    assert schemas.rule_to_path(rule) == "/path/{id}/"
 
 
 def test_rule_to_param(app):
     rule = make_rule(app, "/path/<id>/")
-    assert paths.rule_to_params(rule) == [
+    assert schemas.rule_to_params(rule) == [
         {"in": "path", "name": "id", "required": True, "schema": {"type": "string"}}
     ]
 
 
 def test_rule_to_param_typed(app):
     rule = make_rule(app, "/path/<int:id>/")
-    assert paths.rule_to_params(rule) == [
+    assert schemas.rule_to_params(rule) == [
         {
             "in": "path",
             "name": "id",
@@ -42,7 +42,7 @@ def test_rule_to_param_typed(app):
 
 def test_rule_to_param_typed_default(app):
     rule = make_rule(app, "/path/<int:id>/", defaults={"id": 1})
-    assert paths.rule_to_params(rule) == [
+    assert schemas.rule_to_params(rule) == [
         {
             "in": "path",
             "name": "id",
@@ -57,7 +57,7 @@ def test_rule_to_param_typed_default(app):
 def test_rule_to_param_overrides(app):
     rule = make_rule(app, "/path/<id>/")
     overrides = {"override_key": {"in": "header", "name": "header_param"}}
-    assert paths.rule_to_params(rule, overrides=overrides) == [
+    assert schemas.rule_to_params(rule, overrides=overrides) == [
         {"in": "path", "name": "id", "required": True, "schema": {"type": "string"}},
         *overrides.values(),
     ]
@@ -66,6 +66,6 @@ def test_rule_to_param_overrides(app):
 def test_rule_to_param_overrides_invalid(app):
     rule = make_rule(app, "/path/<id>/")
     overrides = {"override_key": {"in": "invalid", "name": "header_param"}}
-    assert paths.rule_to_params(rule, overrides=overrides) == [
+    assert schemas.rule_to_params(rule, overrides=overrides) == [
         {"in": "path", "name": "id", "required": True, "schema": {"type": "string"}}
     ]