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

Improved args schema for captures

Browse source
This commit is contained in:
Joel Collins 2020-11-12 16:46:07 +00:00
parent 738f527c7e
commit f681800e26
1 changed files with 32 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

73
openflexure_microscope/api/v2/views/actions/camera.py
View file

@ -1,33 +1,39 @@
import io import io
import logging import logging
from flask import abort, send_file from flask import send_file
from labthings import fields, find_component from labthings import Schema, fields, find_component
from labthings.views import ActionView from labthings.views import ActionView
from openflexure_microscope.api.v2.views.captures import CaptureSchema from openflexure_microscope.api.v2.views.captures import CaptureSchema
class CaptureResizeSchema(Schema):
width = fields.Integer(example=640, required=True)
height = fields.Integer(example=480, required=True)
class BasicCaptureArgs(Schema):
use_video_port = fields.Boolean(missing=False)
bayer = fields.Boolean(
missing=False, description="Include raw bayer data in capture"
)
resize = fields.Nested(CaptureResizeSchema(), required=False)
class FullCaptureArgs(BasicCaptureArgs):
filename = fields.String(example="MyFileName")
temporary = fields.Boolean(missing=False, description="Delete capture on shutdown")
annotations = fields.Dict(missing={}, example={"Client": "SwaggerUI"})
tags = fields.List(fields.String, missing=[], example=["docs"])
class CaptureAPI(ActionView): class CaptureAPI(ActionView):
""" """
Create a new image capture. Create a new image capture.
""" """
args = { args = FullCaptureArgs()
"filename": fields.String(example="MyFileName"),
"temporary": fields.Boolean(
missing=False, description="Delete capture on shutdown"
),
"use_video_port": fields.Boolean(missing=False),
"bayer": fields.Boolean(
missing=False, description="Store raw bayer data in file"
),
"annotations": fields.Dict(missing={}, example={"Client": "SwaggerUI"}),
"tags": fields.List(fields.String, missing=[], example=["docs"]),
"resize": fields.Dict(
missing=None, example={"width": 640, "height": 480}
), # TODO: Validate keys
}
schema = CaptureSchema() schema = CaptureSchema()
def post(self, args): def post(self, args):
@ -38,13 +44,10 @@ class CaptureAPI(ActionView):
resize = args.get("resize", None) resize = args.get("resize", None)
if resize: if resize:
if ("width" in resize) and ("height" in resize): resize = (
resize = ( int(resize["width"]),
int(resize["width"]), int(resize["height"]),
int(resize["height"]), ) # Convert dict to tuple
) # Convert dict to tuple
else:
abort(404)
# Explicitally acquire lock (prevents empty files being created if lock is unavailable) # Explicitally acquire lock (prevents empty files being created if lock is unavailable)
with microscope.camera.lock: with microscope.camera.lock:
@ -64,16 +67,7 @@ class RAMCaptureAPI(ActionView):
Take a non-persistant image capture. Take a non-persistant image capture.
""" """
args = { args = BasicCaptureArgs()
"use_video_port": fields.Boolean(missing=True),
"bayer": fields.Boolean(
missing=False, description="Return with raw bayer data"
),
"resize": fields.Dict(
missing=None, example={"width": 640, "height": 480}
), # TODO: Validate keys
}
responses = {200: {"content_type": "image/jpeg"}} responses = {200: {"content_type": "image/jpeg"}}
def post(self, args): def post(self, args):
@ -84,13 +78,10 @@ class RAMCaptureAPI(ActionView):
resize = args.get("resize", None) resize = args.get("resize", None)
if resize: if resize:
if ("width" in resize) and ("height" in resize): resize = (
resize = ( int(resize["width"]),
int(resize["width"]), int(resize["height"]),
int(resize["height"]), ) # Convert dict to tuple
) # Convert dict to tuple
else:
abort(404)
# Open a BytesIO stream to be destroyed once request has returned # Open a BytesIO stream to be destroyed once request has returned
with microscope.camera.lock, io.BytesIO() as stream: with microscope.camera.lock, io.BytesIO() as stream: