Config Reader

cihai._internal.config_reader.ConfigReader loads and dumps raw YAML or JSON configuration data before the public configuration layer expands it. This is an internal API with no compatibility guarantee.

exception cihai._internal.config_reader.ConfigfmtNotImplementedError
exception[source]
exception[source]
exception cihai._internal.config_reader.ConfigfmtNotImplementedError

Bases: NotImplementedError

__init__(fmt)
method[source]
method[source]
__init__(fmt)
Parameters:

fmt (str)

Return type:

None

exception cihai._internal.config_reader.ConfigExtensionNotImplementedError
exception[source]
exception[source]
exception cihai._internal.config_reader.ConfigExtensionNotImplementedError

Bases: NotImplementedError

__init__(ext, path)
method[source]
method[source]
__init__(ext, path)
Parameters:
Return type:

None

class cihai._internal.config_reader.ConfigReader
class[source]
class[source]
class cihai._internal.config_reader.ConfigReader

Bases: object

Parse string data (YAML and JSON) into a dictionary.

>>> cfg = ConfigReader({ "session_name": "my session" })
>>> cfg.dump("yaml")
'session_name: my session\n'
>>> cfg.dump("json")
'{\n  "session_name": "my session"\n}'
__init__(content)
method[source]
method[source]
__init__(content)
Parameters:

content (dict[Any, Any])

Return type:

None

static _load(fmt, content)
staticmethod method[source]
staticmethod method[source]
static _load(fmt, content)

Load raw config data and directly return it.

>>> ConfigReader._load("json", '{ "session_name": "my session" }')
{'session_name': 'my session'}

>>> ConfigReader._load("yaml", 'session_name: my session')
{'session_name': 'my session'}
Parameters:
Return type:

dict[str, Any]

classmethod load(fmt, content)
classmethod method[source]
classmethod method[source]
classmethod load(fmt, content)

Load raw config data into a ConfigReader instance (to dump later).

>>> cfg = ConfigReader.load("json", '{ "session_name": "my session" }')
>>> cfg
<cihai._internal.config_reader.ConfigReader object at ...>
>>> cfg.content
{'session_name': 'my session'}

>>> cfg = ConfigReader.load("yaml", 'session_name: my session')
>>> cfg
<cihai._internal.config_reader.ConfigReader object at ...>
>>> cfg.content
{'session_name': 'my session'}
Parameters:
Return type:

ConfigReader

classmethod _from_file(path)
classmethod method[source]
classmethod method[source]
classmethod _from_file(path)

Load data from file path directly to dictionary.

YAML file

For demonstration only, create a YAML file:

>>> yaml_file = tmp_path / 'my_config.yaml'
>>> yaml_file.write_text('session_name: my session', encoding='utf-8')
24

Read YAML file:

>>> ConfigReader._from_file(yaml_file)
{'session_name': 'my session'}

JSON file

For demonstration only, create a JSON file:

>>> json_file = tmp_path / 'my_config.json'
>>> json_file.write_text('{"session_name": "my session"}', encoding='utf-8')
30

Read JSON file:

>>> ConfigReader._from_file(json_file)
{'session_name': 'my session'}
Parameters:

path (Path)

Return type:

dict[str, Any]

classmethod from_file(path)
classmethod method[source]
classmethod method[source]
classmethod from_file(path)

Load data from file path.

YAML file

For demonstration only, create a YAML file:

>>> yaml_file = tmp_path / 'my_config.yaml'
>>> yaml_file.write_text('session_name: my session', encoding='utf-8')
24

Read YAML file:

>>> cfg = ConfigReader.from_file(yaml_file)
>>> cfg
<cihai._internal.config_reader.ConfigReader object at ...>

>>> cfg.content
{'session_name': 'my session'}

JSON file

For demonstration only, create a JSON file:

>>> json_file = tmp_path / 'my_config.json'
>>> json_file.write_text('{"session_name": "my session"}', encoding='utf-8')
30

Read JSON file:

>>> cfg = ConfigReader.from_file(json_file)
>>> cfg
<cihai._internal.config_reader.ConfigReader object at ...>

>>> cfg.content
{'session_name': 'my session'}
Parameters:

path (Path)

Return type:

ConfigReader

static _dump(fmt, content, indent=2, **kwargs)
staticmethod method[source]
staticmethod method[source]
static _dump(fmt, content, indent=2, **kwargs)

Dump directly.

>>> ConfigReader._dump("yaml", { "session_name": "my session" })
'session_name: my session\n'

>>> ConfigReader._dump("json", { "session_name": "my session" })
'{\n  "session_name": "my session"\n}'
Parameters:
Return type:

str

dump(fmt, indent=2, **kwargs)
method[source]
method[source]
dump(fmt, indent=2, **kwargs)

Dump via ConfigReader instance.

>>> cfg = ConfigReader({ "session_name": "my session" })
>>> cfg.dump("yaml")
'session_name: my session\n'
>>> cfg.dump("json")
'{\n  "session_name": "my session"\n}'
Parameters:
Return type:

str