stouputils.typing module#

This module provides utilities for typing enhancements such as JSON type aliases:

JsonDict
JsonList
JsonMap
JsonMutMap
IterAny
convert_to_serializable()

type JsonDict = dict[str, Any]#: A type alias for JSON dictionaries

type JsonList = list[Any]#: A type alias for JSON lists

type JsonMap = Mapping[str, Any]#: A type alias for JSON mapping

type JsonMutMap = MutableMapping[str, Any]#: A type alias for mutable JSON mapping

type IterAny = Iterable[Any]#: A type alias for iterable of any type

type CallableAny = Callable[[...], Any]#: A type alias for any callable

convert_to_serializable(obj: Any) → Any[source]#

Recursively convert objects to JSON-serializable forms.

Objects with a to_dict() or asdict() method are converted to their dictionary representation. Dictionaries and lists are recursively processed.

Can also be used to convert nested structures containing custom objects, such as defaultdict, dataclasses, or other user-defined types.

Parameters:: obj (Any) – The object to convert
Returns:: The JSON-serializable version of the object
Return type:: Any

Examples

>>> from typing import defaultdict
>>> my_dict = defaultdict(lambda: defaultdict(int))
>>> my_dict['a']['b'] += 6
>>> my_dict['c']['d'] = 4
>>> my_dict['a']
defaultdict(<class 'int'>, {'b': 6})
>>> my_dict['c']
defaultdict(<class 'int'>, {'d': 4})
>>> convert_to_serializable(my_dict)
{'a': {'b': 6}, 'c': {'d': 4}}

>>> from dataclasses import dataclass
>>> @dataclass
... class Point:
...     x: int
...     y: int
>>> convert_to_serializable(Point(3, 4))
{'x': 3, 'y': 4}