🔌 Application Programming Interface

TOML Data reader.

class TOMLDataReader

Bases: object

TOML Datareader.

Example

>>> from pprint import pprint
>>> from galactic.io.data.toml import TOMLDataReader
>>> reader = TOMLDataReader()
>>> import io
>>> data = '''# This is a TOML document.
... [individual1]
...     name="Galois"
...     firstname="Évariste"
... [individual2]
...     name="Wille"
...     firstname="Rudolf"
... '''
>>> individuals = reader.read(io.StringIO(data))
>>> pprint(individuals)
{'individual1': {'firstname': 'Évariste', 'name': 'Galois'},
 'individual2': {'firstname': 'Rudolf', 'name': 'Wille'}}

classmethod extensions()

Get an iterator over the supported extensions.

Returns:

An iterator over the supported extensions

Return type:

Iterator[str]

classmethod read(data_file)

Read a TOML data file.

Parameters:

data_file (TextIO) – A readable text file.

Returns:

The data.

Return type:

Mapping[str, object]

register()

Register an instance of a TOML data reader.

Return type:

None