rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Better handle response documentation

Browse source
This commit is contained in:
jtc42 2020-01-06 22:28:00 +00:00
parent 1ccdad8a86
commit 8afb0757bd
12 changed files with 143 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

38
openflexure_microscope/common/flask_labthings/views/extensions.py
View file

@ -6,46 +6,10 @@ from openflexure_microscope.common.flask_labthings.utilities import get_docstrin
from openflexure_microscope.common.flask_labthings.schema import Schema
from openflexure_microscope.common.flask_labthings import fields
from ..utilities import description_from_view
from ..resource import Resource
from ..find import registered_extensions
from ..schema import ExtensionSchema
from ..decorators import marshal_with
from marshmallow import pre_dump
from flask import jsonify, url_for
import logging
class ExtensionSchema(Schema):
name = fields.String(data_key="title")
_name_python_safe = fields.String(data_key="pythonName")
_cls = fields.String(data_key="pythonObject")
gui = fields.Dict()
description = fields.String()
links = fields.Dict()
# TODO: Automate this somewhat
@pre_dump
def generate_links(self, data, **kwargs):
d = {}
for view_id, view_data in data.views.items():
view_cls = view_data["view"]
view_kwargs = view_data["kwargs"]
view_rule = view_data["rule"]
# Make links dictionary if it doesn't yet exist
d[view_id] = {
"href": url_for(ExtensionList.endpoint, **view_kwargs, _external=True)
+ view_rule,
**description_from_view(view_cls),
}
data.links = d
return data
class ExtensionList(Resource):

32
openflexure_microscope/common/flask_labthings/views/tasks.py
View file

@ -2,40 +2,10 @@ from flask import abort, url_for
from ..decorators import marshal_with
from ..resource import Resource
from ..schema import Schema
from .. import fields
from ..utilities import description_from_view
from ..spec import update_spec
from ..schema import TaskSchema
from openflexure_microscope.common.labthings_core import tasks
from marshmallow import pre_dump
class TaskSchema(Schema):
_ID = fields.String(data_key="id")
target_string = fields.String(data_key="function")
_status = fields.String(data_key="status")
progress = fields.String()
data = fields.Raw()
_return_value = fields.Raw(data_key="return")
_start_time = fields.String(data_key="start_time")
_end_time = fields.String(data_key="end_time")
links = fields.Dict()
# TODO: Automate this somewhat
@pre_dump
def generate_links(self, data, **kwargs):
data.links = {
"self": {
"href": url_for(TaskResource.endpoint, id=data.id, _external=True),
"mimetype": "application/json",
**description_from_view(TaskResource),
}
}
return data
class TaskList(Resource):
"""