error.py 4.62 KB
Newer Older
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
"""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.
"""
import bisect
import functools
from typing import Hashable, Iterable, Iterator, Union, Tuple, List

from DHParser.toolkit import StringView

__all__ = ('Error',
           'is_error',
           'is_warning',
           'has_errors',
           'only_errors',
           'linebreaks',
30
           'line_col')
31
32
33
34
35


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

36
37
    # error levels

38
39
40
41
    WARNING   = 1
    ERROR     = 1000
    HIGHEST   = ERROR

42
43
44
45
    # error codes

    MANDATORY_CONTINUATION = 1001

46
47
    def __init__(self, message: str, level: int = ERROR, code: Hashable = 0,
                 pos: int = -1, line: int = -1, column: int = -1):
48
49
50
51
        self.message = message
        assert level >= 0
        self.level = level or Error.ERROR
        self.code = code
52
53
54
        self.pos = pos
        self.line = line
        self.column = column
55
56
57
58
59
60
61

    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)

62
63
64
65
    def __repr__(self):
        return 'Error("%s", %i, %s, %i, %i, %i)' \
               % (self.message, self.level, repr(self.code), self.pos, self.line, self.column)

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
    @property
    def level_str(self):
        return "Warning" if is_warning(self.level) else "Error"


def is_warning(level: int) -> bool:
    return level < Error.ERROR


def is_error(level:  int) -> bool:
    return level >= Error.ERROR


def has_errors(messages: Iterable[Error], level: int=Error.ERROR) -> bool:
    """
    Returns True, if at least one entry in `messages` has at
    least the given error `level`.
    """
    for err_obj in messages:
        if err_obj.level >= level:
            return True
    return False


def only_errors(messages: Iterable[Error], level: int=Error.ERROR) -> Iterator[Error]:
    """
    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]):
    lb = [-1]
    i = text.find('\n', 0)
    while i >= 0:
        lb.append(i)
        i = text.find('\n', i + 1)
    lb.append(len(text))
    return lb


@functools.singledispatch
def line_col(text: Union[StringView, str], pos: int) -> Tuple[int, int]:
    """Returns the position within a text as (line, column)-tuple.
    """
    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)))
    # assert pos <= len(text), str(pos) + " > " + str(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]:
    """Returns the position within a text as (line, column)-tuple based
    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

131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# 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