🔌 Application Programming Interface

🔌 Application Programming Interface#

galactic.io.data.toml module

Class

class TOMLDataReader#

Bases: object

TOML Datareader.

Example

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

Get an iterator over the supported extensions.

Returns:

An iterator over the supported extensions

Return type:

Iterator[str]

read(data_file)#

Read a TOML data file.

Parameters:

data_file (TextIO) – A readable text file.

Returns:

The data.

Return type:

Data

register()#

Register an instance of a TOML data reader.

Return type:

None

Contents