Currently job artifacts in CI/CD pipelines on LRZ GitLab never expire. Starting from Wed 26.1.2022 the default expiration time will be 30 days (GitLab default). Currently existing artifacts in already completed jobs will not be affected by the change. The latest artifacts for all jobs in the latest successful pipelines will be kept. More information: https://gitlab.lrz.de/help/user/admin_area/settings/continuous_integration.html#default-artifacts-expiration

error.py 8.38 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 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.
17

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
"""
Module ``error`` defines class Error and a few helpful functions that are
needed for error reporting of DHParser. Usually, what is of interest are
the string representations of the error objects. For example::

    from DHParser import compile_source, has_errors

    result, errors, ast = compile_source(source, preprocessor, grammar,
                                         transformer, compiler)
    if errors:
        for error in errors:
            print(error)

        if has_errors(errors):
            print("There have been fatal errors!")
            sys.exit(1)
        else:
            print("There have been warnings, but no errors.")
"""

di68kap's avatar
di68kap committed
38

39
40
import bisect

41
from DHParser.preprocess import SourceMapFunc
42
from DHParser.stringview import StringView
eckhart's avatar
eckhart committed
43
from DHParser.toolkit import typing
eckhart's avatar
eckhart committed
44
from typing import Iterable, Iterator, Union, Tuple, List
45

Eckhart Arnold's avatar
Eckhart Arnold committed
46
47
__all__ = ('ErrorCode',
           'Error',
48
49
50
51
52
           'is_error',
           'is_warning',
           'has_errors',
           'only_errors',
           'linebreaks',
53
           'line_col',
eckhart's avatar
eckhart committed
54
           'adjust_error_locations')
55
56


Eckhart Arnold's avatar
Eckhart Arnold committed
57
58
59
60
class ErrorCode(int):
    pass


61
class Error:
eckhart's avatar
eckhart committed
62
    __slots__ = ['message', 'level', 'code', '_pos', 'orig_pos', 'line', 'column', '_node_keep']
63

64
65
    # error levels

Eckhart Arnold's avatar
Eckhart Arnold committed
66
67
    NO_ERROR  = ErrorCode(0)
    MESSAGE   = ErrorCode(1)
68
    WARNING   = ErrorCode(100)
Eckhart Arnold's avatar
Eckhart Arnold committed
69
    ERROR     = ErrorCode(1000)
70
71
    HIGHEST   = ERROR

72
73
    # warning codes

74
    REDECLARED_TOKEN_WARNING                 = ErrorCode(120)
75
    UNUSED_ERROR_HANDLING_WARNING            = ErrorCode(130)
76
    LEFT_RECURSION_WARING                    = ErrorCode(140)
77

78
    UNDEFINED_SYMBOL_IN_TRANSTABLE_WARNING   = ErrorCode(610)
79

80
81
    # error codes

82
83
84
85
86
87
88
    MANDATORY_CONTINUATION                   = ErrorCode(1010)
    MANDATORY_CONTINUATION_AT_EOF            = ErrorCode(1015)
    PARSER_DID_NOT_MATCH                     = ErrorCode(1020)
    PARSER_LOOKAHEAD_MATCH_ONLY              = ErrorCode(1030)
    PARSER_STOPPED_BEFORE_END                = ErrorCode(1040)
    CAPTURE_STACK_NOT_EMPTY                  = ErrorCode(1050)
    MALFORMED_ERROR_STRING                   = ErrorCode(1060)
89
    AMBIGUOUS_ERROR_HANDLING                 = ErrorCode(1070)
90
    REDEFINED_DIRECTIVE                      = ErrorCode(1080)
91
    INFINITE_LOOP                            = ErrorCode(1090)
92

Eckhart Arnold's avatar
Eckhart Arnold committed
93
94
95
96
97
    def __init__(self, message: str, pos, code: ErrorCode = ERROR,
                 orig_pos: int = -1, line: int = -1, column: int = -1) -> None:
        assert isinstance(code, ErrorCode)
        assert not isinstance(pos, ErrorCode)
        assert pos >= 0
98
        assert code >= 0
di68kap's avatar
di68kap committed
99
100
101
102
103
104
        self.message = message    # type: str
        self._pos = pos           # type: int
        self.code = code          # type: ErrorCode
        self.orig_pos = orig_pos  # type: int
        self.line = line          # type: int
        self.column = column      # type: int
105
106
107
108

    def __str__(self):
        prefix = ''
        if self.line > 0:
di68kap's avatar
di68kap committed
109
            prefix = "%i:%i: " % (max(self.line, 0), max(self.column, 0))
110
        return prefix + "%s (%i): %s" % (self.severity, self.code, self.message)
111

112
    def __repr__(self):
113
114
        return 'Error("%s", %s, %i, %i, %i, %i)' \
               % (self.message, repr(self.code), self.pos, self.orig_pos, self.line, self.column)
115

eckhart's avatar
eckhart committed
116
117
118
119
    @property
    def pos(self):
        return self._pos

120
    @property
di68kap's avatar
di68kap committed
121
    def severity(self):
122
        """Returns a string representation of the error level, e.g. "warning"."""
123
        return "Warning" if is_warning(self.code) else "Error"
124

125
126
127
128
129
130
131
    def visualize(self, document: str) -> str:
        """Shows the line of the document and the position where the error
        occurred."""
        start = document.rfind('\n', 0, self.pos) + 1
        stop = document.find('\n', self.pos)
        return document[start:stop] + '\n' + ' ' * (self.pos - start) + '^\n'

132

133
def is_warning(code: int) -> bool:
eckhart's avatar
eckhart committed
134
    """Returns True, if error is merely a warning."""
135
    return code < Error.ERROR
136
137


138
def is_error(code: int) -> bool:
eckhart's avatar
eckhart committed
139
    """Returns True, if error is an error, not just a warning."""
140
    return code >= Error.ERROR
141
142


143
144
145
146
147
148
149
150
151
152
153
154
# def Warning(message: str, pos, code: ErrorCode = Error.WARNING,
#             orig_pos: int = -1, line: int = -1, column: int = -1) -> Error:
#     """
#     Syntactic sugar for creating Error-objects that contain only a warning.
#     Raises a ValueError if `code` is not within the range for warnings.
#     """
#     if not is_warning(code):
#         raise ValueError("Tried to create a warning with a error code {}. "
#                          "Warning codes must be smaller than {}".format(code, Error.ERROR))
#     return Error(message, pos, code, orig_pos, line, column)


eckhart's avatar
eckhart committed
155
def has_errors(messages: Iterable[Error], level: int = Error.ERROR) -> bool:
156
157
158
159
160
    """
    Returns True, if at least one entry in `messages` has at
    least the given error `level`.
    """
    for err_obj in messages:
161
        if err_obj.code >= level:
162
163
164
165
            return True
    return False


eckhart's avatar
eckhart committed
166
def only_errors(messages: Iterable[Error], level: int = Error.ERROR) -> Iterator[Error]:
167
168
169
170
    """
    Returns an Iterator that yields only those messages that have
    at least the given error level.
    """
171
    return (err for err in messages if err.code >= level)
172
173


174
175
176
177
178
179
180
#######################################################################
#
# Setting of line, column and position properties of error messages.
#
#######################################################################


eckhart's avatar
eckhart committed
181
def linebreaks(text: Union[StringView, str]) -> List[int]:
eckhart's avatar
eckhart committed
182
183
184
185
    """
    Returns a list of indices all line breaks in the text.
    """
    lbr = [-1]
186
187
    i = text.find('\n', 0)
    while i >= 0:
eckhart's avatar
eckhart committed
188
        lbr.append(i)
189
        i = text.find('\n', i + 1)
eckhart's avatar
eckhart committed
190
191
    lbr.append(len(text))
    return lbr
192
193


194
def line_col(lbreaks: List[int], pos: int) -> Tuple[int, int]:
eckhart's avatar
eckhart committed
195
196
    """
    Returns the position within a text as (line, column)-tuple based
197
198
    on a list of all line breaks, including -1 and EOF.
    """
199
200
    if not lbreaks and pos >= 0:
        return 0, pos
201
202
203
204
205
206
    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

207

208
209
210
# def line_col(text: Union[StringView, str], pos: int) -> Tuple[int, int]:
#     """
#     Returns the position within a text as (line, column)-tuple.
211
#     """
212
#     if pos < 0 or add_pos > len(text):  # one character behind EOF is still an allowed position!
213
214
#         raise ValueError('Position %i outside text of length %s !' % (pos, len(text)))
#     line = text.count("\n", 0, pos) + 1
215
#     column = pos - text.rfind("\n", 0, add_pos)
216
217
218
#     return line, column


eckhart's avatar
eckhart committed
219
220
def adjust_error_locations(errors: List[Error],
                           original_text: Union[StringView, str],
eckhart's avatar
eckhart committed
221
                           source_mapping: SourceMapFunc = lambda i: i) -> List[Error]:
222
223
224
225
    """Adds (or adjusts) line and column numbers of error messages in place.

    Args:
        errors:  The list of errors as returned by the method
226
            ``errors()`` of a Node object
227
228
229
230
        original_text:  The source text on which the errors occurred.
            (Needed in order to determine the line and column numbers.)
        source_mapping:  A function that maps error positions to their
            positions in the original source file.
231

232
233
    Returns:
        The list of errors. (Returning the list of errors is just syntactical
234
        sugar. Be aware that the line, col and orig_pos attr have been
235
236
237
238
239
240
241
242
        changed in place.)
    """
    line_breaks = linebreaks(original_text)
    for err in errors:
        assert err.pos >= 0
        err.orig_pos = source_mapping(err.pos)
        err.line, err.column = line_col(line_breaks, err.orig_pos)
    return errors