encodings.utf_8
index
/usr/local/lib/python2.5/encodings/utf_8.py
Module Docs

Python 'utf-8' Codec
 
 
Written by Marc-Andre Lemburg (mal@lemburg.com).
 
(c) Copyright CNRI, All Rights Reserved. NO WARRANTY.

 
Modules
       
codecs

 
Classes
       
codecs.BufferedIncrementalDecoder(codecs.IncrementalDecoder)
IncrementalDecoder
codecs.IncrementalEncoder(__builtin__.object)
IncrementalEncoder
codecs.StreamReader(codecs.Codec)
StreamReader
codecs.StreamWriter(codecs.Codec)
StreamWriter

 
class IncrementalDecoder(codecs.BufferedIncrementalDecoder)
    
Method resolution order:
IncrementalDecoder
codecs.BufferedIncrementalDecoder
codecs.IncrementalDecoder
__builtin__.object

Methods inherited from codecs.BufferedIncrementalDecoder:
__init__(self, errors='strict')
decode(self, input, final=False)
reset(self)

Data descriptors inherited from codecs.IncrementalDecoder:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class IncrementalEncoder(codecs.IncrementalEncoder)
    
Method resolution order:
IncrementalEncoder
codecs.IncrementalEncoder
__builtin__.object

Methods defined here:
encode(self, input, final=False)

Methods inherited from codecs.IncrementalEncoder:
__init__(self, errors='strict')
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.
reset(self)
Resets the encoder to the initial state.

Data descriptors inherited from codecs.IncrementalEncoder:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class StreamReader(codecs.StreamReader)
    
Method resolution order:
StreamReader
codecs.StreamReader
codecs.Codec

Data and other attributes defined here:
decode = <built-in function utf_8_decode>

Methods inherited from codecs.StreamReader:
__enter__(self)
__exit__(self, type, value, tb)
__getattr__(self, name, getattr=<built-in function getattr>)
Inherit all other methods from the underlying stream.
__init__(self, stream, errors='strict')
Creates a StreamReader instance.
 
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.
__iter__(self)
next(self)
Return the next decoded line from the input stream.
read(self, size=-1, chars=-1, firstline=False)
Decodes data from the stream self.stream and returns the
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.
readline(self, size=None, keepends=True)
Read one line from the input stream and return the
decoded data.
 
size, if given, is passed as size argument to the
read() method.
readlines(self, sizehint=None, keepends=True)
Read all lines available on the input stream
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.
reset(self)
Resets the codec buffers used for keeping state.
 
Note that no stream repositioning should take place.
This method is primarily intended to be able to recover
from decoding errors.
seek(self, offset, whence=0)
Set the input stream's current position.
 
Resets the codec buffers used for keeping state.

Methods inherited from codecs.Codec:
encode(self, input, errors='strict')
Encodes the object input and returns a tuple (output
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.

 
class StreamWriter(codecs.StreamWriter)
    
Method resolution order:
StreamWriter
codecs.StreamWriter
codecs.Codec

Data and other attributes defined here:
encode = <built-in function utf_8_encode>

Methods inherited from codecs.StreamWriter:
__enter__(self)
__exit__(self, type, value, tb)
__getattr__(self, name, getattr=<built-in function getattr>)
Inherit all other methods from the underlying stream.
__init__(self, stream, errors='strict')
Creates a StreamWriter instance.
 
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.
reset(self)
Flushes and resets the codec buffers used for keeping state.
 
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.
write(self, object)
Writes the object's contents encoded to self.stream.
writelines(self, list)
Writes the concatenated list of strings to the stream
using .write().

Methods inherited from codecs.Codec:
decode(self, input, errors='strict')
Decodes the object input and returns a tuple (output
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.

 
Functions
       
decode(input, errors='strict')
encode = utf_8_encode(...)
getregentry()