codecs.py 36 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126
  1. """ codecs -- Python Codec Registry, API and helpers.
  2. Written by Marc-Andre Lemburg (mal@lemburg.com).
  3. (c) Copyright CNRI, All Rights Reserved. NO WARRANTY.
  4. """
  5. import builtins
  6. import sys
  7. ### Registry and builtin stateless codec functions
  8. try:
  9. from _codecs import *
  10. except ImportError as why:
  11. raise SystemError('Failed to load the builtin codecs: %s' % why)
  12. __all__ = ["register", "lookup", "open", "EncodedFile", "BOM", "BOM_BE",
  13. "BOM_LE", "BOM32_BE", "BOM32_LE", "BOM64_BE", "BOM64_LE",
  14. "BOM_UTF8", "BOM_UTF16", "BOM_UTF16_LE", "BOM_UTF16_BE",
  15. "BOM_UTF32", "BOM_UTF32_LE", "BOM_UTF32_BE",
  16. "CodecInfo", "Codec", "IncrementalEncoder", "IncrementalDecoder",
  17. "StreamReader", "StreamWriter",
  18. "StreamReaderWriter", "StreamRecoder",
  19. "getencoder", "getdecoder", "getincrementalencoder",
  20. "getincrementaldecoder", "getreader", "getwriter",
  21. "encode", "decode", "iterencode", "iterdecode",
  22. "strict_errors", "ignore_errors", "replace_errors",
  23. "xmlcharrefreplace_errors",
  24. "backslashreplace_errors", "namereplace_errors",
  25. "register_error", "lookup_error"]
  26. ### Constants
  27. #
  28. # Byte Order Mark (BOM = ZERO WIDTH NO-BREAK SPACE = U+FEFF)
  29. # and its possible byte string values
  30. # for UTF8/UTF16/UTF32 output and little/big endian machines
  31. #
  32. # UTF-8
  33. BOM_UTF8 = b'\xef\xbb\xbf'
  34. # UTF-16, little endian
  35. BOM_LE = BOM_UTF16_LE = b'\xff\xfe'
  36. # UTF-16, big endian
  37. BOM_BE = BOM_UTF16_BE = b'\xfe\xff'
  38. # UTF-32, little endian
  39. BOM_UTF32_LE = b'\xff\xfe\x00\x00'
  40. # UTF-32, big endian
  41. BOM_UTF32_BE = b'\x00\x00\xfe\xff'
  42. if sys.byteorder == 'little':
  43. # UTF-16, native endianness
  44. BOM = BOM_UTF16 = BOM_UTF16_LE
  45. # UTF-32, native endianness
  46. BOM_UTF32 = BOM_UTF32_LE
  47. else:
  48. # UTF-16, native endianness
  49. BOM = BOM_UTF16 = BOM_UTF16_BE
  50. # UTF-32, native endianness
  51. BOM_UTF32 = BOM_UTF32_BE
  52. # Old broken names (don't use in new code)
  53. BOM32_LE = BOM_UTF16_LE
  54. BOM32_BE = BOM_UTF16_BE
  55. BOM64_LE = BOM_UTF32_LE
  56. BOM64_BE = BOM_UTF32_BE
  57. ### Codec base classes (defining the API)
  58. class CodecInfo(tuple):
  59. """Codec details when looking up the codec registry"""
  60. # Private API to allow Python 3.4 to blacklist the known non-Unicode
  61. # codecs in the standard library. A more general mechanism to
  62. # reliably distinguish test encodings from other codecs will hopefully
  63. # be defined for Python 3.5
  64. #
  65. # See http://bugs.python.org/issue19619
  66. _is_text_encoding = True # Assume codecs are text encodings by default
  67. def __new__(cls, encode, decode, streamreader=None, streamwriter=None,
  68. incrementalencoder=None, incrementaldecoder=None, name=None,
  69. *, _is_text_encoding=None):
  70. self = tuple.__new__(cls, (encode, decode, streamreader, streamwriter))
  71. self.name = name
  72. self.encode = encode
  73. self.decode = decode
  74. self.incrementalencoder = incrementalencoder
  75. self.incrementaldecoder = incrementaldecoder
  76. self.streamwriter = streamwriter
  77. self.streamreader = streamreader
  78. if _is_text_encoding is not None:
  79. self._is_text_encoding = _is_text_encoding
  80. return self
  81. def __repr__(self):
  82. return "<%s.%s object for encoding %s at %#x>" % \
  83. (self.__class__.__module__, self.__class__.__qualname__,
  84. self.name, id(self))
  85. class Codec:
  86. """ Defines the interface for stateless encoders/decoders.
  87. The .encode()/.decode() methods may use different error
  88. handling schemes by providing the errors argument. These
  89. string values are predefined:
  90. 'strict' - raise a ValueError error (or a subclass)
  91. 'ignore' - ignore the character and continue with the next
  92. 'replace' - replace with a suitable replacement character;
  93. Python will use the official U+FFFD REPLACEMENT
  94. CHARACTER for the builtin Unicode codecs on
  95. decoding and '?' on encoding.
  96. 'surrogateescape' - replace with private code points U+DCnn.
  97. 'xmlcharrefreplace' - Replace with the appropriate XML
  98. character reference (only for encoding).
  99. 'backslashreplace' - Replace with backslashed escape sequences.
  100. 'namereplace' - Replace with \\N{...} escape sequences
  101. (only for encoding).
  102. The set of allowed values can be extended via register_error.
  103. """
  104. def encode(self, input, errors='strict'):
  105. """ Encodes the object input and returns a tuple (output
  106. object, length consumed).
  107. errors defines the error handling to apply. It defaults to
  108. 'strict' handling.
  109. The method may not store state in the Codec instance. Use
  110. StreamWriter for codecs which have to keep state in order to
  111. make encoding efficient.
  112. The encoder must be able to handle zero length input and
  113. return an empty object of the output object type in this
  114. situation.
  115. """
  116. raise NotImplementedError
  117. def decode(self, input, errors='strict'):
  118. """ Decodes the object input and returns a tuple (output
  119. object, length consumed).
  120. input must be an object which provides the bf_getreadbuf
  121. buffer slot. Python strings, buffer objects and memory
  122. mapped files are examples of objects providing this slot.
  123. errors defines the error handling to apply. It defaults to
  124. 'strict' handling.
  125. The method may not store state in the Codec instance. Use
  126. StreamReader for codecs which have to keep state in order to
  127. make decoding efficient.
  128. The decoder must be able to handle zero length input and
  129. return an empty object of the output object type in this
  130. situation.
  131. """
  132. raise NotImplementedError
  133. class IncrementalEncoder(object):
  134. """
  135. An IncrementalEncoder encodes an input in multiple steps. The input can
  136. be passed piece by piece to the encode() method. The IncrementalEncoder
  137. remembers the state of the encoding process between calls to encode().
  138. """
  139. def __init__(self, errors='strict'):
  140. """
  141. Creates an IncrementalEncoder instance.
  142. The IncrementalEncoder may use different error handling schemes by
  143. providing the errors keyword argument. See the module docstring
  144. for a list of possible values.
  145. """
  146. self.errors = errors
  147. self.buffer = ""
  148. def encode(self, input, final=False):
  149. """
  150. Encodes input and returns the resulting object.
  151. """
  152. raise NotImplementedError
  153. def reset(self):
  154. """
  155. Resets the encoder to the initial state.
  156. """
  157. def getstate(self):
  158. """
  159. Return the current state of the encoder.
  160. """
  161. return 0
  162. def setstate(self, state):
  163. """
  164. Set the current state of the encoder. state must have been
  165. returned by getstate().
  166. """
  167. class BufferedIncrementalEncoder(IncrementalEncoder):
  168. """
  169. This subclass of IncrementalEncoder can be used as the baseclass for an
  170. incremental encoder if the encoder must keep some of the output in a
  171. buffer between calls to encode().
  172. """
  173. def __init__(self, errors='strict'):
  174. IncrementalEncoder.__init__(self, errors)
  175. # unencoded input that is kept between calls to encode()
  176. self.buffer = ""
  177. def _buffer_encode(self, input, errors, final):
  178. # Overwrite this method in subclasses: It must encode input
  179. # and return an (output, length consumed) tuple
  180. raise NotImplementedError
  181. def encode(self, input, final=False):
  182. # encode input (taking the buffer into account)
  183. data = self.buffer + input
  184. (result, consumed) = self._buffer_encode(data, self.errors, final)
  185. # keep unencoded input until the next call
  186. self.buffer = data[consumed:]
  187. return result
  188. def reset(self):
  189. IncrementalEncoder.reset(self)
  190. self.buffer = ""
  191. def getstate(self):
  192. return self.buffer or 0
  193. def setstate(self, state):
  194. self.buffer = state or ""
  195. class IncrementalDecoder(object):
  196. """
  197. An IncrementalDecoder decodes an input in multiple steps. The input can
  198. be passed piece by piece to the decode() method. The IncrementalDecoder
  199. remembers the state of the decoding process between calls to decode().
  200. """
  201. def __init__(self, errors='strict'):
  202. """
  203. Create an IncrementalDecoder instance.
  204. The IncrementalDecoder may use different error handling schemes by
  205. providing the errors keyword argument. See the module docstring
  206. for a list of possible values.
  207. """
  208. self.errors = errors
  209. def decode(self, input, final=False):
  210. """
  211. Decode input and returns the resulting object.
  212. """
  213. raise NotImplementedError
  214. def reset(self):
  215. """
  216. Reset the decoder to the initial state.
  217. """
  218. def getstate(self):
  219. """
  220. Return the current state of the decoder.
  221. This must be a (buffered_input, additional_state_info) tuple.
  222. buffered_input must be a bytes object containing bytes that
  223. were passed to decode() that have not yet been converted.
  224. additional_state_info must be a non-negative integer
  225. representing the state of the decoder WITHOUT yet having
  226. processed the contents of buffered_input. In the initial state
  227. and after reset(), getstate() must return (b"", 0).
  228. """
  229. return (b"", 0)
  230. def setstate(self, state):
  231. """
  232. Set the current state of the decoder.
  233. state must have been returned by getstate(). The effect of
  234. setstate((b"", 0)) must be equivalent to reset().
  235. """
  236. class BufferedIncrementalDecoder(IncrementalDecoder):
  237. """
  238. This subclass of IncrementalDecoder can be used as the baseclass for an
  239. incremental decoder if the decoder must be able to handle incomplete
  240. byte sequences.
  241. """
  242. def __init__(self, errors='strict'):
  243. IncrementalDecoder.__init__(self, errors)
  244. # undecoded input that is kept between calls to decode()
  245. self.buffer = b""
  246. def _buffer_decode(self, input, errors, final):
  247. # Overwrite this method in subclasses: It must decode input
  248. # and return an (output, length consumed) tuple
  249. raise NotImplementedError
  250. def decode(self, input, final=False):
  251. # decode input (taking the buffer into account)
  252. data = self.buffer + input
  253. (result, consumed) = self._buffer_decode(data, self.errors, final)
  254. # keep undecoded input until the next call
  255. self.buffer = data[consumed:]
  256. return result
  257. def reset(self):
  258. IncrementalDecoder.reset(self)
  259. self.buffer = b""
  260. def getstate(self):
  261. # additional state info is always 0
  262. return (self.buffer, 0)
  263. def setstate(self, state):
  264. # ignore additional state info
  265. self.buffer = state[0]
  266. #
  267. # The StreamWriter and StreamReader class provide generic working
  268. # interfaces which can be used to implement new encoding submodules
  269. # very easily. See encodings/utf_8.py for an example on how this is
  270. # done.
  271. #
  272. class StreamWriter(Codec):
  273. def __init__(self, stream, errors='strict'):
  274. """ Creates a StreamWriter instance.
  275. stream must be a file-like object open for writing.
  276. The StreamWriter may use different error handling
  277. schemes by providing the errors keyword argument. These
  278. parameters are predefined:
  279. 'strict' - raise a ValueError (or a subclass)
  280. 'ignore' - ignore the character and continue with the next
  281. 'replace'- replace with a suitable replacement character
  282. 'xmlcharrefreplace' - Replace with the appropriate XML
  283. character reference.
  284. 'backslashreplace' - Replace with backslashed escape
  285. sequences.
  286. 'namereplace' - Replace with \\N{...} escape sequences.
  287. The set of allowed parameter values can be extended via
  288. register_error.
  289. """
  290. self.stream = stream
  291. self.errors = errors
  292. def write(self, object):
  293. """ Writes the object's contents encoded to self.stream.
  294. """
  295. data, consumed = self.encode(object, self.errors)
  296. self.stream.write(data)
  297. def writelines(self, list):
  298. """ Writes the concatenated list of strings to the stream
  299. using .write().
  300. """
  301. self.write(''.join(list))
  302. def reset(self):
  303. """ Resets the codec buffers used for keeping internal state.
  304. Calling this method should ensure that the data on the
  305. output is put into a clean state, that allows appending
  306. of new fresh data without having to rescan the whole
  307. stream to recover state.
  308. """
  309. pass
  310. def seek(self, offset, whence=0):
  311. self.stream.seek(offset, whence)
  312. if whence == 0 and offset == 0:
  313. self.reset()
  314. def __getattr__(self, name,
  315. getattr=getattr):
  316. """ Inherit all other methods from the underlying stream.
  317. """
  318. return getattr(self.stream, name)
  319. def __enter__(self):
  320. return self
  321. def __exit__(self, type, value, tb):
  322. self.stream.close()
  323. ###
  324. class StreamReader(Codec):
  325. charbuffertype = str
  326. def __init__(self, stream, errors='strict'):
  327. """ Creates a StreamReader instance.
  328. stream must be a file-like object open for reading.
  329. The StreamReader may use different error handling
  330. schemes by providing the errors keyword argument. These
  331. parameters are predefined:
  332. 'strict' - raise a ValueError (or a subclass)
  333. 'ignore' - ignore the character and continue with the next
  334. 'replace'- replace with a suitable replacement character
  335. 'backslashreplace' - Replace with backslashed escape sequences;
  336. The set of allowed parameter values can be extended via
  337. register_error.
  338. """
  339. self.stream = stream
  340. self.errors = errors
  341. self.bytebuffer = b""
  342. self._empty_charbuffer = self.charbuffertype()
  343. self.charbuffer = self._empty_charbuffer
  344. self.linebuffer = None
  345. def decode(self, input, errors='strict'):
  346. raise NotImplementedError
  347. def read(self, size=-1, chars=-1, firstline=False):
  348. """ Decodes data from the stream self.stream and returns the
  349. resulting object.
  350. chars indicates the number of decoded code points or bytes to
  351. return. read() will never return more data than requested,
  352. but it might return less, if there is not enough available.
  353. size indicates the approximate maximum number of decoded
  354. bytes or code points to read for decoding. The decoder
  355. can modify this setting as appropriate. The default value
  356. -1 indicates to read and decode as much as possible. size
  357. is intended to prevent having to decode huge files in one
  358. step.
  359. If firstline is true, and a UnicodeDecodeError happens
  360. after the first line terminator in the input only the first line
  361. will be returned, the rest of the input will be kept until the
  362. next call to read().
  363. The method should use a greedy read strategy, meaning that
  364. it should read as much data as is allowed within the
  365. definition of the encoding and the given size, e.g. if
  366. optional encoding endings or state markers are available
  367. on the stream, these should be read too.
  368. """
  369. # If we have lines cached, first merge them back into characters
  370. if self.linebuffer:
  371. self.charbuffer = self._empty_charbuffer.join(self.linebuffer)
  372. self.linebuffer = None
  373. if chars < 0:
  374. # For compatibility with other read() methods that take a
  375. # single argument
  376. chars = size
  377. # read until we get the required number of characters (if available)
  378. while True:
  379. # can the request be satisfied from the character buffer?
  380. if chars >= 0:
  381. if len(self.charbuffer) >= chars:
  382. break
  383. # we need more data
  384. if size < 0:
  385. newdata = self.stream.read()
  386. else:
  387. newdata = self.stream.read(size)
  388. # decode bytes (those remaining from the last call included)
  389. data = self.bytebuffer + newdata
  390. if not data:
  391. break
  392. try:
  393. newchars, decodedbytes = self.decode(data, self.errors)
  394. except UnicodeDecodeError as exc:
  395. if firstline:
  396. newchars, decodedbytes = \
  397. self.decode(data[:exc.start], self.errors)
  398. lines = newchars.splitlines(keepends=True)
  399. if len(lines)<=1:
  400. raise
  401. else:
  402. raise
  403. # keep undecoded bytes until the next call
  404. self.bytebuffer = data[decodedbytes:]
  405. # put new characters in the character buffer
  406. self.charbuffer += newchars
  407. # there was no data available
  408. if not newdata:
  409. break
  410. if chars < 0:
  411. # Return everything we've got
  412. result = self.charbuffer
  413. self.charbuffer = self._empty_charbuffer
  414. else:
  415. # Return the first chars characters
  416. result = self.charbuffer[:chars]
  417. self.charbuffer = self.charbuffer[chars:]
  418. return result
  419. def readline(self, size=None, keepends=True):
  420. """ Read one line from the input stream and return the
  421. decoded data.
  422. size, if given, is passed as size argument to the
  423. read() method.
  424. """
  425. # If we have lines cached from an earlier read, return
  426. # them unconditionally
  427. if self.linebuffer:
  428. line = self.linebuffer[0]
  429. del self.linebuffer[0]
  430. if len(self.linebuffer) == 1:
  431. # revert to charbuffer mode; we might need more data
  432. # next time
  433. self.charbuffer = self.linebuffer[0]
  434. self.linebuffer = None
  435. if not keepends:
  436. line = line.splitlines(keepends=False)[0]
  437. return line
  438. readsize = size or 72
  439. line = self._empty_charbuffer
  440. # If size is given, we call read() only once
  441. while True:
  442. data = self.read(readsize, firstline=True)
  443. if data:
  444. # If we're at a "\r" read one extra character (which might
  445. # be a "\n") to get a proper line ending. If the stream is
  446. # temporarily exhausted we return the wrong line ending.
  447. if (isinstance(data, str) and data.endswith("\r")) or \
  448. (isinstance(data, bytes) and data.endswith(b"\r")):
  449. data += self.read(size=1, chars=1)
  450. line += data
  451. lines = line.splitlines(keepends=True)
  452. if lines:
  453. if len(lines) > 1:
  454. # More than one line result; the first line is a full line
  455. # to return
  456. line = lines[0]
  457. del lines[0]
  458. if len(lines) > 1:
  459. # cache the remaining lines
  460. lines[-1] += self.charbuffer
  461. self.linebuffer = lines
  462. self.charbuffer = None
  463. else:
  464. # only one remaining line, put it back into charbuffer
  465. self.charbuffer = lines[0] + self.charbuffer
  466. if not keepends:
  467. line = line.splitlines(keepends=False)[0]
  468. break
  469. line0withend = lines[0]
  470. line0withoutend = lines[0].splitlines(keepends=False)[0]
  471. if line0withend != line0withoutend: # We really have a line end
  472. # Put the rest back together and keep it until the next call
  473. self.charbuffer = self._empty_charbuffer.join(lines[1:]) + \
  474. self.charbuffer
  475. if keepends:
  476. line = line0withend
  477. else:
  478. line = line0withoutend
  479. break
  480. # we didn't get anything or this was our only try
  481. if not data or size is not None:
  482. if line and not keepends:
  483. line = line.splitlines(keepends=False)[0]
  484. break
  485. if readsize < 8000:
  486. readsize *= 2
  487. return line
  488. def readlines(self, sizehint=None, keepends=True):
  489. """ Read all lines available on the input stream
  490. and return them as a list.
  491. Line breaks are implemented using the codec's decoder
  492. method and are included in the list entries.
  493. sizehint, if given, is ignored since there is no efficient
  494. way to finding the true end-of-line.
  495. """
  496. data = self.read()
  497. return data.splitlines(keepends)
  498. def reset(self):
  499. """ Resets the codec buffers used for keeping internal state.
  500. Note that no stream repositioning should take place.
  501. This method is primarily intended to be able to recover
  502. from decoding errors.
  503. """
  504. self.bytebuffer = b""
  505. self.charbuffer = self._empty_charbuffer
  506. self.linebuffer = None
  507. def seek(self, offset, whence=0):
  508. """ Set the input stream's current position.
  509. Resets the codec buffers used for keeping state.
  510. """
  511. self.stream.seek(offset, whence)
  512. self.reset()
  513. def __next__(self):
  514. """ Return the next decoded line from the input stream."""
  515. line = self.readline()
  516. if line:
  517. return line
  518. raise StopIteration
  519. def __iter__(self):
  520. return self
  521. def __getattr__(self, name,
  522. getattr=getattr):
  523. """ Inherit all other methods from the underlying stream.
  524. """
  525. return getattr(self.stream, name)
  526. def __enter__(self):
  527. return self
  528. def __exit__(self, type, value, tb):
  529. self.stream.close()
  530. ###
  531. class StreamReaderWriter:
  532. """ StreamReaderWriter instances allow wrapping streams which
  533. work in both read and write modes.
  534. The design is such that one can use the factory functions
  535. returned by the codec.lookup() function to construct the
  536. instance.
  537. """
  538. # Optional attributes set by the file wrappers below
  539. encoding = 'unknown'
  540. def __init__(self, stream, Reader, Writer, errors='strict'):
  541. """ Creates a StreamReaderWriter instance.
  542. stream must be a Stream-like object.
  543. Reader, Writer must be factory functions or classes
  544. providing the StreamReader, StreamWriter interface resp.
  545. Error handling is done in the same way as defined for the
  546. StreamWriter/Readers.
  547. """
  548. self.stream = stream
  549. self.reader = Reader(stream, errors)
  550. self.writer = Writer(stream, errors)
  551. self.errors = errors
  552. def read(self, size=-1):
  553. return self.reader.read(size)
  554. def readline(self, size=None):
  555. return self.reader.readline(size)
  556. def readlines(self, sizehint=None):
  557. return self.reader.readlines(sizehint)
  558. def __next__(self):
  559. """ Return the next decoded line from the input stream."""
  560. return next(self.reader)
  561. def __iter__(self):
  562. return self
  563. def write(self, data):
  564. return self.writer.write(data)
  565. def writelines(self, list):
  566. return self.writer.writelines(list)
  567. def reset(self):
  568. self.reader.reset()
  569. self.writer.reset()
  570. def seek(self, offset, whence=0):
  571. self.stream.seek(offset, whence)
  572. self.reader.reset()
  573. if whence == 0 and offset == 0:
  574. self.writer.reset()
  575. def __getattr__(self, name,
  576. getattr=getattr):
  577. """ Inherit all other methods from the underlying stream.
  578. """
  579. return getattr(self.stream, name)
  580. # these are needed to make "with StreamReaderWriter(...)" work properly
  581. def __enter__(self):
  582. return self
  583. def __exit__(self, type, value, tb):
  584. self.stream.close()
  585. ###
  586. class StreamRecoder:
  587. """ StreamRecoder instances translate data from one encoding to another.
  588. They use the complete set of APIs returned by the
  589. codecs.lookup() function to implement their task.
  590. Data written to the StreamRecoder is first decoded into an
  591. intermediate format (depending on the "decode" codec) and then
  592. written to the underlying stream using an instance of the provided
  593. Writer class.
  594. In the other direction, data is read from the underlying stream using
  595. a Reader instance and then encoded and returned to the caller.
  596. """
  597. # Optional attributes set by the file wrappers below
  598. data_encoding = 'unknown'
  599. file_encoding = 'unknown'
  600. def __init__(self, stream, encode, decode, Reader, Writer,
  601. errors='strict'):
  602. """ Creates a StreamRecoder instance which implements a two-way
  603. conversion: encode and decode work on the frontend (the
  604. data visible to .read() and .write()) while Reader and Writer
  605. work on the backend (the data in stream).
  606. You can use these objects to do transparent
  607. transcodings from e.g. latin-1 to utf-8 and back.
  608. stream must be a file-like object.
  609. encode and decode must adhere to the Codec interface; Reader and
  610. Writer must be factory functions or classes providing the
  611. StreamReader and StreamWriter interfaces resp.
  612. Error handling is done in the same way as defined for the
  613. StreamWriter/Readers.
  614. """
  615. self.stream = stream
  616. self.encode = encode
  617. self.decode = decode
  618. self.reader = Reader(stream, errors)
  619. self.writer = Writer(stream, errors)
  620. self.errors = errors
  621. def read(self, size=-1):
  622. data = self.reader.read(size)
  623. data, bytesencoded = self.encode(data, self.errors)
  624. return data
  625. def readline(self, size=None):
  626. if size is None:
  627. data = self.reader.readline()
  628. else:
  629. data = self.reader.readline(size)
  630. data, bytesencoded = self.encode(data, self.errors)
  631. return data
  632. def readlines(self, sizehint=None):
  633. data = self.reader.read()
  634. data, bytesencoded = self.encode(data, self.errors)
  635. return data.splitlines(keepends=True)
  636. def __next__(self):
  637. """ Return the next decoded line from the input stream."""
  638. data = next(self.reader)
  639. data, bytesencoded = self.encode(data, self.errors)
  640. return data
  641. def __iter__(self):
  642. return self
  643. def write(self, data):
  644. data, bytesdecoded = self.decode(data, self.errors)
  645. return self.writer.write(data)
  646. def writelines(self, list):
  647. data = b''.join(list)
  648. data, bytesdecoded = self.decode(data, self.errors)
  649. return self.writer.write(data)
  650. def reset(self):
  651. self.reader.reset()
  652. self.writer.reset()
  653. def seek(self, offset, whence=0):
  654. # Seeks must be propagated to both the readers and writers
  655. # as they might need to reset their internal buffers.
  656. self.reader.seek(offset, whence)
  657. self.writer.seek(offset, whence)
  658. def __getattr__(self, name,
  659. getattr=getattr):
  660. """ Inherit all other methods from the underlying stream.
  661. """
  662. return getattr(self.stream, name)
  663. def __enter__(self):
  664. return self
  665. def __exit__(self, type, value, tb):
  666. self.stream.close()
  667. ### Shortcuts
  668. def open(filename, mode='r', encoding=None, errors='strict', buffering=-1):
  669. """ Open an encoded file using the given mode and return
  670. a wrapped version providing transparent encoding/decoding.
  671. Note: The wrapped version will only accept the object format
  672. defined by the codecs, i.e. Unicode objects for most builtin
  673. codecs. Output is also codec dependent and will usually be
  674. Unicode as well.
  675. Underlying encoded files are always opened in binary mode.
  676. The default file mode is 'r', meaning to open the file in read mode.
  677. encoding specifies the encoding which is to be used for the
  678. file.
  679. errors may be given to define the error handling. It defaults
  680. to 'strict' which causes ValueErrors to be raised in case an
  681. encoding error occurs.
  682. buffering has the same meaning as for the builtin open() API.
  683. It defaults to -1 which means that the default buffer size will
  684. be used.
  685. The returned wrapped file object provides an extra attribute
  686. .encoding which allows querying the used encoding. This
  687. attribute is only available if an encoding was specified as
  688. parameter.
  689. """
  690. if encoding is not None and \
  691. 'b' not in mode:
  692. # Force opening of the file in binary mode
  693. mode = mode + 'b'
  694. file = builtins.open(filename, mode, buffering)
  695. if encoding is None:
  696. return file
  697. try:
  698. info = lookup(encoding)
  699. srw = StreamReaderWriter(file, info.streamreader, info.streamwriter, errors)
  700. # Add attributes to simplify introspection
  701. srw.encoding = encoding
  702. return srw
  703. except:
  704. file.close()
  705. raise
  706. def EncodedFile(file, data_encoding, file_encoding=None, errors='strict'):
  707. """ Return a wrapped version of file which provides transparent
  708. encoding translation.
  709. Data written to the wrapped file is decoded according
  710. to the given data_encoding and then encoded to the underlying
  711. file using file_encoding. The intermediate data type
  712. will usually be Unicode but depends on the specified codecs.
  713. Bytes read from the file are decoded using file_encoding and then
  714. passed back to the caller encoded using data_encoding.
  715. If file_encoding is not given, it defaults to data_encoding.
  716. errors may be given to define the error handling. It defaults
  717. to 'strict' which causes ValueErrors to be raised in case an
  718. encoding error occurs.
  719. The returned wrapped file object provides two extra attributes
  720. .data_encoding and .file_encoding which reflect the given
  721. parameters of the same name. The attributes can be used for
  722. introspection by Python programs.
  723. """
  724. if file_encoding is None:
  725. file_encoding = data_encoding
  726. data_info = lookup(data_encoding)
  727. file_info = lookup(file_encoding)
  728. sr = StreamRecoder(file, data_info.encode, data_info.decode,
  729. file_info.streamreader, file_info.streamwriter, errors)
  730. # Add attributes to simplify introspection
  731. sr.data_encoding = data_encoding
  732. sr.file_encoding = file_encoding
  733. return sr
  734. ### Helpers for codec lookup
  735. def getencoder(encoding):
  736. """ Lookup up the codec for the given encoding and return
  737. its encoder function.
  738. Raises a LookupError in case the encoding cannot be found.
  739. """
  740. return lookup(encoding).encode
  741. def getdecoder(encoding):
  742. """ Lookup up the codec for the given encoding and return
  743. its decoder function.
  744. Raises a LookupError in case the encoding cannot be found.
  745. """
  746. return lookup(encoding).decode
  747. def getincrementalencoder(encoding):
  748. """ Lookup up the codec for the given encoding and return
  749. its IncrementalEncoder class or factory function.
  750. Raises a LookupError in case the encoding cannot be found
  751. or the codecs doesn't provide an incremental encoder.
  752. """
  753. encoder = lookup(encoding).incrementalencoder
  754. if encoder is None:
  755. raise LookupError(encoding)
  756. return encoder
  757. def getincrementaldecoder(encoding):
  758. """ Lookup up the codec for the given encoding and return
  759. its IncrementalDecoder class or factory function.
  760. Raises a LookupError in case the encoding cannot be found
  761. or the codecs doesn't provide an incremental decoder.
  762. """
  763. decoder = lookup(encoding).incrementaldecoder
  764. if decoder is None:
  765. raise LookupError(encoding)
  766. return decoder
  767. def getreader(encoding):
  768. """ Lookup up the codec for the given encoding and return
  769. its StreamReader class or factory function.
  770. Raises a LookupError in case the encoding cannot be found.
  771. """
  772. return lookup(encoding).streamreader
  773. def getwriter(encoding):
  774. """ Lookup up the codec for the given encoding and return
  775. its StreamWriter class or factory function.
  776. Raises a LookupError in case the encoding cannot be found.
  777. """
  778. return lookup(encoding).streamwriter
  779. def iterencode(iterator, encoding, errors='strict', **kwargs):
  780. """
  781. Encoding iterator.
  782. Encodes the input strings from the iterator using an IncrementalEncoder.
  783. errors and kwargs are passed through to the IncrementalEncoder
  784. constructor.
  785. """
  786. encoder = getincrementalencoder(encoding)(errors, **kwargs)
  787. for input in iterator:
  788. output = encoder.encode(input)
  789. if output:
  790. yield output
  791. output = encoder.encode("", True)
  792. if output:
  793. yield output
  794. def iterdecode(iterator, encoding, errors='strict', **kwargs):
  795. """
  796. Decoding iterator.
  797. Decodes the input strings from the iterator using an IncrementalDecoder.
  798. errors and kwargs are passed through to the IncrementalDecoder
  799. constructor.
  800. """
  801. decoder = getincrementaldecoder(encoding)(errors, **kwargs)
  802. for input in iterator:
  803. output = decoder.decode(input)
  804. if output:
  805. yield output
  806. output = decoder.decode(b"", True)
  807. if output:
  808. yield output
  809. ### Helpers for charmap-based codecs
  810. def make_identity_dict(rng):
  811. """ make_identity_dict(rng) -> dict
  812. Return a dictionary where elements of the rng sequence are
  813. mapped to themselves.
  814. """
  815. return {i:i for i in rng}
  816. def make_encoding_map(decoding_map):
  817. """ Creates an encoding map from a decoding map.
  818. If a target mapping in the decoding map occurs multiple
  819. times, then that target is mapped to None (undefined mapping),
  820. causing an exception when encountered by the charmap codec
  821. during translation.
  822. One example where this happens is cp875.py which decodes
  823. multiple character to \\u001a.
  824. """
  825. m = {}
  826. for k,v in decoding_map.items():
  827. if not v in m:
  828. m[v] = k
  829. else:
  830. m[v] = None
  831. return m
  832. ### error handlers
  833. try:
  834. strict_errors = lookup_error("strict")
  835. ignore_errors = lookup_error("ignore")
  836. replace_errors = lookup_error("replace")
  837. xmlcharrefreplace_errors = lookup_error("xmlcharrefreplace")
  838. backslashreplace_errors = lookup_error("backslashreplace")
  839. namereplace_errors = lookup_error("namereplace")
  840. except LookupError:
  841. # In --disable-unicode builds, these error handler are missing
  842. strict_errors = None
  843. ignore_errors = None
  844. replace_errors = None
  845. xmlcharrefreplace_errors = None
  846. backslashreplace_errors = None
  847. namereplace_errors = None
  848. # Tell modulefinder that using codecs probably needs the encodings
  849. # package
  850. _false = 0
  851. if _false:
  852. import encodings
  853. ### Tests
  854. if __name__ == '__main__':
  855. # Make stdout translate Latin-1 output into UTF-8 output
  856. sys.stdout = EncodedFile(sys.stdout, 'latin-1', 'utf-8')
  857. # Have stdin translate Latin-1 input into UTF-8 input
  858. sys.stdin = EncodedFile(sys.stdin, 'utf-8', 'latin-1')