miscset.io.read_yaml

miscset.io.read_yaml(path)[source]

Read a YAML file.

Read a YAML formatted file into a dictionary object. Supports logging (see miscset).

Parameters

path (str) – File path.

Returns

Content of a YAML file parsed as dictionary.

Return type

dict

Example code:

import miscset
print(miscset.io.read_yaml("tests/example.yml"))

Result:

{'example_list': [1, 2, 3], 'example_string': 'hello, world!', 'example_float': 3.14, 'example_none': None}