taurus taurus

Previous topic

AttributeEventWait

Next topic

BoundMethodWeakref

This Page

BZ2Codec

Inheritance diagram of BZ2Codec

class BZ2Codec

Bases: taurus.core.util.codecs.Codec

A codec able to encode/decode to/from BZ2 format. It uses the bz2 module

Example:

>>> from taurus.core.util import CodecFactory

>>> # first encode something
>>> data = 100 * "Hello world\n"
>>> cf = CodecFactory()
>>> codec = cf.getCodec('bz2')
>>> format, encoded_data = codec.encode(("", data))
>>> print len(data), len(encoded_data)
1200, 68
>>> format, decoded_data = codec.decode((format, encoded_data))
>>> print decoded_data[20]
'Hello world\nHello wo'
decode(data, *args, **kwargs)

decodes the given data from a bz2 string.

Parameters:data (:class:~`sequence[str, obj]`) – a sequence of two elements where the first item is the encoding format of the second item object
Return type::class:~`sequence[str, obj]`
Returns:a sequence of two elements where the first item is the encoding format of the second item object
encode(data, *args, **kwargs)

encodes the given data to a bz2 string. The given data must be a string

Parameters:data (:class:~`sequence[str, obj]`) – a sequence of two elements where the first item is the encoding format of the second item object
Return type::class:~`sequence[str, obj]`
Returns:a sequence of two elements where the first item is the encoding format of the second item object