source: branches/pyyaml3000/lib/yaml/reader.py @ 47

Revision 47, 8.8 KB checked in by xi, 9 years ago (diff)

Working on the scanner.

Line 
1# This module contains abstractions for the input stream. You don't have to
2# looks further, there are no pretty code.
3#
4# We define two classes here.
5#
6#   Marker(source, line, column)
7# It's just a record and its only use is producing nice error messages.
8# Parser does not use it for any other purposes.
9#
10#   Reader(source, data)
11# Reader determines the encoding of `data` and converts it to unicode.
12# Reader provides the following methods and attributes:
13#   reader.peek(length=1) - return the next `length` characters
14#   reader.forward(length=1) - move the current position to `length` characters.
15#   reader.index - the number of the current character.
16#   reader.line, stream.column - the line and the column of the current character.
17
18__all__ = ['Marker', 'Reader', 'ReaderError']
19
20from error import YAMLError
21
22import codecs, re
23
24# Unfortunately, codec functions in Python 2.3 does not support the `finish`
25# arguments, so we have to write our own wrappers.
26
27try:
28    codecs.utf_8_decode('', 'strict', False)
29    from codecs import utf_8_decode, utf_16_le_decode, utf_16_be_decode
30
31except TypeError:
32
33    def utf_16_le_decode(data, errors, finish=False):
34        if not finish and len(data) % 2 == 1:
35            data = data[:-1]
36        return codecs.utf_16_le_decode(data, errors)
37
38    def utf_16_be_decode(data, errors, finish=False):
39        if not finish and len(data) % 2 == 1:
40            data = data[:-1]
41        return codecs.utf_16_be_decode(data, errors)
42
43    def utf_8_decode(data, errors, finish=False):
44        if not finish:
45            # We are trying to remove a possible incomplete multibyte character
46            # from the suffix of the data.
47            # The first byte of a multi-byte sequence is in the range 0xc0 to 0xfd.
48            # All further bytes are in the range 0x80 to 0xbf.
49            # UTF-8 encoded UCS characters may be up to six bytes long.
50            count = 0
51            while count < 5 and count < len(data)   \
52                    and '\x80' <= data[-count-1] <= '\xBF':
53                count -= 1
54            if count < 5 and count < len(data)  \
55                    and '\xC0' <= data[-count-1] <= '\xFD':
56                data = data[:-count-1]
57        return codecs.utf_8_decode(data, errors)
58
59class Marker:
60
61    def __init__(self, name, line, column, buffer, pointer):
62        self.name = name
63        self.line = line
64        self.column = column
65        self.buffer = buffer
66        self.pointer = pointer
67
68    def get_snippet(self, indent=4, max_length=75):
69        if self.buffer is None:
70            return None
71        head = ''
72        start = self.pointer
73        while start > 0 and self.buffer[start-1] not in u'\0\r\n\x85\u2028\u2029':
74            start -= 1
75            if self.pointer-start > max_length/2-1:
76                head = ' ... '
77                start += 5
78                break
79        tail = ''
80        end = self.pointer
81        while end < len(self.buffer) and self.buffer[end] not in u'\0\r\n\x85\u2028\u2029':
82            end += 1
83            if end-self.pointer > max_length/2-1:
84                tail = ' ... '
85                end -= 5
86                break
87        snippet = self.buffer[start:end].encode('utf-8')
88        return ' '*indent + head + snippet + tail + '\n'  \
89                + ' '*(indent+self.pointer-start+len(head)) + '^'
90
91    def __str__(self):
92        snippet = self.get_snippet()
93        where = "  in \"%s\", line %d, column %d"   \
94                % (self.name, self.line+1, self.column+1)
95        if snippet is not None:
96            where += ":\n"+snippet
97        return where
98
99class ReaderError(YAMLError):
100
101    def __init__(self, name, position, character, encoding, reason):
102        self.name = name
103        self.character = character
104        self.position = position
105        self.encoding = encoding
106        self.reason = reason
107
108    def __str__(self):
109        if isinstance(self.character, str):
110            return "'%s' codec can't decode byte #x%02x: %s\n"  \
111                    "  in \"%s\", position %d"    \
112                    % (self.encoding, ord(self.character), self.reason,
113                            self.name, self.position)
114        else:
115            return "unacceptable character #x%04x: %s\n"    \
116                    "  in \"%s\", position %d"    \
117                    % (ord(self.character), self.reason,
118                            self.name, self.position)
119
120class Reader:
121    # Reader:
122    # - determines the data encoding and converts it to unicode,
123    # - checks if characters are in allowed range,
124    # - adds '\0' to the end.
125
126    # Reader accepts
127    #  - a `str` object,
128    #  - a `unicode` object,
129    #  - a file-like object with its `read` method returning `str`,
130    #  - a file-like object with its `read` method returning `unicode`.
131
132    # Yeah, it's ugly and slow.
133
134    def __init__(self, data):
135        self.name = None
136        self.stream = None
137        self.stream_pointer = 0
138        self.eof = True
139        self.buffer = u''
140        self.pointer = 0
141        self.raw_buffer = None
142        self.raw_decode = None
143        self.index = 0
144        self.line = 0
145        self.column = 0
146        if isinstance(data, unicode):
147            self.name = "<unicode string>"
148            self.check_printable(data)
149            self.buffer = data+u'\0'
150        elif isinstance(data, str):
151            self.name = "<string>"
152            self.raw_buffer = data
153            self.determine_encoding()
154        else:
155            self.stream = data
156            self.name = getattr(data, 'name', "<file>")
157            self.eof = False
158            self.raw_buffer = ''
159            self.determine_encoding()
160
161    def peek(self, length=1):
162        if self.pointer+length >= len(self.buffer):
163            self.update(length)
164        return self.buffer[self.pointer:self.pointer+length]
165
166    def forward(self, length=1):
167        if self.pointer+length+1 >= len(self.buffer):
168            self.update(length+1)
169        for k in range(length):
170            ch = self.buffer[self.pointer]
171            self.pointer += 1
172            self.index += 1
173            if ch in u'\n\x85\u2028\u2029'  \
174                    or (ch == u'\r' and self.buffer[self.pointer+1] != u'\n'):
175                self.line += 1
176                self.column = 0
177            elif ch != u'\uFEFF':
178                self.column += 1
179
180    def get_marker(self):
181        if self.stream is None:
182            return Marker(self.name, self.line, self.column,
183                    self.buffer, self.pointer)
184        else:
185            return Marker(self.name, self.line, self.column, None, None)
186
187    def determine_encoding(self):
188        while not self.eof and len(self.raw_buffer) < 2:
189            self.update_raw()
190        if not isinstance(self.raw_buffer, unicode):
191            if self.raw_buffer.startswith(codecs.BOM_UTF16_LE):
192                self.raw_decode = utf_16_le_decode
193            elif self.raw_buffer.startswith(codecs.BOM_UTF16_BE):
194                self.raw_decode = utf_16_be_decode
195            else:
196                self.raw_decode = utf_8_decode
197        self.update(1)
198
199    NON_PRINTABLE = re.compile(u'[^\x09\x0A\x0D\x20-\x7E\x85\xA0-\uD7FF\uE000-\uFFFD]')
200    def check_printable(self, data):
201        match = self.NON_PRINTABLE.search(data)
202        if match:
203            character = match.group()
204            position = self.index+(len(self.buffer)-self.pointer)+match.start()
205            raise ReaderError(self.name, position, character,
206                    'unicode', "special characters are not allowed")
207
208    def update(self, length):
209        if self.raw_buffer is None:
210            return
211        self.buffer = self.buffer[self.pointer:]
212        self.pointer = 0
213        while len(self.buffer) < length:
214            if not self.eof:
215                self.update_raw()
216            if self.raw_decode is not None:
217                try:
218                    data, converted = self.raw_decode(self.raw_buffer,
219                            'strict', self.eof)
220                except UnicodeDecodeError, exc:
221                    character = exc.object[exc.start]
222                    if self.stream is not None:
223                        position = self.stream_pointer-len(self.raw_buffer)+exc.start
224                    else:
225                        position = exc.start
226                    raise ReaderError(self.name, position, character,
227                            exc.encoding, exc.reason)
228            else:
229                data = self.raw_buffer
230                converted = len(data)
231            self.check_printable(data)
232            self.buffer += data
233            self.raw_buffer = self.raw_buffer[converted:]
234            if self.eof:
235                self.buffer += u'\0'
236                self.raw_buffer = None
237                break
238
239    def update_raw(self, size=1024):
240        data = self.stream.read(size)
241        if data:
242            self.raw_buffer += data
243            self.stream_pointer += len(data)
244        else:
245            self.eof = True
246
247#try:
248#    import psyco
249#    psyco.bind(Reader)
250#except ImportError:
251#    pass
252
Note: See TracBrowser for help on using the repository browser.