Refactored JsonPayload to JsonResponse

from openflexure_microscope.plugins import MicroscopePlugin

from openflexure_microscope.api.v1.views import MicroscopeViewPlugin

from openflexure_microscope.api.utilities import JsonPayload

from openflexure_microscope.api.utilities import JsonResponse

import os

import time

        Assumes request will include a JSON payload.

        """

        # Get payload JSON

        payload = JsonPayload(request)

        payload = JsonResponse(request)

        # Extract a value from the JSON key 'plugin_string', and convert to a string. If no value is given, default to empty.

        new_plugin_string = payload.param('plugin_string', default='', convert=str)

    def post(self):

        # Get any JSON data in the body of the POST request

        payload = JsonPayload(request)

        payload = JsonResponse(request)

        # Extract the "n_images" parameter if it was passed. Otherwise, default to 10.

        n_images = payload.param('n_images', default=10, convert=int)

    from openflexure_microscope.plugins import MicroscopePlugin

    from openflexure_microscope.exceptions import TaskDeniedException

    from openflexure_microscope.api.v1.views import MicroscopeViewPlugin

    from openflexure_microscope.api.utilities import JsonPayload

    from openflexure_microscope.api.utilities import JsonResponse

    ### MICROSCOPE PLUGIN ###

Parsing JSON from HTTP POST requests

------------------------------------

To ease obtaining values from a JSON payload attached to an HTTP POST request, you can use the :py:class:`openflexure_microscope.api.utilities.JsonPayload` class. This allows parameters to be extracted by their key, with a default value supplied to avoid errors associated with nonexistent keys. Additionally, a converter function may be passed, used in the following examples to convert the type of a value. In principle, however, you can pass any single-argument function and it will apply that function to the value, if it exists.

To ease obtaining values from a JSON payload attached to an HTTP POST request, you can use the :py:class:`openflexure_microscope.api.utilities.JsonResponse` class. This allows parameters to be extracted by their key, with a default value supplied to avoid errors associated with nonexistent keys. Additionally, a converter function may be passed, used in the following examples to convert the type of a value. In principle, however, you can pass any single-argument function and it will apply that function to the value, if it exists.

.. code-block:: python

        def post(self):

            # Get payload JSON from request

            payload = JsonPayload(request)

            payload = JsonResponse(request)

            # Try to find value associated with 'my_string' key.

            # If that key doesn't exist in the payload, return '' instead.

            new_plugin_string = payload.param('my_string', default='', convert=str)

            ...

.. autoclass:: openflexure_microscope.api.utilities.JsonPayload

.. autoclass:: openflexure_microscope.api.utilities.JsonResponse

    :members:

from flask import url_for

class JsonPayload:

class JsonResponse:

    def __init__(self, request):

        """

        Object to wrap up simple functionality for parsing a JSON response.

from openflexure_microscope.api.utilities import gen, JsonPayload

from openflexure_microscope.api.utilities import gen, JsonResponse

from openflexure_microscope.api.v1.views import MicroscopeView

from flask import Response, Blueprint, jsonify, request

        :status 200: capture created

        """

        payload = JsonPayload(request)

        payload = JsonResponse(request)

        logging.debug("Updating settings from POST request:")

        logging.debug(payload.json)