Skip to content

JSON

hololinked.serializers.json.JSONSerializer

Bases: BaseSerializer

Serializer that wraps the msgspec JSON serialization protocol, default serializer for this package.

Source code in repo/hololinked/hololinked/serializers/json.py 
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
class JSONSerializer(BaseSerializer):
    """Serializer that wraps the msgspec JSON serialization protocol, default serializer for this package."""

    _type_replacements = {}

    def __init__(self) -> None:
        super().__init__()
        self.type = msgspecjson

    def loads(self, data: bytearray | memoryview | bytes) -> JSONSerializable:
        return msgspecjson.decode(self.convert_to_bytes(data))

    def dumps(self, data: Any) -> bytes:
        return msgspecjson.encode(data, enc_hook=self.default)

    @classmethod
    def default(cls, obj: Any) -> JSONSerializable:
        """
        Method called if object is not serializable by default JSON encoder.

        To override, one can subclass and implement default method and call `super().default()` at the very end.
        Or one can directly register a type with `register_type_replacement()`.

        Parameters
        ----------
        obj: Any
            the object to be serialized

        Returns
        -------
        JSONSerializable
            a JSON serializable representation of the object, not bytes.

        Raises
        ------
        TypeError
            if the object cannot be serialized to JSON
        """
        if hasattr(obj, "model_dump"):
            return obj.model_dump()
        if hasattr(obj, "json"):
            # alternative to type replacement
            return obj.json()
        if isinstance(obj, Struct):
            return obj
        if isinstance(obj, Enum):
            return obj.name
        if isinstance(obj, (set, dict_keys, deque, tuple)):
            # json module can't deal with sets so we make a tuple out of it
            return list(obj)
        if isinstance(obj, (TypeConstrainedDict, TypeConstrainedList, TypedKeyMappingsConstrainedDict)):
            return obj._inner  # copy has been implemented with same signature for both types
        if isinstance(obj, uuid.UUID):
            return str(obj)
        if isinstance(obj, (datetime.datetime, datetime.date)):
            return obj.isoformat()
        if isinstance(obj, decimal.Decimal):
            return str(obj)
        if isinstance(obj, Exception):
            return format_exception_as_json(obj)
        if isinstance(obj, array.array):
            if obj.typecode == "c":
                return obj.tostring()
            if obj.typecode == "u":
                return obj.tounicode()
            return obj.tolist()
        if "numpy" in globals() and isinstance(obj, numpy.ndarray):
            return obj.tolist()
        replacer = cls._type_replacements.get(type(obj), None)
        if replacer:
            return replacer(obj)
        raise TypeError("Given type cannot be converted to JSON : {}".format(type(obj)))

    @classmethod
    def register_type_replacement(cls, object_type, replacement_function) -> None:
        """
        Register custom serialization function for a particular type.

        Parameters
        ----------
        object_type: type
            the type for which the replacement function is registered
        replacement_function: Function
            the function that takes an object of the given type and returns a JSON serializable representation of
            the object. `bytes` are not expected, only the JSON serializable representation.

        Raises
        ------
        ValueError
            if the object_type is not a type or is the type 'type' itself
        """
        if object_type is type or not inspect.isclass(object_type):
            raise ValueError("refusing to register replacement for a non-type or the type 'type' itself")
        cls._type_replacements[object_type] = replacement_function

    @property
    def content_type(self) -> str:
        return "application/json"

Attributes

type instance-attribute 

type = json

content_type property 

content_type: str

Functions

__init__ 

__init__() -> None
Source code in repo/hololinked/hololinked/serializers/json.py 
42
43
44
def __init__(self) -> None:
    super().__init__()
    self.type = msgspecjson

dumps 

dumps(data: Any) -> bytes
Source code in repo/hololinked/hololinked/serializers/json.py 
49
50
def dumps(self, data: Any) -> bytes:
    return msgspecjson.encode(data, enc_hook=self.default)

loads 

loads(data: bytearray | memoryview | bytes) -> JSONSerializable
Source code in repo/hololinked/hololinked/serializers/json.py 
46
47
def loads(self, data: bytearray | memoryview | bytes) -> JSONSerializable:
    return msgspecjson.decode(self.convert_to_bytes(data))

default classmethod 

default(obj: Any) -> JSONSerializable

Method called if object is not serializable by default JSON encoder.

To override, one can subclass and implement default method and call super().default() at the very end. Or one can directly register a type with register_type_replacement().

Parameters:

Name Type Description Default
obj
Any

the object to be serialized

 required

Returns:

Type Description
JSONSerializable

a JSON serializable representation of the object, not bytes.

Raises:

Type Description
TypeError

if the object cannot be serialized to JSON
Source code in repo/hololinked/hololinked/serializers/json.py 
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
@classmethod
def default(cls, obj: Any) -> JSONSerializable:
    """
    Method called if object is not serializable by default JSON encoder.

    To override, one can subclass and implement default method and call `super().default()` at the very end.
    Or one can directly register a type with `register_type_replacement()`.

    Parameters
    ----------
    obj: Any
        the object to be serialized

    Returns
    -------
    JSONSerializable
        a JSON serializable representation of the object, not bytes.

    Raises
    ------
    TypeError
        if the object cannot be serialized to JSON
    """
    if hasattr(obj, "model_dump"):
        return obj.model_dump()
    if hasattr(obj, "json"):
        # alternative to type replacement
        return obj.json()
    if isinstance(obj, Struct):
        return obj
    if isinstance(obj, Enum):
        return obj.name
    if isinstance(obj, (set, dict_keys, deque, tuple)):
        # json module can't deal with sets so we make a tuple out of it
        return list(obj)
    if isinstance(obj, (TypeConstrainedDict, TypeConstrainedList, TypedKeyMappingsConstrainedDict)):
        return obj._inner  # copy has been implemented with same signature for both types
    if isinstance(obj, uuid.UUID):
        return str(obj)
    if isinstance(obj, (datetime.datetime, datetime.date)):
        return obj.isoformat()
    if isinstance(obj, decimal.Decimal):
        return str(obj)
    if isinstance(obj, Exception):
        return format_exception_as_json(obj)
    if isinstance(obj, array.array):
        if obj.typecode == "c":
            return obj.tostring()
        if obj.typecode == "u":
            return obj.tounicode()
        return obj.tolist()
    if "numpy" in globals() and isinstance(obj, numpy.ndarray):
        return obj.tolist()
    replacer = cls._type_replacements.get(type(obj), None)
    if replacer:
        return replacer(obj)
    raise TypeError("Given type cannot be converted to JSON : {}".format(type(obj)))

register_type_replacement classmethod 

register_type_replacement(object_type, replacement_function) -> None

Register custom serialization function for a particular type.

Parameters:

Name Type Description Default
object_type

the type for which the replacement function is registered

 required
replacement_function

the function that takes an object of the given type and returns a JSON serializable representation of the object. bytes are not expected, only the JSON serializable representation.

 required

Raises:

Type Description
ValueError

if the object_type is not a type or is the type 'type' itself
Source code in repo/hololinked/hololinked/serializers/json.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@classmethod
def register_type_replacement(cls, object_type, replacement_function) -> None:
    """
    Register custom serialization function for a particular type.

    Parameters
    ----------
    object_type: type
        the type for which the replacement function is registered
    replacement_function: Function
        the function that takes an object of the given type and returns a JSON serializable representation of
        the object. `bytes` are not expected, only the JSON serializable representation.

    Raises
    ------
    ValueError
        if the object_type is not a type or is the type 'type' itself
    """
    if object_type is type or not inspect.isclass(object_type):
        raise ValueError("refusing to register replacement for a non-type or the type 'type' itself")
    cls._type_replacements[object_type] = replacement_function

hololinked.serializers.json.PythonBuiltinJSONSerializer

Bases: JSONSerializer

Serializer that wraps the python builtin JSON serializer.

Source code in repo/hololinked/hololinked/serializers/json.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
class PythonBuiltinJSONSerializer(JSONSerializer):
    """Serializer that wraps the python builtin JSON serializer."""

    def __init__(self) -> None:
        super().__init__()
        self.type = pythonjson

    def loads(self, data: bytearray | memoryview | bytes) -> Any:
        return pythonjson.loads(self.convert_to_bytes(data))

    def dumps(self, data: Any) -> bytes:
        data = pythonjson.dumps(data, ensure_ascii=False, allow_nan=True, default=self.default)
        return data.encode("utf-8")

    @classmethod
    def dump(cls, data: dict[str, Any], file_desc) -> None:
        """Write JSON to file."""
        pythonjson.dump(data, file_desc, ensure_ascii=False, allow_nan=True, default=cls.default)

    @classmethod
    def load(cls, file_desc) -> Any:
        """
        Load JSON from file.

        Returns
        -------
        Any
            the deserialized JSON object
        """
        return pythonjson.load(file_desc)

Attributes

type instance-attribute 

type = json

Functions

__init__ 

__init__() -> None
Source code in repo/hololinked/hololinked/serializers/json.py 
140
141
142
def __init__(self) -> None:
    super().__init__()
    self.type = pythonjson

dumps 

dumps(data: Any) -> bytes
Source code in repo/hololinked/hololinked/serializers/json.py 
147
148
149
def dumps(self, data: Any) -> bytes:
    data = pythonjson.dumps(data, ensure_ascii=False, allow_nan=True, default=self.default)
    return data.encode("utf-8")

loads 

loads(data: bytearray | memoryview | bytes) -> Any
Source code in repo/hololinked/hololinked/serializers/json.py 
144
145
def loads(self, data: bytearray | memoryview | bytes) -> Any:
    return pythonjson.loads(self.convert_to_bytes(data))

dump classmethod 

dump(data: dict[str, Any], file_desc) -> None

Write JSON to file.

Source code in repo/hololinked/hololinked/serializers/json.py 
151
152
153
154
@classmethod
def dump(cls, data: dict[str, Any], file_desc) -> None:
    """Write JSON to file."""
    pythonjson.dump(data, file_desc, ensure_ascii=False, allow_nan=True, default=cls.default)

load classmethod 

load(file_desc) -> Any

Load JSON from file.

Returns:

Type Description
Any

the deserialized JSON object
Source code in repo/hololinked/hololinked/serializers/json.py 
156
157
158
159
160
161
162
163
164
165
166
@classmethod
def load(cls, file_desc) -> Any:
    """
    Load JSON from file.

    Returns
    -------
    Any
        the deserialized JSON object
    """
    return pythonjson.load(file_desc)