summaryrefslogtreecommitdiffstats
path: root/Lib/encodings/bz2_codec.py
diff options
context:
space:
mode:
Diffstat (limited to 'Lib/encodings/bz2_codec.py')
-rw-r--r--Lib/encodings/bz2_codec.py53
1 files changed, 39 insertions, 14 deletions
diff --git a/Lib/encodings/bz2_codec.py b/Lib/encodings/bz2_codec.py
index fd9495e..136503a 100644
--- a/Lib/encodings/bz2_codec.py
+++ b/Lib/encodings/bz2_codec.py
@@ -1,26 +1,51 @@
-"""Python 'bz2_codec' Codec - bz2 compression encoding.
+""" Python 'bz2_codec' Codec - bz2 compression encoding
-This codec de/encodes from bytes to bytes and is therefore usable with
-bytes.transform() and bytes.untransform().
+ 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).
-"""
+ Adapted by Raymond Hettinger from zlib_codec.py which was written
+ by Marc-Andre Lemburg (mal@lemburg.com).
+"""
import codecs
import bz2 # this codec needs the optional bz2 module !
### Codec APIs
-def bz2_encode(input, errors='strict'):
+def 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.
+
+ """
assert errors == 'strict'
- return (bz2.compress(input), len(input))
+ output = bz2.compress(input)
+ return (output, len(input))
-def bz2_decode(input, errors='strict'):
+def 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.
+
+ """
assert errors == 'strict'
- return (bz2.decompress(input), len(input))
+ output = bz2.decompress(input)
+ return (output, len(input))
class Codec(codecs.Codec):
+
def encode(self, input, errors='strict'):
return bz2_encode(input, errors)
def decode(self, input, errors='strict'):
@@ -57,11 +82,11 @@ class IncrementalDecoder(codecs.IncrementalDecoder):
def reset(self):
self.decompressobj = bz2.BZ2Decompressor()
-class StreamWriter(Codec, codecs.StreamWriter):
- charbuffertype = bytes
+class StreamWriter(Codec,codecs.StreamWriter):
+ pass
-class StreamReader(Codec, codecs.StreamReader):
- charbuffertype = bytes
+class StreamReader(Codec,codecs.StreamReader):
+ pass
### encodings module API