reader.py 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  1. # coding: utf-8
  2. # This module contains abstractions for the input stream. You don't have to
  3. # looks further, there are no pretty code.
  4. #
  5. # We define two classes here.
  6. #
  7. # Mark(source, line, column)
  8. # It's just a record and its only use is producing nice error messages.
  9. # Parser does not use it for any other purposes.
  10. #
  11. # Reader(source, data)
  12. # Reader determines the encoding of `data` and converts it to unicode.
  13. # Reader provides the following methods and attributes:
  14. # reader.peek(length=1) - return the next `length` characters
  15. # reader.forward(length=1) - move the current position to `length`
  16. # characters.
  17. # reader.index - the number of the current character.
  18. # reader.line, stream.column - the line and the column of the current
  19. # character.
  20. import codecs
  21. from ruamel.yaml.error import YAMLError, FileMark, StringMark, YAMLStreamError
  22. from ruamel.yaml.util import RegExp
  23. from typing import Any, Dict, Optional, List, Union, Text, Tuple, Optional # NOQA
  24. # from ruamel.yaml.compat import StreamTextType # NOQA
  25. __all__ = ['Reader', 'ReaderError']
  26. class ReaderError(YAMLError):
  27. def __init__(
  28. self, name: Any, position: Any, character: Any, encoding: Any, reason: Any,
  29. ) -> None:
  30. self.name = name
  31. self.character = character
  32. self.position = position
  33. self.encoding = encoding
  34. self.reason = reason
  35. def __str__(self) -> Any:
  36. if isinstance(self.character, bytes):
  37. return (
  38. f"'{self.encoding!s}' codec can't decode byte #x{ord(self.character):02x}: "
  39. f'{self.reason!s}\n'
  40. f' in "{self.name!s}", position {self.position:d}'
  41. )
  42. else:
  43. return (
  44. f'unacceptable character #x{self.character:04x}: {self.reason!s}\n'
  45. f' in "{self.name!s}", position {self.position:d}'
  46. )
  47. class Reader:
  48. # Reader:
  49. # - determines the data encoding and converts it to a unicode string,
  50. # - checks if characters are in allowed range,
  51. # - adds '\0' to the end.
  52. # Reader accepts
  53. # - a `bytes` object,
  54. # - a `str` object,
  55. # - a file-like object with its `read` method returning `str`,
  56. # - a file-like object with its `read` method returning `unicode`.
  57. # Yeah, it's ugly and slow.
  58. def __init__(self, stream: Any, loader: Any = None) -> None:
  59. self.loader = loader
  60. if self.loader is not None and getattr(self.loader, '_reader', None) is None:
  61. self.loader._reader = self
  62. self.reset_reader()
  63. self.stream: Any = stream # as .read is called
  64. def reset_reader(self) -> None:
  65. self.name: Any = None
  66. self.stream_pointer = 0
  67. self.eof = True
  68. self.buffer = ""
  69. self.pointer = 0
  70. self.raw_buffer: Any = None
  71. self.raw_decode = None
  72. self.encoding: Optional[Text] = None
  73. self.index = 0
  74. self.line = 0
  75. self.column = 0
  76. @property
  77. def stream(self) -> Any:
  78. try:
  79. return self._stream
  80. except AttributeError:
  81. raise YAMLStreamError('input stream needs to be specified')
  82. @stream.setter
  83. def stream(self, val: Any) -> None:
  84. if val is None:
  85. return
  86. self._stream = None
  87. if isinstance(val, str):
  88. self.name = '<unicode string>'
  89. self.check_printable(val)
  90. self.buffer = val + '\0'
  91. elif isinstance(val, bytes):
  92. self.name = '<byte string>'
  93. self.raw_buffer = val
  94. self.determine_encoding()
  95. else:
  96. if not hasattr(val, 'read'):
  97. raise YAMLStreamError('stream argument needs to have a read() method')
  98. self._stream = val
  99. self.name = getattr(self.stream, 'name', '<file>')
  100. self.eof = False
  101. self.raw_buffer = None
  102. self.determine_encoding()
  103. def peek(self, index: int = 0) -> Text:
  104. try:
  105. return self.buffer[self.pointer + index]
  106. except IndexError:
  107. self.update(index + 1)
  108. return self.buffer[self.pointer + index]
  109. def prefix(self, length: int = 1) -> Any:
  110. if self.pointer + length >= len(self.buffer):
  111. self.update(length)
  112. return self.buffer[self.pointer : self.pointer + length]
  113. def forward_1_1(self, length: int = 1) -> None:
  114. if self.pointer + length + 1 >= len(self.buffer):
  115. self.update(length + 1)
  116. while length != 0:
  117. ch = self.buffer[self.pointer]
  118. self.pointer += 1
  119. self.index += 1
  120. if ch in '\n\x85\u2028\u2029' or (
  121. ch == '\r' and self.buffer[self.pointer] != '\n'
  122. ):
  123. self.line += 1
  124. self.column = 0
  125. elif ch != '\uFEFF':
  126. self.column += 1
  127. length -= 1
  128. def forward(self, length: int = 1) -> None:
  129. if self.pointer + length + 1 >= len(self.buffer):
  130. self.update(length + 1)
  131. while length != 0:
  132. ch = self.buffer[self.pointer]
  133. self.pointer += 1
  134. self.index += 1
  135. if ch == '\n' or (ch == '\r' and self.buffer[self.pointer] != '\n'):
  136. self.line += 1
  137. self.column = 0
  138. elif ch != '\uFEFF':
  139. self.column += 1
  140. length -= 1
  141. def get_mark(self) -> Any:
  142. if self.stream is None:
  143. return StringMark(
  144. self.name, self.index, self.line, self.column, self.buffer, self.pointer,
  145. )
  146. else:
  147. return FileMark(self.name, self.index, self.line, self.column)
  148. def determine_encoding(self) -> None:
  149. while not self.eof and (self.raw_buffer is None or len(self.raw_buffer) < 2):
  150. self.update_raw()
  151. if isinstance(self.raw_buffer, bytes):
  152. if self.raw_buffer.startswith(codecs.BOM_UTF16_LE):
  153. self.raw_decode = codecs.utf_16_le_decode # type: ignore
  154. self.encoding = 'utf-16-le'
  155. elif self.raw_buffer.startswith(codecs.BOM_UTF16_BE):
  156. self.raw_decode = codecs.utf_16_be_decode # type: ignore
  157. self.encoding = 'utf-16-be'
  158. else:
  159. self.raw_decode = codecs.utf_8_decode # type: ignore
  160. self.encoding = 'utf-8'
  161. self.update(1)
  162. NON_PRINTABLE = RegExp(
  163. '[^\x09\x0A\x0D\x20-\x7E\x85' '\xA0-\uD7FF' '\uE000-\uFFFD' '\U00010000-\U0010FFFF' ']' # NOQA
  164. )
  165. _printable_ascii = ('\x09\x0A\x0D' + "".join(map(chr, range(0x20, 0x7F)))).encode('ascii')
  166. @classmethod
  167. def _get_non_printable_ascii(cls: Text, data: bytes) -> Optional[Tuple[int, Text]]: # type: ignore # NOQA
  168. ascii_bytes = data.encode('ascii') # type: ignore
  169. non_printables = ascii_bytes.translate(None, cls._printable_ascii) # type: ignore
  170. if not non_printables:
  171. return None
  172. non_printable = non_printables[:1]
  173. return ascii_bytes.index(non_printable), non_printable.decode('ascii')
  174. @classmethod
  175. def _get_non_printable_regex(cls, data: Text) -> Optional[Tuple[int, Text]]:
  176. match = cls.NON_PRINTABLE.search(data)
  177. if not bool(match):
  178. return None
  179. return match.start(), match.group()
  180. @classmethod
  181. def _get_non_printable(cls, data: Text) -> Optional[Tuple[int, Text]]:
  182. try:
  183. return cls._get_non_printable_ascii(data) # type: ignore
  184. except UnicodeEncodeError:
  185. return cls._get_non_printable_regex(data)
  186. def check_printable(self, data: Any) -> None:
  187. non_printable_match = self._get_non_printable(data)
  188. if non_printable_match is not None:
  189. start, character = non_printable_match
  190. position = self.index + (len(self.buffer) - self.pointer) + start
  191. raise ReaderError(
  192. self.name,
  193. position,
  194. ord(character),
  195. 'unicode',
  196. 'special characters are not allowed',
  197. )
  198. def update(self, length: int) -> None:
  199. if self.raw_buffer is None:
  200. return
  201. self.buffer = self.buffer[self.pointer :]
  202. self.pointer = 0
  203. while len(self.buffer) < length:
  204. if not self.eof:
  205. self.update_raw()
  206. if self.raw_decode is not None:
  207. try:
  208. data, converted = self.raw_decode(self.raw_buffer, 'strict', self.eof)
  209. except UnicodeDecodeError as exc:
  210. character = self.raw_buffer[exc.start]
  211. if self.stream is not None:
  212. position = self.stream_pointer - len(self.raw_buffer) + exc.start
  213. elif self.stream is not None:
  214. position = self.stream_pointer - len(self.raw_buffer) + exc.start
  215. else:
  216. position = exc.start
  217. raise ReaderError(self.name, position, character, exc.encoding, exc.reason)
  218. else:
  219. data = self.raw_buffer
  220. converted = len(data)
  221. self.check_printable(data)
  222. self.buffer += data
  223. self.raw_buffer = self.raw_buffer[converted:]
  224. if self.eof:
  225. self.buffer += '\0'
  226. self.raw_buffer = None
  227. break
  228. def update_raw(self, size: Optional[int] = None) -> None:
  229. if size is None:
  230. size = 4096
  231. data = self.stream.read(size)
  232. if self.raw_buffer is None:
  233. self.raw_buffer = data
  234. else:
  235. self.raw_buffer += data
  236. self.stream_pointer += len(data)
  237. if not data:
  238. self.eof = True
  239. # try:
  240. # import psyco
  241. # psyco.bind(Reader)
  242. # except ImportError:
  243. # pass