encodings.charmap
index
/usr/local/lib/python2.4/encodings/charmap.py
Module Docs

Generic Python Character Mapping Codec.
 
    Use this codec directly rather than through the automatic
    conversion mechanisms supplied by unicode() and .encode().
 
 
Written by Marc-Andre Lemburg (mal@lemburg.com).
 
(c) Copyright CNRI, All Rights Reserved. NO WARRANTY.

 
Modules
       
codecs

 
Classes
       
codecs.Codec
Codec
StreamReader(Codec, codecs.StreamReader)
StreamWriter(Codec, codecs.StreamWriter)

 
class Codec(codecs.Codec)
     Data and other attributes defined here:
decode = <built-in function charmap_decode>
encode = <built-in function charmap_encode>

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

Methods defined here:
__init__(self, stream, errors='strict', mapping=None)
decode(self, input, errors='strict')

Data and other attributes inherited from Codec:
encode = <built-in function charmap_encode>

Methods inherited from codecs.StreamReader:
__getattr__(self, name, getattr=<built-in function getattr>)
Inherit all other methods from the underlying stream.
__iter__(self)
next(self)
Return the next decoded line from the input stream.
read(self, size=-1, chars=-1)
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.
 
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.

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

Methods defined here:
__init__(self, stream, errors='strict', mapping=None)
encode(self, input, errors='strict')

Data and other attributes inherited from Codec:
decode = <built-in function charmap_decode>

Methods inherited from codecs.StreamWriter:
__getattr__(self, name, getattr=<built-in function getattr>)
Inherit all other methods from the underlying stream.
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().

 
Functions
       
getregentry()