151 lines
4.2 KiB
Python
151 lines
4.2 KiB
Python
from .resource import Resource
|
|
from apispec import APISpec
|
|
from apispec.ext.marshmallow import MarshmallowPlugin
|
|
|
|
from openflexure_microscope.common.labthings_core.utilities import (
|
|
get_docstring,
|
|
get_summary,
|
|
rupdate,
|
|
)
|
|
|
|
from .fields import Field
|
|
from marshmallow import Schema as BaseSchema
|
|
|
|
from collections import Mapping
|
|
from http import HTTPStatus
|
|
|
|
|
|
def update_spec(obj, spec):
|
|
obj.__apispec__ = obj.__dict__.get("__apispec__", {})
|
|
rupdate(obj.__apispec__, spec)
|
|
return obj.__apispec__
|
|
|
|
def get_spec(obj):
|
|
obj.__apispec__ = obj.__dict__.get("__apispec__", {})
|
|
return obj.__apispec__
|
|
|
|
def view2path(rule: str, view: Resource, spec: APISpec):
|
|
params = {
|
|
"path": rule, # TODO: Validate this slightly (leading / etc)
|
|
"operations": view2operations(view, spec),
|
|
"description": get_docstring(view),
|
|
"summary": get_summary(view),
|
|
}
|
|
|
|
if hasattr(view, "__apispec__"):
|
|
# Recursively update params
|
|
rupdate(params, view.__apispec__)
|
|
|
|
return params
|
|
|
|
|
|
def view2operations(view: Resource, spec: APISpec):
|
|
# Operations inherit tags from parent
|
|
inherited_tags = []
|
|
if hasattr(view, "__apispec__"):
|
|
inherited_tags = getattr(view, "__apispec__").get("tags", [])
|
|
|
|
# Build dictionary of operations (HTTP methods)
|
|
ops = {}
|
|
for method in Resource.methods:
|
|
if hasattr(view, method):
|
|
ops[method] = {}
|
|
|
|
rupdate(
|
|
ops[method],
|
|
{
|
|
"description": get_docstring(getattr(view, method)),
|
|
"summary": get_summary(getattr(view, method)),
|
|
"tags": inherited_tags,
|
|
},
|
|
)
|
|
|
|
rupdate(ops[method], method2operation(getattr(view, method), spec))
|
|
|
|
return ops
|
|
|
|
|
|
def method2operation(method: callable, spec: APISpec):
|
|
if hasattr(method, "__apispec__"):
|
|
apispec = getattr(method, "__apispec__")
|
|
else:
|
|
apispec = {}
|
|
|
|
op = {}
|
|
if "_params" in apispec:
|
|
rupdate(
|
|
op,
|
|
{
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": convert_schema(apispec.get("_params"), spec)
|
|
}
|
|
}
|
|
}
|
|
},
|
|
)
|
|
|
|
if "_schema" in apispec:
|
|
for code, schema in apispec.get("_schema", {}).items():
|
|
rupdate(
|
|
op,
|
|
{
|
|
"responses": {
|
|
code: {
|
|
"description": HTTPStatus(code).phrase,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": convert_schema(schema, spec)
|
|
}
|
|
},
|
|
}
|
|
}
|
|
},
|
|
)
|
|
else:
|
|
# If no explicit responses are known, populate with defaults
|
|
rupdate(
|
|
op,
|
|
{
|
|
"responses": {
|
|
200: {"description": get_summary(method) or HTTPStatus(200).phrase}
|
|
}
|
|
},
|
|
)
|
|
|
|
# Bung in any extra swagger fields supplied
|
|
for key, val in apispec.items():
|
|
if not key in ["_params", "_schema"]:
|
|
rupdate(op, {key: val})
|
|
|
|
return op
|
|
|
|
|
|
def convert_schema(schema, spec: APISpec):
|
|
if isinstance(schema, BaseSchema):
|
|
return schema
|
|
elif isinstance(schema, Mapping):
|
|
return map2properties(schema, spec)
|
|
else:
|
|
raise TypeError(
|
|
"Unsupported schema type. Ensure schema is a Schema class, or dictionary of Field objects"
|
|
)
|
|
|
|
|
|
def map2properties(schema, spec: APISpec):
|
|
marshmallow_plugin = next(
|
|
plugin for plugin in spec.plugins if isinstance(plugin, MarshmallowPlugin)
|
|
)
|
|
converter = marshmallow_plugin.converter
|
|
|
|
d = {}
|
|
for k, v in schema.items():
|
|
if isinstance(v, Field):
|
|
d[k] = converter.field2property(v)
|
|
elif isinstance(v, Mapping):
|
|
d[k] = map2properties(v, spec)
|
|
else:
|
|
d[k] = v
|
|
|
|
return {"properties": d}
|