Package encodings :: Module bz2_codec
[hide private]
[frames] | no frames]

Module bz2_codec

Python 'bz2_codec' Codec - bz2 compression encoding

Unlike most of the other codecs which target Unicode, this codec will return Python string objects for both encode and decode.

Adapted by Raymond Hettinger from zlib_codec.py which was written by Marc-Andre Lemburg (mal@lemburg.com).

Classes [hide private]
Codec
IncrementalEncoder
IncrementalDecoder
StreamWriter
StreamReader
Functions [hide private]
 
bz2_encode(input, errors='strict')
Encodes the object input and returns a tuple (output object, length consumed).
 
bz2_decode(input, errors='strict')
Decodes the object input and returns a tuple (output object, length consumed).
 
getregentry()

Imports: codecs, bz2


Function Details [hide private]

bz2_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.

bz2_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.