pyzim.compression.ZlibCompressionInterface

class documentation

class ZlibCompressionInterface(BaseCompressionInterface):

View In Hierarchy

A pyzim.compression.BaseCompressionInterface for zlib compression.

The following options are supported:

  • zlib.memlevel (default: zlib.DEF_MEM_LEVEL, set automatically when required by target): zlib memory level to use (only for compression)
  • zlib.wbits (default: zlib.MAX_WBITS, set automatically when required by target): zlib window size to use
  • zlib.method (default: zlib.DEFLATED): compression algorithm to use (only for compression)
  • zlib.strategy (default: Z_DEFAULT_STRATEGY): zlib strategy for the compression algorithm (only for compression)
  • zdict (default: None): predefined compression dictionary to use.
Static Method get_compressor Return a compressor object which can be used to compress data.
Static Method get_decompressor Return a decompressor object which can be used to decompress data.

Inherited from BaseCompressionInterface:

Class Variable compression_type compression type used by this interface
def get_compressor(options={}):
overrides pyzim.compression.BaseCompressionInterface.get_compressor

Return a compressor object which can be used to compress data.

Parameters
options:dictadditional options for the compressor.
Returns
a compressor-like object. See pyzim.compression.BaseCompressionInterface for more info.a compressor object
def get_decompressor(options={}):
overrides pyzim.compression.BaseCompressionInterface.get_decompressor

Return a decompressor object which can be used to decompress data.

Parameters
options:dictadditional options for the decompressor.
Returns
a decompressor-like object. See pyzim.compression.BaseCompressionInterface for more info.a decompressor object