2014-07-09 18:15:23 +08:00
<03>
<EFBFBD> W`Sc
<16> <00>
<>
<00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00>
<> <> <00> <00> <>
Written by Marc-Andre Lemburg (mal@lemburg.com).
(c) Copyright CNRI, All Rights Reserved. NO WARRANTY.
2014-07-10 23:57:08 +08:00
i<EFBFBD> <EFBFBD> <EFBFBD> <EFBFBD> N( <00> <> s <00> <> s <00> <> <00> <> t <00> <00> <00> <00>
<00> <00> <>
2014-07-09 18:15:23 +08:00
The .encode()/.decode() methods may use different error
handling schemes by providing the errors argument. These
string values are predefined:
'strict' - raise a ValueError error (or a subclass)
'ignore' - ignore the character and continue with the next
'replace' - replace with a suitable replacement character;
Python will use the official U+FFFD REPLACEMENT
CHARACTER for the builtin Unicode codecs on
decoding and '?' on encoding.
'xmlcharrefreplace' - Replace with the appropriate XML
character reference (only for encoding).
'backslashreplace' - Replace with backslashed escape sequences
(only for encoding).
The set of allowed values can be extended via register_error.
t
<00>
object, length consumed).
errors defines the error handling to apply. It defaults to
'strict' handling.
The method may not store state in the Codec instance. Use
StreamCodec for codecs which have to keep state in order to
make encoding/decoding efficient.
The encoder must be able to handle zero length input and
return an empty object of the output object type in this
situation.
2014-07-10 23:57:08 +08:00
N(
2014-07-09 18:15:23 +08:00
<00> <>
object, length consumed).
input must be an object which provides the bf_getreadbuf
buffer slot. Python strings, buffer objects and memory
mapped files are examples of objects providing this slot.
errors defines the error handling to apply. It defaults to
'strict' handling.
The method may not store state in the Codec instance. Use
StreamCodec for codecs which have to keep state in order to
make encoding/decoding efficient.
The decoder must be able to handle zero length input and
return an empty object of the output object type in this
situation.
2014-07-10 23:57:08 +08:00
N( <00> <00> <00> <00> <00> <00> <>
2014-07-09 18:15:23 +08:00
An IncrementalEncoder encodes an input in multiple steps. The input can be
passed piece by piece to the encode() method. The IncrementalEncoder remembers
the state of the Encoding process between calls to encode().
R. <>
Creates an IncrementalEncoder instance.
The IncrementalEncoder may use different error handling schemes by
providing the errors keyword argument. See the module docstring
for a list of possible values.
2014-07-10 23:57:08 +08:00
t <5F>
2014-07-09 18:15:23 +08:00
<00>
Encodes input and returns the resulting object.
2014-07-10 23:57:08 +08:00
N( <00>
2014-07-09 18:15:23 +08:00
Resets the encoder to the initial state.
2014-07-10 23:57:08 +08:00
N( <65>
2014-07-09 18:15:23 +08:00
Return the current state of the encoder.
2014-07-10 23:57:08 +08:00
i <74>
2014-07-09 18:15:23 +08:00
Set the current state of the encoder. state must have been
returned by getstate().
2014-07-10 23:57:08 +08:00
N( <74> <00> <00> <00> <00> <00> <00> <00> <>
2014-07-09 18:15:23 +08:00
This subclass of IncrementalEncoder can be used as the baseclass for an
incremental encoder if the encoder must keep some of the output in a
buffer between calls to encode().
2014-07-10 23:57:08 +08:00
R. <00> <00>
<00> <64> <00> <00> <00> <00> <00> <00>
<00> <00> <00> <00> <00> <00> <>
2014-07-09 18:15:23 +08:00
An IncrementalDecoder decodes an input in multiple steps. The input can be
passed piece by piece to the decode() method. The IncrementalDecoder
remembers the state of the decoding process between calls to decode().
R. <>
Creates a IncrementalDecoder instance.
The IncrementalDecoder may use different error handling schemes by
providing the errors keyword argument. See the module docstring
for a list of possible values.
2014-07-10 23:57:08 +08:00
N( <00>
2014-07-09 18:15:23 +08:00
<00>
Decodes input and returns the resulting object.
2014-07-10 23:57:08 +08:00
N( <00>
2014-07-09 18:15:23 +08:00
Resets the decoder to the initial state.
2014-07-10 23:57:08 +08:00
N( <00>
2014-07-09 18:15:23 +08:00
Return the current state of the decoder.
This must be a (buffered_input, additional_state_info) tuple.
buffered_input must be a bytes object containing bytes that
were passed to decode() that have not yet been converted.
additional_state_info must be a non-negative integer
representing the state of the decoder WITHOUT yet having
processed the contents of buffered_input. In the initial state
and after reset(), getstate() must return (b"", 0).
2014-07-10 23:57:08 +08:00
R4 <>
2014-07-09 18:15:23 +08:00
Set the current state of the decoder.
state must have been returned by getstate(). The effect of
setstate((b"", 0)) must be equivalent to reset().
2014-07-10 23:57:08 +08:00
N( <00>
2014-07-09 18:15:23 +08:00
<00> <00> <00> <00> <00> <00> <>
This subclass of IncrementalDecoder can be used as the baseclass for an
incremental decoder if the decoder must be able to handle incomplete byte
sequences.
2014-07-10 23:57:08 +08:00
R. <00>
<00> <00> <00>
<00> <00> <00> <00> <00> <00> <00> <00>
2014-07-09 18:15:23 +08:00
stream must be a file-like object open for writing
(binary) data.
The StreamWriter may use different error handling
schemes by providing the errors keyword argument. These
parameters are predefined:
'strict' - raise a ValueError (or a subclass)
'ignore' - ignore the character and continue with the next
'replace'- replace with a suitable replacement character
'xmlcharrefreplace' - Replace with the appropriate XML
character reference.
'backslashreplace' - Replace with backslashed escape
sequences (only for encoding).
The set of allowed parameter values can be extended via
register_error.
2014-07-10 23:57:08 +08:00
N( <00> <00>
N( <00> <00>
2014-07-09 18:15:23 +08:00
using .write().
2014-07-10 23:57:08 +08:00
R4
2014-07-09 18:15:23 +08:00
Calling this method should ensure that the data on the
output is put into a clean state, that allows appending
of new fresh data without having to rescan the whole
stream to recover state.
2014-07-10 23:57:08 +08:00
N(
i <00> <00> <00>
( <5F> <00> <5F> <> <00> <00> <00> <00> <00> <00>
2014-07-09 18:15:23 +08:00
<00>
<00> <00> <00> <00> <00>
stream must be a file-like object open for reading
(binary) data.
The StreamReader may use different error handling
schemes by providing the errors keyword argument. These
parameters are predefined:
'strict' - raise a ValueError (or a subclass)
'ignore' - ignore the character and continue with the next
'replace'- replace with a suitable replacement character;
The set of allowed parameter values can be extended via
register_error.
R4
2014-07-10 23:57:08 +08:00
<00>
2014-07-09 18:15:23 +08:00
2014-07-10 23:57:08 +08:00
<00> <00> <> <69> <EFBFBD> <EFBFBD> c <> <00> <00> <> <50> <> <00> <> <50> <> <00> <00>
2014-07-09 18:15:23 +08:00
<00>
<00> <00> <00> <01> <01> <>
resulting object.
chars indicates the number of characters to read from the
stream. read() will never return more than chars
characters, but it might return less, if there are not enough
characters available.
size indicates the approximate maximum number of bytes to
read from the stream for decoding purposes. The decoder
can modify this setting as appropriate. The default value
-1 indicates to read and decode as much as possible. size
is intended to prevent having to decode huge files in one
step.
If firstline is true, and a UnicodeDecodeError happens
after the first line terminator in the input only the first line
will be returned, the rest of the input will be kept until the
next call to read().
The method should use a greedy read strategy meaning that
it should read as much data as is allowed within the
definition of the encoding and the given size, e.g. if
optional encoding endings or state markers are available
on the stream, these should be read too.
R4
2014-07-10 23:57:08 +08:00
<00> <00> <00> <> <00> <> <00> <> <00> <> <00> <> <00> <> <00> <> <00> <00> <> <1F> <> <50> <00>
2014-07-09 18:15:23 +08:00
<> <> <> <>
decoded data.
size, if given, is passed as size argument to the
read() method.
i <> <69> <EFBFBD> <EFBFBD> i@
2014-07-10 23:57:08 +08:00
<6E>
2014-07-09 18:15:23 +08:00
<00> <00>
and return them as list of lines.
Line breaks are implemented using the codec's decoder
method and are included in the list entries.
sizehint, if given, is ignored since there is no efficient
way to finding the true end-of-line.
2014-07-10 23:57:08 +08:00
( <>
2014-07-09 18:15:23 +08:00
Note that no stream repositioning should take place.
This method is primarily intended to be able to recover
from decoding errors.
2014-07-10 23:57:08 +08:00
R4 <00> <00>
2014-07-09 18:15:23 +08:00
Resets the codec buffers used for keeping state.
2014-07-10 23:57:08 +08:00
N( <00> <00> <00>
( <00> <00> <> <00> <00> <00> <00> <00> <00>
2014-07-09 18:15:23 +08:00
<00> <00> <00> <00> <00> <00> <00>
work in both read and write modes.
The design is such that one can use the factory functions
returned by the codec.lookup() function to construct the
instance.
t <00> <00>
stream must be a Stream-like object.
Reader, Writer must be factory functions or classes
providing the StreamReader, StreamWriter interface resp.
Error handling is done in the same way as defined for the
StreamWriter/Readers.
2014-07-10 23:57:08 +08:00
N( <00> <> <69> <EFBFBD> <EFBFBD> c <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00>
( <00> <00> <00> <00> <> <00> <00> <00> <00> <00>
2014-07-09 18:15:23 +08:00
<00>
<00> <00> <00> <00> <00> <00>
view of encoding data.
They use the complete set of APIs returned by the
codecs.lookup() function to implement their task.
Data written to the stream is first decoded into an
intermediate format (which is dependent on the given codec
combination) and then written to the stream using an instance
of the provided Writer class.
In the other direction, data is read from the stream using a
Reader instance and then return encoded data to the caller.
Rv <00> <00> <>
conversion: encode and decode work on the frontend (the
input to .read() and output of .write()) while
Reader and Writer work on the backend (reading and
writing to the stream).
You can use these objects to do transparent direct
recodings from e.g. latin-1 to utf-8 and back.
stream must be a file-like object.
encode, decode must adhere to the Codec interface, Reader,
Writer must be factory functions or classes providing the
StreamReader, StreamWriter interface resp.
encode and decode are needed for the frontend translation,
Reader and Writer for the backend translation. Unicode is
used as intermediate encoding.
Error handling is done in the same way as defined for the
StreamWriter/Readers.
2014-07-10 23:57:08 +08:00
N( <00> <> <69> <EFBFBD> <EFBFBD> c <00> <00> <00> <00> <00>
<00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00> <00>
( <00> <00> <> <00> <00> <00> <00> <> <00> <00>
2014-07-09 18:15:23 +08:00
<>
a wrapped version providing transparent encoding/decoding.
Note: The wrapped version will only accept the object format
defined by the codecs, i.e. Unicode objects for most builtin
codecs. Output is also codec dependent and will usually be
Unicode as well.
Files are always opened in binary mode, even if no binary mode
was specified. This is done to avoid data loss due to encodings
using 8-bit values. The default file mode is 'rb' meaning to
open the file in binary read mode.
encoding specifies the encoding which is to be used for the
file.
errors may be given to define the error handling. It defaults
to 'strict' which causes ValueErrors to be raised in case an
encoding error occurs.
buffering has the same meaning as for the builtin open() API.
It defaults to line buffered.
The returned wrapped file object provides an extra attribute
.encoding which allows querying the used encoding. This
attribute is only available if an encoding was specified as
parameter.
2014-07-10 23:57:08 +08:00
t <00> <00> <00> <>
2014-07-09 18:15:23 +08:00
encoding translation.
Strings written to the wrapped file are interpreted according
to the given data_encoding and then written to the original
file as string using file_encoding. The intermediate encoding
will usually be Unicode but depends on the specified codecs.
Strings are read from the file using file_encoding and then
passed back to the caller as string using data_encoding.
If file_encoding is not given, it defaults to data_encoding.
errors may be given to define the error handling. It defaults
to 'strict' which causes ValueErrors to be raised in case an
encoding error occurs.
The returned wrapped file object provides two extra attributes
.data_encoding and .file_encoding which reflect the given
parameters of the same name. The attributes can be used for
introspection by Python programs.
2014-07-10 23:57:08 +08:00
N( <> <> <> <00> <>
2014-07-09 18:15:23 +08:00
its encoder function.
Raises a LookupError in case the encoding cannot be found.
2014-07-10 23:57:08 +08:00
(
2014-07-09 18:15:23 +08:00
<65> <00> <>
its decoder function.
Raises a LookupError in case the encoding cannot be found.
2014-07-10 23:57:08 +08:00
(
2014-07-09 18:15:23 +08:00
<65> <00> <00> <00> <>
its IncrementalEncoder class or factory function.
Raises a LookupError in case the encoding cannot be found
or the codecs doesn't provide an incremental encoder.
2014-07-10 23:57:08 +08:00
N( <65> <00> <00> <00> <>
2014-07-09 18:15:23 +08:00
its IncrementalDecoder class or factory function.
Raises a LookupError in case the encoding cannot be found
or the codecs doesn't provide an incremental decoder.
2014-07-10 23:57:08 +08:00
N( <> <65> <00> <>
2014-07-09 18:15:23 +08:00
its StreamReader class or factory function.
Raises a LookupError in case the encoding cannot be found.
2014-07-10 23:57:08 +08:00
( <65> <00> <>
2014-07-09 18:15:23 +08:00
its StreamWriter class or factory function.
Raises a LookupError in case the encoding cannot be found.
2014-07-10 23:57:08 +08:00
( <65> <00> <00> <00> <00> <>
2014-07-09 18:15:23 +08:00
Encoding iterator.
Encodes the input strings from the iterator using a IncrementalEncoder.
errors and kwargs are passed through to the IncrementalEncoder
constructor.
2014-07-10 23:57:08 +08:00
R4 <> <73>
2014-07-09 18:15:23 +08:00
<64> <00> <00> <00> <00> <>
Decoding iterator.
Decodes the input strings from the iterator using a IncrementalDecoder.
errors and kwargs are passed through to the IncrementalDecoder
constructor.
2014-07-10 23:57:08 +08:00
R4 <> <> <> <> <>
2014-07-09 18:15:23 +08:00
<64> <>
Return a dictionary where elements of the rng sequence are
mapped to themselves.
2014-07-10 23:57:08 +08:00
( <00> <>
2014-07-09 18:15:23 +08:00
If a target mapping in the decoding map occurs multiple
times, then that target is mapped to None (undefined mapping),
causing an exception when encountered by the charmap codec
during translation.
One example where this happens is cp875.py which decodes
multiple character to \u001a.
2014-07-10 23:57:08 +08:00
N( <65> <>
<> <> <> <> <> <> <> <> <> <> <73> <>
2014-07-09 18:15:23 +08:00
<16>
