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

Start explicit metadata argument for marshmallow

Browse source 
A side effect of re-locking dependencies is having a newer marshmallow.
This deprecates having `description=` as a keyword, and puts it in a
separate metadata arg instead.

This commit is the start of my search-and-replaceing to update to the new
format.
This commit is contained in:
Richard Bowman 2022-08-09 12:52:57 +01:00
parent 78ef9c531b
commit e22f36b308
14 changed files with 58 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

32
openflexure_microscope/api/default_extensions/autofocus.py
View file

@ -349,7 +349,7 @@ class AutofocusExtension(BaseExtension):
args={
"dz": fields.List(
fields.Int(),
description="An ascending list of relative z positions",
metadata={"description": "An ascending list of relative z positions"},
example=[int(x) for x in np.linspace(-300, 300, 7)],
)
}
@ -410,7 +410,7 @@ class AutofocusExtension(BaseExtension):
@extension_action(
args={
"dz": fields.Int(required=True, description="The relative Z move to make")
"dz": fields.Int(required=True, metadata={"description": "The relative Z move to make"})
}
)
def move_and_measure(
@ -432,9 +432,9 @@ class AutofocusExtension(BaseExtension):
@extension_action(
args={
"dz": fields.Int(
missing=2000,
load_default=2000,
example=2000,
description="Total Z range to search over (in stage steps)",
metadata={"description": "Total Z range to search over (in stage steps)"},
)
}
)
@ -528,14 +528,14 @@ class AutofocusExtension(BaseExtension):
@extension_action(
args={
"dz": fields.Int(
missing=500,
load_default=500,
example=500,
description="Total Z range to move down, then up (in stage steps)",
metadata={"description": "Total Z range to move down, then up (in stage steps)"},
),
"delay": fields.Int(
missing=5,
load_default=5,
example=5,
description="How long to measure sharpness for after the move",
metadata={"description": "How long to measure sharpness for after the move"},
),
}
)
@ -556,23 +556,23 @@ class AutofocusExtension(BaseExtension):
@extension_action(
args={
"dz": fields.Int(
missing=2000,
load_default=2000,
example=2000,
description="Total Z range to search over (in stage steps)",
metadata={"description": "Total Z range to search over (in stage steps)"},
),
"target_z": fields.Int(
missing=0,
load_default=0,
example=-100,
description="Target finishing position, relative to the focus.",
metadata={"description": "Target finishing position, relative to the focus."},
),
"initial_move_up": fields.Bool(
missing=True,
description="Set to Flase to disable the initial move upwards",
load_default=True,
metadata={"description": "Set to Flase to disable the initial move upwards"},
),
"backlash": fields.Int(
missing=25,
load_default=25,
minimum=0,
description="Distance to undershoot, before correction move.",
metadata={"description": "Distance to undershoot, before correction move."},
),
}
)