encodings.zlib_codec
index
/usr/lib/python2.2/encodings/zlib_codec.py

 Python 'zlib_codec' Codec - zlib compression encoding
 
Unlike most of the other codecs which target Unicode, this codec
will return Python string objects for both encode and decode.
 
Written by Marc-Andre Lemburg (mal@lemburg.com).

 
Modules
            
codecs
zlib
 
Classes
            
codecs.Codec
Codec
StreamReader(Codec, codecs.StreamReader)
StreamWriter(Codec, codecs.StreamWriter)
 
class Codec(codecs.Codec)
       
   Methods defined here:
decode(self, input, errors='strict')
encode(self, input, errors='strict')

Data and non-method functions defined here:
__doc__ = None
__module__ = 'encodings.zlib_codec'
 
class StreamReader(Codec, codecs.StreamReader)
       
  
Method resolution order:
StreamReader
Codec
codecs.Codec
codecs.StreamReader

Data and non-method functions defined here:
__doc__ = None
__module__ = 'encodings.zlib_codec'

Methods inherited from Codec:
decode(self, input, errors='strict')
encode(self, input, errors='strict')

Methods inherited from codecs.StreamReader:
__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 implement different error handling
schemes by providing the errors keyword argument. These
parameters are defined:
 
 'strict' - raise a ValueError (or a subclass)
 'ignore' - ignore the character and continue with the next
 'replace'- replace with a suitable replacement character;
read(self, size=-1)
 Decodes data from the stream self.stream and returns the
resulting object.
 
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)
 Read one line from the input stream and return the
decoded data.
 
Note: Unlike the .readlines() method, this method inherits
the line breaking knowledge from the underlying stream's
.readline() method -- there is currently no support for
line breaking using the codec decoder due to lack of line
buffering. Sublcasses should however, if possible, try to
implement this method using their own knowledge of line
breaking.
 
size, if given, is passed as size argument to the stream's
.readline() method.
readlines(self, sizehint=0)
 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 passed as size argument to the
stream's .read() method.
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

Data and non-method functions defined here:
__doc__ = None
__module__ = 'encodings.zlib_codec'

Methods inherited from Codec:
decode(self, input, errors='strict')
encode(self, input, errors='strict')

Methods inherited from codecs.StreamWriter:
__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 implement different error handling
schemes by providing the errors keyword argument. These
parameters are defined:
 
 'strict' - raise a ValueError (or a subclass)
 'ignore' - ignore the character and continue with the next
 'replace'- replace with a suitable replacement character
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()
zlib_decode(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 which is the only currently supported
error handling for this codec.
zlib_encode(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 which is the only currently supported
error handling for this codec.
 
Data
             __file__ = '/usr/lib/python2.2/encodings/zlib_codec.pyc'
__name__ = 'encodings.zlib_codec'