aboutsummaryrefslogtreecommitdiffstats
path: root/config_file/parsers/base_parser.py
blob: b1ef1c2c21baf57a97940bc158acb83eb4aea0cf (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
from abc import abstractmethod
from typing import Any, Type

from config_file.exceptions import ParsingError
from config_file.nested_lookup import get_occurrence_of_key
from config_file.parsers.abstract_parser import AbstractParser
from config_file.utils import split_on_dot


class BaseParser(AbstractParser):
    def __init__(self, file_contents: str):
        """
        The BaseParser implements the AbstractParser for us, as long as the
        subclasses implement `loads`, `dumps`, and `decode_error` methods.

        Internally, every parser uses the BaseParser so it does not
        have to re-implement common dictionary manipulation logic. However,
        there is nothing about the BaseParser that is a requirement for
        using ConfigFile.

        Args:
            file_contents: The contents of the file to parse.

        Raises:
            ParsingError: If the decode_error is raised.
        """
        super().__init__(file_contents)
        self.__parsed_content = self.parse_file_contents()

    @abstractmethod
    def loads(self, contents: str) -> dict:
        """
        Transforms the file contents into a dictionary.

        Args:
            contents: The file contents to transform.

        Raises:
            self.decode_error: If there is a decoding error
                while attempting to parse the string.

        Returns:
            The contents of a particular file as a dictionary
            we can manipulate.
        """
        raise NotImplementedError

    @abstractmethod
    def dumps(self, loaded_contents: dict) -> str:
        """
        Transform the parsed contents back into a string.

        Args:
            loaded_contents: The file contents from a self.loads call.
                It doesn't necessary need to be from a loads call, could just
                be a valid dictionary for the given format, but that is the
                typical usecase.

        Raises:
            self.decode_error: If there is a decoding error
                while attempting to transform the dict back into a string.

        Returns:
            The dictionary parsed back into a string.
        """
        raise NotImplementedError

    @property
    @abstractmethod
    def decode_error(self) -> Type[Exception]:
        """
        The decoding error raised by the subclass on loads/dumps.

        Returns:
            The decoding error
        """
        raise NotImplementedError

    @property
    def parsed_content(self) -> dict:
        return self.__parsed_content

    def __str__(self) -> str:
        return self.dumps(self.__parsed_content)

    def parse_file_contents(self) -> dict:
        """
        Parse the file contents by running the `loads`  method on the module.

        Args:
            module: The module to use to parse the file.
            decode_error: The error that is raised from the module if the file
                cannot be decoded.

        Raises:
            ParsingError: If the decode_error is raised while running `loads`.

        Returns:
            The parsed file as a dictionary.
        """
        try:
            return self.loads(self.file_contents)
        except self.decode_error as error:
            raise ParsingError(error)

    def reset_internal_contents(self, file_contents: str) -> None:
        """
        Reset the file contents and parsed contents of the parser.

        Args:
            file_contents: The new file contents.

        Raises:
            ParsingError: If we're unable to parse the new file contents.
        """
        self.file_contents = file_contents
        self.__parsed_content = self.parse_file_contents()

    def get(self, search_key: str) -> Any:
        """
        Retrieve a key from the parsed content.

        Args:
            search_key: The key to search from in the
                parsed content in a "dot" syntax.
                i.e. "section.key"

        Raises:
            KeyError: If the key or one of the sections
                we're subscripting into does not exist.

        Returns:
            The value of the key we're searching for.
        """
        error_key = None

        try:
            if "." not in search_key:
                error_key = search_key
                return self.__parsed_content[search_key]
            else:
                split_keys = split_on_dot(search_key)

            parsed_content = self.__parsed_content
            for key in split_keys:
                error_key = key
                parsed_content = parsed_content[key]
        except (KeyError, TypeError):
            raise KeyError(
                f"cannot `get` {search_key} because "
                f"{error_key} is not subscriptable."
            )

        return parsed_content

    def set(self, key: str, value: Any) -> None:
        if "." not in key:
            self.__parsed_content[key] = value
            return

        keys = split_on_dot(key)
        parsed_content = self.__parsed_content
        for index, key in enumerate(keys):
            if index == len(keys) - 1:
                parsed_content[key] = value
                return

            try:
                parsed_content = parsed_content[key]
            except KeyError:
                parsed_content[key] = {}
                parsed_content = parsed_content[key]

    def delete(self, key: str) -> None:
        try:
            if "." not in key:
                del self.__parsed_content[key]
            else:
                indexes = split_on_dot(key)
                indexes_length = len(indexes)

                parsed_content = self.__parsed_content
                for index, key in enumerate(indexes):
                    if index == indexes_length - 1:
                        del parsed_content[key]
                        break

                    parsed_content = parsed_content[key]
        except (KeyError, TypeError):
            raise KeyError(f"The specified key '{key}' to delete was not found.")

    def has(self, search_key: str, wild: bool = False) -> bool:
        if wild:
            return get_occurrence_of_key(self.__parsed_content, key=search_key) > 0

        try:
            self.get(search_key)
            return True
        except (KeyError, ParsingError):
            return False