Source code for fprime_gds.flask.json

####
# json.py:
#
# Encodes GDS objects as JSON.
####
import collections
import enum

import flask.json


[docs]class GDSJsonEncoder(flask.json.JSONEncoder):
    """
    Custom class used to handle GDS object to JSON
    """

[docs]    def default(self, obj):
        """
        Override the default JSON encoder to pull out a dictionary for our handled types for encoding with the default
        encoder built into flask

        :param obj: obj to encode
        :return: JSON
        """
        # Object may already define a method for this, if so call it
        if hasattr(obj, "to_jsonable"):
            return obj.to_jsonable()
        # Dictionaries are "iterable", must handle them first
        elif isinstance(obj, collections.Mapping):
            return flask.json.JSONEncoder.default(self, obj)
        # Enumerations, just return the list of values
        elif isinstance(obj, enum.Enum):
            enum_dict = {"value": str(obj), "values": {}}
            for enum_val in type(obj):
                enum_dict["values"][str(enum_val)] = enum_val.value
            return enum_dict
        # Lists and iterables
        try:
            return list(iter(obj))
        except TypeError:
            pass
        return flask.json.JSONEncoder.default(self, obj)