Switched to ActionView and PropertyView from decorators

This commit is contained in:
Joel Collins 2020-05-26 10:54:21 +01:00
parent 677b08d509
commit 1819ca6a9c
18 changed files with 57 additions and 98 deletions

View file

@ -1,5 +1,5 @@
from openflexure_microscope.api.utilities import get_bool, JsonResponse
from labthings.server.view import View
from labthings.server.view import View, ActionView
from labthings.server.find import find_component
from labthings.server.decorators import (
use_args,
@ -20,8 +20,7 @@ import io
from flask import request, abort, url_for, redirect, send_file
@ThingAction
class CaptureAPI(View):
class CaptureAPI(ActionView):
"""
Create a new image capture.
"""
@ -75,8 +74,7 @@ class CaptureAPI(View):
@ThingAction
class RAMCaptureAPI(View):
class RAMCaptureAPI(ActionView):
"""
Take a non-persistant image capture.
"""
@ -124,8 +122,7 @@ class RAMCaptureAPI(View):
return send_file(io.BytesIO(stream.getbuffer()), mimetype="image/jpeg")
@ThingAction
class GPUPreviewStartAPI(View):
class GPUPreviewStartAPI(ActionView):
"""
Start the onboard GPU preview.
Optional "window" parameter can be passed to control the position and size of the preview window,
@ -157,8 +154,7 @@ class GPUPreviewStartAPI(View):
return microscope.state
@ThingAction
class GPUPreviewStopAPI(View):
class GPUPreviewStopAPI(ActionView):
def post(self):
"""
Stop the onboard GPU preview.

View file

@ -1,5 +1,5 @@
from openflexure_microscope.api.utilities import JsonResponse
from labthings.server.view import View
from labthings.server.view import View, ActionView
from labthings.server.find import find_component
from labthings.server.decorators import use_args, marshal_with, doc, ThingAction
from labthings.server import fields
@ -11,8 +11,7 @@ from flask import Blueprint, request
import logging
@ThingAction
class MoveStageAPI(View):
class MoveStageAPI(ActionView):
@use_args(
{
"absolute": fields.Boolean(
@ -56,8 +55,7 @@ class MoveStageAPI(View):
return microscope.state["stage"]["position"]
@ThingAction
class ZeroStageAPI(View):
class ZeroStageAPI(ActionView):
def post(self):
"""
Zero the stage coordinates.

View file

@ -1,4 +1,4 @@
from labthings.server.view import View
from labthings.server.view import View, ActionView
import subprocess
import os
from sys import platform
@ -14,8 +14,7 @@ def is_raspberrypi(raise_on_errors=False):
return os.path.exists("/usr/bin/raspi-config")
@ThingAction
class ShutdownAPI(View):
class ShutdownAPI(ActionView):
"""
Attempt to shutdown the device
"""
@ -35,8 +34,7 @@ class ShutdownAPI(View):
return {"out": out, "err": err}, 201
@ThingAction
class RebootAPI(View):
class RebootAPI(ActionView):
"""
Attempt to reboot the device
"""

View file

@ -5,7 +5,7 @@ from openflexure_microscope.api.utilities import get_bool, JsonResponse
from labthings.server.schema import Schema
from labthings.server import fields
from labthings.server.view import View
from labthings.server.view import View, PropertyView
from labthings.server.utilities import description_from_view
from labthings.server.decorators import marshal_with, doc_response, Tag, ThingProperty
@ -91,9 +91,8 @@ capture_list_schema = CaptureSchema(many=True)
from pprint import pprint
@ThingProperty
@Tag("captures")
class CaptureList(View):
class CaptureList(PropertyView):
@marshal_with(CaptureSchema(many=True))
def get(self):
"""

View file

@ -3,7 +3,7 @@ from openflexure_microscope.api.utilities import JsonResponse
from labthings.core.utilities import get_by_path, set_by_path, create_from_path
from labthings.server.find import find_component
from labthings.server.view import View
from labthings.server.view import View, PropertyView
from labthings.server.decorators import ThingProperty, Tag, doc_response
@ -11,8 +11,7 @@ from flask import request, abort
import logging
@ThingProperty
class SettingsProperty(View):
class SettingsProperty(PropertyView):
def get(self):
"""
Current microscope settings, including camera and stage
@ -71,8 +70,7 @@ class NestedSettingsProperty(View):
return self.get(route)
@ThingProperty
class StateProperty(View):
class StateProperty(PropertyView):
def get(self):
"""
Show current read-only state of the microscope
@ -99,8 +97,7 @@ class NestedStateProperty(View):
return value
@ThingProperty
class ConfigurationProperty(View):
class ConfigurationProperty(PropertyView):
def get(self):
"""
Show current read-only state of the microscope

View file

@ -3,14 +3,13 @@ from openflexure_microscope.api.utilities import gen, JsonResponse
from labthings.core.utilities import get_by_path, set_by_path, create_from_path
from labthings.server.find import find_component
from labthings.server.view import View
from labthings.server.view import View, PropertyView
from labthings.server.decorators import doc_response, ThingProperty
from flask import Response
@ThingProperty
class MjpegStream(View):
class MjpegStream(PropertyView):
"""
Real-time MJPEG stream from the microscope camera
"""
@ -38,8 +37,7 @@ class MjpegStream(View):
)
@ThingProperty
class SnapshotStream(View):
class SnapshotStream(PropertyView):
"""
Single JPEG snapshot from the camera stream
"""