config_file

@author: ☙ Ryan McConnell ❧

class grave_settings.config_file.PassLogFilePath(value)

Bases: Semantic[str]

Parameters:

value (T) –

val

class grave_settings.config_file.LogFileLink(config=None, file_path=None, rel_path=None)

Bases: Serializable

to_dict(context, **kwargs)

Parameters:

context (FormatterContext) –

Return type:

dict

from_dict(state_obj, context, **kwargs)

Parameters:

• state_obj (dict) –

• context (FormatterContext) –

class grave_settings.config_file.ConfigFile(file_path, data=None, formatter=None, auto_save=False, read_only=False)

Bases: Serializable

Parameters:

• file_path (Path) –

• data (IASettings | Any | Type | None) –

• formatter (None | Formatter | str) –

FORMATTER_STR_DICT = {'json': <grave_settings.formatters.json.JsonFormatter object>, 'toml': <grave_settings.formatters.toml.TomlFormatter object>}

add_config_dependency(other, relative_path=True)

Parameters:

other (ConfigFile) –

add_log_file_link(link)

Parameters:

link (LogFileLink) –

is_loaded()

backup_settings_file()

settings_invalidated()

validate_file_path(path, must_exist=False)

Parameters:

path (Path) –

save(path=None, formatter=None, force=True, validate_path=True)

Parameters:

• path (Path) –

• formatter (None | Formatter) –

classmethod check_in_serialization_context(context)

This method typically is called on an instantiated object, so it may not be necessary for it to be a class method.

Parameters:

context (FormatterContext) –

get_serialization_context()

handle_serialize_IASettings(serializer, obj, **kwargs)

Parameters:

• serializer (Serializer) –

• obj (IASettings) –

load(path=None, formatter=None, validate_path=True, semantics=None)

Parameters:

• path (Path) –

• formatter (None | Formatter) –

• semantics (Semantics) –

classmethod check_in_deserialization_context(context)

This method is typically called on type objects, so it should remain a class method in sub-classes. This is where you can put a reference to NotifyFinalizedMethodName to get a callback

Parameters:

context (FormatterContext) –

get_deserialization_context()

handle_deserialize_LogFileLink(deserializer, obj, **kwargs)

Parameters:

• deserializer (DeSerializer) –

• obj (LogFileLink) –

instantiate_data()

get_load_data_obj()

to_dict(*args)

from_dict(state_obj, *args)

Parameters:

state_obj (dict) –

classmethod handle_me(ser_type, state_obj, *args, **kwargs)

Parameters:

• ser_type (Type[Self]) –

• state_obj (dict) –