aboutsummaryrefslogtreecommitdiffstats
path: root/config_file/yaml_parser.py
blob: 938b0d7f3eabb0fa872e207892a3e1a36d9daa29 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
try:
    from ruamel.yaml import YAML, YAMLError, round_trip_dump, round_trip_load

    YAML_AVAILABLE = True
except ImportError:
    YAML_AVAILABLE = False

from .base_parser import BaseParser


class YamlParser(BaseParser):
    def __init__(self, file_contents: str):
        if not YAML_AVAILABLE:
            raise ImportError(
                "It doesn't appear `ruamel.yaml` is installed, but a yaml "
                "file was attempted to be used. Install the `yaml` "
                "extra first with `pip install config-file[yaml]`."
            )

        yaml = YAML(typ="safe")
        yaml.loads = round_trip_load
        yaml.dumps = round_trip_dump

        super().__init__(
            file_contents=file_contents, module=yaml, decode_error=YAMLError
        )