aboutsummaryrefslogtreecommitdiff
path: root/tools/cru-py/cru/parsing.py
blob: be7bbf40623558a94e6231825bb768c7f3d8b62a (plain)
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
from abc import ABCMeta, abstractmethod
from typing import TypeVar, Generic, NoReturn, Callable

from cru.excp import CruException, CRU_EXCEPTION_ATTR_DEF_REGISTRY

R = TypeVar("R")


class ParseException(CruException):
    LINE_NUMBER_KEY = "line_number"

    CRU_EXCEPTION_ATTR_DEF_REGISTRY.register_with(LINE_NUMBER_KEY, "Line number of the error.")


class Parser(Generic[R], metaclass=ABCMeta):
    def __init__(self, name: str) -> None:
        self._name = name

    @property
    def name(self) -> str:
        return self._name

    @abstractmethod
    def parse(self, s: str) -> R:
        raise NotImplementedError()

    def raise_parse_exception(self, s: str, line_number: int | None = None) -> NoReturn:
        a = f" at line {line_number}" if line_number is not None else ""
        raise ParseException(f"Parser {self.name} failed{a}, {s}")


class SimpleLineConfigParser(Parser[list[tuple[str, str]]]):
    def __init__(self) -> None:
        super().__init__(type(self).__name__)

    def _parse(self, s: str, f: Callable[[str, str], None]) -> None:
        for ln, line in enumerate(s.splitlines()):
            line_number = ln + 1
            # check if it's a comment
            if line.strip().startswith("#"):
                continue
            # check if there is a '='
            if line.find("=") == -1:
                self.raise_parse_exception(f"There is even no '='!", line_number)
            # split at first '='
            key, value = line.split("=", 1)
            key = key.strip()
            value = value.strip()
            f(key, value)

    def parse(self, s: str) -> list[tuple[str, str]]:
        items = []
        self._parse(s, lambda key, value: items.append((key, value)))
        return items

    def parse_to_dict(self, s: str, /, allow_override: bool = False) -> tuple[dict[str, str], list[tuple[str, str]]]:
        d = {}
        duplicate = []

        def add(key: str, value: str) -> None:
            if key in d:
                if allow_override:
                    duplicate.append((key, d[key]))
                    d[key] = value
                else:
                    self.raise_parse_exception(f"Key '{key}' already exists!", None)
            d[key] = value

        self._parse(s, add)
        return d, duplicate