TOMLConfiguration

class backpy.core.config.TOMLConfiguration(path, create_if_not_exists=False, none_if_unknown_key=False)

Bases: object

Methods Summary

as_dict()
create([create_parents])
dump_dict(content)
get_keys([non_dict_only])
get_path()
is_valid()
prepend_comments(comments[, linebreak])
prepend_no_edit_warning()

Methods Documentation

Parameters:

• path (str | Path)

• create_if_not_exists (bool)

• none_if_unknown_key (bool)

as_dict()

Return type:

dict

create(create_parents=True)

Parameters:

create_parents (bool)

Return type:

None

dump_dict(content)

Parameters:

content (dict)

Return type:

None

get_keys(non_dict_only=False)

Parameters:

non_dict_only (bool)

get_path()

Return type:

Path

is_valid()

Return type:

bool

prepend_comments(comments, linebreak=True)

Parameters:

• comments (list[str] | str)

• linebreak (bool)

Return type:

None

prepend_no_edit_warning()