🔌 Application Programming Interface

🔌 Application Programming Interface#

galactic.io.data.ini module

Class

class INIDataReader#

Bases: object

INI Data reader.

Example

>>> from pprint import pprint
>>> from galactic.io.data.ini import INIDataReader
>>> reader = INIDataReader()
>>> import io
>>> text = '''
... [#1]
... firstname=Évariste
... name=Galois
... [#2]
... firstname=Rudolf
... name=Wille
... '''
>>> data = reader.read(io.StringIO(text))
>>> pprint(data)
{'#1': frozendict.frozendict({'firstname': 'Évariste', 'name': 'Galois'}),
 '#2': 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 INI data file.

Parameters:

data_file (TextIO) – A readable text file.

Returns:

The data.

Return type:

Data

register()#

Register an instance of a INI data reader.

Return type:

None

Contents