pyzim.compression.LzmaCompressionInterface

class documentation

class LzmaCompressionInterface(BaseCompressionInterface):

View In Hierarchy

A pyzim.compression.BaseCompressionInterface for lzma compression.

The following options are supported:

  • lzma.format (default: lzma.FORMAT_XZ for compression, lzma.FORMAT_AUTO for decompression): lzma format to use
  • lzma.check (default: lzma.CHECK_NONE): integrity check to use (only for compression)
  • lzma.filters: (default: None): custom filters to use
  • lzma.memlimit: memory limit for decompression (default: None)
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