sampo.utilities.serializers#

Overview#

Function#

custom_serializer(type_or_field, deserializer)

Meta-decorator for marking custom serializers or deserializers methods.<br/>

custom_field_serializer(field_name)

-

custom_field_deserializer(field_name)

-

custom_type_serializer(__type)

-

custom_type_deserializer(__type)

-

_decorate_serializer(func, collection_name, new_element)

-

default_ndarray_serializer(array)

-

default_ndarray_deserializer(__list)

-

default_dataframe_serializer(df)

-

default_dataframe_deserializer(str_repr)

-

default_np_int_serializer(n)

-

default_np_int_deserializer(n)

-

default_np_long_serializer(n)

-

default_np_long_deserializer(n)

-

Functions#

sampo.utilities.serializers.custom_serializer(type_or_field: type | str, deserializer: bool = False)#

Meta-decorator for marking custom serializers or deserializers methods.<br/> This decorator can stack with other serializer/deserializer decorators. :param type_or_field: Name (str) of field or type (type) of fields, which will be serialized with this serializer in current class. If type should be presented in str representation, consider using custom_type_serializer or custom_type_deserializer decorators. :param deserializer: If True, the decorated function will be considered as a custom deserializer for type_or_field type or field<br/> If None, deserializer should be decorated separately with custom_serializer or custom_field_deserializer or custom_type_deserializer decorator :return:

sampo.utilities.serializers.custom_field_serializer(field_name: str)#
sampo.utilities.serializers.custom_field_deserializer(field_name: str)#
sampo.utilities.serializers.custom_type_serializer(__type: type or str)#
sampo.utilities.serializers.custom_type_deserializer(__type: type or str)#
sampo.utilities.serializers._decorate_serializer(func, collection_name, new_element)#
sampo.utilities.serializers.default_ndarray_serializer(array: numpy.ndarray)#
sampo.utilities.serializers.default_ndarray_deserializer(__list: list)#
sampo.utilities.serializers.default_dataframe_serializer(df: pandas.DataFrame)#
sampo.utilities.serializers.default_dataframe_deserializer(str_repr: str)#
sampo.utilities.serializers.default_np_int_serializer(n)#
sampo.utilities.serializers.default_np_int_deserializer(n)#
sampo.utilities.serializers.default_np_long_serializer(n)#
sampo.utilities.serializers.default_np_long_deserializer(n)#

Attributes#

sampo.utilities.serializers.CUSTOM_FIELD_SERIALIZER = '_serializer_for_fields'#
sampo.utilities.serializers.CUSTOM_FIELD_DESERIALIZER = '_deserializer_for_fields'#
sampo.utilities.serializers.CUSTOM_TYPE_SERIALIZER = '_serializer_for_types'#
sampo.utilities.serializers.CUSTOM_TYPE_DESERIALIZER = '_deserializer_for_types'#