dom_toml

Source code: dom_toml/__init__.py

---

Dom’s tools for Tom’s Obvious, Minimal Language.

Functions:

dump(data, filename[, encoder])	Writes out data as TOML to the given file.
dumps(data[, encoder])	Convert data to a TOML string.
load(filename[, decoder])	Parse TOML from the given file.
loads(s[, decoder])	Parse the given string as TOML.

dump(data, filename, encoder=<class 'TomlEncoder'>)

Writes out data as TOML to the given file.

Parameters

• data (Mapping[str, Any])

• filename (Union[str, Path, PathLike]) – The filename to write to.

• encoder (Union[Type[TomlEncoder], TomlEncoder]) – The TomlEncoder to use for constructing the output string. Default dom_toml.encoder.TomlEncoder.

Return type

str

Returns

A string containing the TOML corresponding to data.

Changed in version 2.0.0: encoder must now be a TomlEncoder type or instance.

dumps(data, encoder=<class 'TomlEncoder'>)

Convert data to a TOML string.

Parameters

• data (Mapping[str, Any])

• encoder (Union[Type[TomlEncoder], TomlEncoder]) – The TomlEncoder to use for constructing the output string. Default dom_toml.encoder.TomlEncoder.

Return type

str

Returns

A string containing the TOML corresponding to data.

Changed in version 2.0.0: encoder must now be a TomlEncoder type or instance.

load(filename, decoder=<class 'TomlDecoder'>)

Parse TOML from the given file.

Parameters

• filename (Union[str, Path, PathLike]) – The filename to read from to.

• decoder (Union[Type[TomlDecoder], TomlDecoder]) – The TomlEncoder to use for constructing the output string. Default dom_toml.decoder.TomlDecoder.

Return type

Dict[str, Any]

Returns

A mapping containing the TOML data.

Changed in version 2.0.0: decoder must now be a TomlDecoder type or instance.

loads(s, decoder=<class 'TomlDecoder'>)

Parse the given string as TOML.

Parameters

• s (str)

• decoder (Union[Type[TomlDecoder], TomlDecoder]) – The TomlEncoder to use for constructing the output string. Default dom_toml.decoder.TomlDecoder.

Return type

Dict[str, Any]

Returns

A mapping containing the TOML data.

Changed in version 2.0.0: decoder must now be a TomlDecoder type or instance.