2.12.2021, 9:00 - 11:00: Due to updates GitLab may be unavailable for some minutes between 09:00 and 11:00.

error.py 4.88 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
"""error.py - error handling for DHParser

Copyright 2016  by Eckhart Arnold (arnold@badw.de)
                Bavarian Academy of Sciences an Humanities (badw.de)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.  See the License for the specific language governing
permissions and limitations under the License.
"""
di68kap's avatar
di68kap committed
18

19
20
21
import bisect
import functools

22
from DHParser.stringview import StringView
di68kap's avatar
di68kap committed
23
24
25
from DHParser.toolkit import typing
from typing import Hashable, Iterable, Iterator, Union, Tuple, List

26
27
28
29
30
31
32

__all__ = ('Error',
           'is_error',
           'is_warning',
           'has_errors',
           'only_errors',
           'linebreaks',
33
           'line_col')
34
35
36
37
38


class Error:
    __slots__ = ['message', 'level', 'code', 'pos', 'line', 'column']

39
40
    # error levels

41
42
43
44
    WARNING   = 1
    ERROR     = 1000
    HIGHEST   = ERROR

45
46
47
48
    # warning codes

    REDEFINED_DIRECTIVE_WARNING = 101

49
50
51
52
    # error codes

    MANDATORY_CONTINUATION = 1001

53
    def __init__(self, message: str, code: int = ERROR,
54
                 pos: int = -1, line: int = -1, column: int = -1) -> None:
55
        self.message = message
56
        assert code >= 0
57
        self.code = code
58
59
60
        self.pos = pos
        self.line = line
        self.column = column
61
62
63
64
65
66
67

    def __str__(self):
        prefix = ''
        if self.line > 0:
            prefix = "line: %3i, column: %2i, " % (self.line, self.column)
        return prefix + "%s: %s" % (self.level_str, self.message)

68
    def __repr__(self):
69
70
        return 'Error("%s", %s, %i, %i, %i)' \
               % (self.message, repr(self.code), self.pos, self.line, self.column)
71

72
73
    @property
    def level_str(self):
eckhart's avatar
eckhart committed
74
75
        """Returns a string representation of the error level, e.g. "warning".
        """
76
        return "Warning" if is_warning(self.code) else "Error"
77
78


79
def is_warning(code: int) -> bool:
eckhart's avatar
eckhart committed
80
    """Returns True, if error is merely a warning."""
81
    return code < Error.ERROR
82
83


84
def is_error(code: int) -> bool:
eckhart's avatar
eckhart committed
85
    """Returns True, if error is an error, not just a warning."""
86
    return code >= Error.ERROR
87
88


eckhart's avatar
eckhart committed
89
def has_errors(messages: Iterable[Error], level: int = Error.ERROR) -> bool:
90
91
92
93
94
    """
    Returns True, if at least one entry in `messages` has at
    least the given error `level`.
    """
    for err_obj in messages:
95
        if err_obj.code >= level:
96
97
98
99
            return True
    return False


eckhart's avatar
eckhart committed
100
def only_errors(messages: Iterable[Error], level: int = Error.ERROR) -> Iterator[Error]:
101
102
103
104
105
106
107
108
    """
    Returns an Iterator that yields only those messages that have
    at least the given error level.
    """
    return (err for err in messages if err.level >= level)


def linebreaks(text: Union[StringView, str]):
eckhart's avatar
eckhart committed
109
110
111
112
    """
    Returns a list of indices all line breaks in the text.
    """
    lbr = [-1]
113
114
    i = text.find('\n', 0)
    while i >= 0:
eckhart's avatar
eckhart committed
115
        lbr.append(i)
116
        i = text.find('\n', i + 1)
eckhart's avatar
eckhart committed
117
118
    lbr.append(len(text))
    return lbr
119
120
121
122


@functools.singledispatch
def line_col(text: Union[StringView, str], pos: int) -> Tuple[int, int]:
eckhart's avatar
eckhart committed
123
124
    """
    Returns the position within a text as (line, column)-tuple.
125
126
127
128
129
130
131
132
133
134
    """
    if pos < 0 or pos > len(text):  # one character behind EOF is still an allowed position!
        raise ValueError('Position %i outside text of length %s !' % (pos, len(text)))
    line = text.count("\n", 0, pos) + 1
    column = pos - text.rfind("\n", 0, pos)
    return line, column


@line_col.register(list)
def _line_col(lbreaks: List[int], pos: int) -> Tuple[int, int]:
eckhart's avatar
eckhart committed
135
136
    """
    Returns the position within a text as (line, column)-tuple based
137
138
139
140
141
142
143
144
    on a list of all line breaks, including -1 and EOF.
    """
    if pos < 0 or pos > lbreaks[-1]:  # one character behind EOF is still an allowed position!
        raise ValueError('Position %i outside text of length %s !' % (pos, lbreaks[-1]))
    line = bisect.bisect_left(lbreaks, pos)
    column = pos - lbreaks[line - 1]
    return line, column

145

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# def error_messages(source_text:str, errors: List[Error]) -> List[str]:
#     """Adds line, column information for error messages, if the position
#     is given.
#
#     Args:
#         source_text (str):  The source text on which the errors occurred.
#             (Needed in order to determine the line and column numbers.)
#         errors (list):  The list of errors as returned by the method
#             ``collect_errors()`` of a Node object
#     Returns:
#         The same list of error messages, which now contain line and
#         column numbers.
#     """
#     for err in errors:
#         if err.pos >= 0 and err.line <= 0:
#             err.line, err.column = line_col(source_text, err.pos)
#     return errors