aboutsummaryrefslogtreecommitdiffstats
path: root/config_file/ini_parser_compat.py
blob: 9dfea2e0ca4173c5c849665d6f892ac4572a116a (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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
import configparser
from io import StringIO


class IniParserCompatibility:
    """
    Provides compatibility with the json, yaml,
    and toml API so we can use the BaseParser
    easily, while still being able to leverage
    the built-in configparser to parse the file.

    It is used as the `module` parameter
    for BaseParser, which requires us to have a
    `dumps` and `loads` method.
    """

    @staticmethod
    def loads(file_contents: str) -> dict:
        parser = configparser.ConfigParser()
        parser.read_string(file_contents)

        return IniParserCompatibility.__create_configparser_dict(parser)

    @staticmethod
    def dumps(file_contents: dict) -> str:
        parser = configparser.ConfigParser()
        buffer = StringIO()

        parser.read_dict(file_contents)
        parser.write(buffer)

        return buffer.getvalue()

    @staticmethod
    def __create_configparser_dict(parser: configparser.ConfigParser) -> dict:
        result = {}
        items = dict(parser.items())

        for section in parser.sections():
            result.update({str(section): dict(items[section])})

        return result