From c2d27e8f565a471dfe00e3c6365f640ebd889eab Mon Sep 17 00:00:00 2001 From: jtc42 Date: Tue, 19 Nov 2019 22:31:57 +0000 Subject: [PATCH] Added a description field using docstrings --- openflexure_microscope/api/v2/blueprints/plugins.py | 4 +++- openflexure_microscope/plugins/default/autofocus/api.py | 6 ++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/openflexure_microscope/api/v2/blueprints/plugins.py b/openflexure_microscope/api/v2/blueprints/plugins.py index 490619bf..d15c7376 100644 --- a/openflexure_microscope/api/v2/blueprints/plugins.py +++ b/openflexure_microscope/api/v2/blueprints/plugins.py @@ -28,13 +28,15 @@ def plugins_representation(plugin_loader_object: PluginLoader): "plugin": str(plugin), "views": {}, "form": plugin.form, + "description": plugin.__doc__.strip() if plugin.__doc__ else "" } - for view_id, view in plugin.views.items(): + for view_id, view_data in plugin.views.items(): logging.debug(f"Representing view {view_id}") uri = url_for(f"v2_plugins_blueprint.{view_id}") # Make links dictionary if it doesn't yet exist view_d = { + "description": view_data["view"].__doc__.strip() if view_data["view"].__doc__ else "", "links": {"self": uri} } diff --git a/openflexure_microscope/plugins/default/autofocus/api.py b/openflexure_microscope/plugins/default/autofocus/api.py index 0e7ed816..ee28abb1 100644 --- a/openflexure_microscope/plugins/default/autofocus/api.py +++ b/openflexure_microscope/plugins/default/autofocus/api.py @@ -18,6 +18,9 @@ class MeasureSharpnessAPI(MicroscopeViewPlugin): class AutofocusAPI(MicroscopeViewPlugin): + """ + Run a standard autofocus + """ def post(self): payload = JsonResponse(request) @@ -36,6 +39,9 @@ class AutofocusAPI(MicroscopeViewPlugin): class FastAutofocusAPI(MicroscopeViewPlugin): + """ + Run a fast autofocus + """ def post(self): payload = JsonResponse(request)