module documentation

This module contains functionality related to compression.

Class BaseCompressionInterface Base class for compression interfaces.
Class Bz2CompressionInterface A pyzim.compression.BaseCompressionInterface for lzma compression.
Class CompressionRegistry The CompressionRegistry manages the mapping of pyzim.compression.CompressionType -> pyzim.compression.BaseCompressionInterface.
Class CompressionTarget This enum provides some symbolic constants for compression targets.
Class CompressionType This enum describes the type of compression used.
Class DecompressingReader A helper class that helps with reading data selectively from a compressed stream.
Class LzmaCompressionInterface A pyzim.compression.BaseCompressionInterface for lzma compression.
Class PassthroughCompressionInterface A pyzim.compression.BaseCompressionInterface for no compression.
Class PassthroughCompressor A compressor-like object that does not compress.
Class PassthroughDecompressor A decompressor-like object that does not decompress.
Class PyZstdCompressionInterface A pyzim.compression.BaseCompressionInterface for zstd compression using pyzstd.
Class ZlibCompressionInterface A pyzim.compression.BaseCompressionInterface for zlib compression.
Class ZlibDecompressorWrapper A wrapper around zlib.decompressobj to provide additional attributes.
Class ZstandardCompressionInterface A pyzim.compression.BaseCompressionInterface for zstd compression using zstandard.
Class ZstandardDecompressorWrapper A wrapper around zstandard.ZstdDecompressionObj providing some missing functionality.