formatter

@author: ☙ Ryan McConnell ❧

exception grave_settings.formatter.ProcessingException(processor, obj=None, wrapped_exception=None, key_stack=None, frame_semantics=None, semantics=None)

Bases: Exception

Parameters:

• wrapped_exception (Exception) –

• frame_semantics (Semantics) –

• semantics (Semantics) –

class grave_settings.formatter.Processor(root_obj, spec, context)

Bases: object

Parameters:

• spec (FormatterSpec) –

• context (FormatterContext) –

property root_obj

set_default_semantics()

it_quack(t_obj)

Parameters:

t_obj (type) –

process(obj=None, **kwargs)

path_to_str()

dispose()

class grave_settings.formatter.IFormatter

Bases: ABC

to_buffer(data, _io, encoding='utf-8', serializer=None)

Parameters:

• _io (IOBase) –

• serializer (Processor) –

write_to_file(data, path, encoding='utf-8', serializer=None)

Parameters:

• path (str) –

• serializer (Processor) –

from_buffer(_io, encoding='utf-8', kwargs=None, deserializer=None)

Parameters:

• _io (IOBase) –

• kwargs (dict | None) –

• deserializer (Processor) –

read_from_file(path, encoding='utf-8', kwargs=None, deserializer=None)

Parameters:

• path (str) –

• kwargs (dict | None) –

• deserializer (Processor) –

abstract serialized_obj_to_buffer(ser_obj, context)

Parameters:

context (FormatterContext) –

Return type:

str | bytes

abstract buffer_to_obj(buffer, context)

Parameters:

• buffer (str | bytes) –

• context (FormatterContext) –

get_serialization_handler()

Return type:

OrderedHandler

get_deserialization_handler()

Return type:

OrderedHandler

get_serialization_frame_context()

Return type:

FrameStackContext

get_deserialization_frame_context()

Return type:

FrameStackContext

get_serialization_context()

Return type:

FormatterContext

get_deserialization_context()

Return type:

FormatterContext

dumps(obj, kwargs=None, serializer=None)

Parameters:

• obj (Any) –

• kwargs (dict | None) –

• serializer (Processor) –

Return type:

str | bytes

loads(buffer, kwargs=None, deserializer=None)

Parameters:

• kwargs (dict | None) –

• deserializer (Processor) –

abstract get_serializer(root_obj, context)

Parameters:

context (FormatterContext) –

Return type:

Processor

abstract get_deserializer(root_obj, context)

Parameters:

context (FormatterContext) –

Return type:

Processor

serialize(obj, kwargs=None, serializer=None)

Parameters:

• kwargs (dict | None) –

• serializer (Processor) –

free_deser_obj(obj)

deserialize(obj, kwargs=None, deserializer=None)

Parameters:

• kwargs (dict | None) –

• deserializer (Processor) –

class grave_settings.formatter.Serializer(root_object, spec, context)

Bases: Processor

Parameters:

• spec (FormatterSpec) –

• context (FormatterContext) –

set_default_semantics()

supports_semantic(semantic_class)

Parameters:

semantic_class (Type[Semantic]) –

Return type:

bool

check_in_object(obj)

Parameters:

obj (T) –

Return type:

PreservedReference | T

handle_serialize_list_in_place(instance, **kwargs)

Parameters:

instance (list) –

handle_serialize_dict_in_place(instance, **kwargs)

Parameters:

instance (dict) –

handle_user_list(instance, **kwargs)

Parameters:

instance (list) –

handle_user_dict(instance, **kwargs)

Parameters:

instance (dict) –

handle_add_semantics(instance, **kwargs)

Parameters:

instance (AddSemantics) –

handle_temporary(instance, **kwargs)

Parameters:

instance (Temporary) –

template_object_serialize(template_dict, instance, **kwargs)

Parameters:

template_dict (dict) –

handle_default(instance, **kwargs)

Parameters:

instance (object) –

process(obj=None, **kwargs)

serialize(obj, **kwargs)

Parameters:

obj (Any) –

dispose()

class grave_settings.formatter.DeSerializer(root_object, spec, context)

Bases: Processor

Parameters:

• spec (FormatterSpec) –

• context (FormatterContext) –

set_default_semantics()

supports_semantic(semantic_class)

Parameters:

semantic_class (Type[Semantic]) –

Return type:

bool

run_semantics_through_path(key_path)

Parameters:

key_path (list) –

Return type:

Semantics

handle_list(instance, **kwargs)

Parameters:

instance (list) –

handle_dict(instance, **kwargs)

Parameters:

instance (dict) –

handle_preserved_referece(instance, **kwargs)

Parameters:

instance (PreservedReference) –

handle_default(instance, **kwargs)

Parameters:

instance (object) –

handle_secondary_preserved_reference(instance, **kwargs)

Parameters:

instance (PreservedReference) –

cache_instance_ref(instance, **kwargs)

Parameters:

instance (object) –

process(obj=None, **kwargs)

deserialize(obj, **kwargs)

dispose()

class grave_settings.formatter.Formatter(spec=None)

Bases: IFormatter, ABC

Parameters:

spec (FormatterSpec) –

FORMAT_SETTINGS = <grave_settings.formatter_settings.FormatterSpec object>

TYPES = int | float | str | bool | None | dict | list

get_serialization_handler()

Return type:

OrderedHandler

get_deserialization_handler()

Return type:

OrderedHandler

get_serializer(root_obj, context)

Return type:

Serializer

get_deserializer(root_obj, context)

Return type:

DeSerializer

add_semantics(*semantics)

Parameters:

semantics (T_S_E) –