galactic.io.data.yaml

galactic.io.data.yaml module

Defines the data reader for YAML files.

Class

• YAMLDataReader for reading .yaml or .yml files

---

class YAMLDataReader

Bases: object

YAML Data reader.

Example

>>> from pprint import pprint
>>> from galactic.io.data.yaml import YAMLDataReader
>>> reader = YAMLDataReader()
>>> import io
>>> text = '''# This is a YAML document.
... - firstname: Évariste
...   name: Galois
... - firstname: Rudolf
...   name: Wille
... '''
>>> dataset = reader.read(io.StringIO(text))
>>> pprint(dataset)
[{'firstname': 'Évariste', 'name': 'Galois'},
 {'firstname': 'Rudolf', 'name': 'Wille'}]

read(data_file)

Read a YAML data file.

Parameters:

data_file (TextIO) – A readable text file

Returns:

The dataset read from the file

Return type:

dict[str, None | bool | int | float | str | list[JSONValue] | dict[str, JSONValue]] | list[None | bool | int | float | str | list[JSONValue] | dict[str, JSONValue]]

extensions()

Return an iterator over the supported file extensions.

Returns:

An iterator over the supported file extensions

Return type:

Iterator[str]

register()

Register an instance of a YAML data reader.

Return type:

None