🔌 Application Programming Interface

YAML Data reader.

class YAMLDataReader

Bases: object

YAML Data reader.

Example

>>> from pprint import pprint
>>> from galactic.io.data.yaml import YAMLDataReader
>>> reader = YAMLDataReader()
>>> import io
>>> data = '''# This is a YAML document.
... - firstname: Évariste
...   name: Galois
... - firstname: Rudolf
...   name: Wille
... '''
>>> individuals = reader.read(io.StringIO(data))
>>> pprint(individuals)
{'0': frozendict.frozendict({'firstname': 'Évariste', 'name': 'Galois'}),
 '1': frozendict.frozendict({'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 YAML data file.

Parameters:

data_file (TextIO) – A readable text file.

Returns:

The data.

Return type:

dict[str, Value]

register()

Register an instance of a YAML data reader.

Return type:

None