PyZim API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Class Hierarchy

  • enum.IntEnum
    • pyzim.compression.CompressionTarget - This enum provides some symbolic constants for compression targets.
    • pyzim.compression.CompressionType - This enum describes the type of compression used.
  • Exception
    • pyzim.exceptions.BaseZimException - Base class for all ZIM-related exceptions.
      • pyzim.exceptions.BindingError - Baseclass for exceptions caused by binding-related functionality.
        • pyzim.exceptions.AlreadyBound - Exception raised when attempting to bind an already bound object.
        • pyzim.exceptions.BindRequired - Exception raised when an operation requiring a bound object is performed on an unbound object.
      • pyzim.exceptions.BlobNotFound - Exception raised when a blob was not found inside a cluster.
      • pyzim.exceptions.EntryNotFound - Exception raised when an entry was not found.
      • pyzim.exceptions.IncompatibleZimFile - Exception raised when a ZIM file is not compatible.
        • pyzim.exceptions.UnsupportedCompressionType - Exception raised when no compressor/decompressor is known for a specific compression type.
      • pyzim.exceptions.NoCounter - Exception raised when the counter could not be loaded.
      • pyzim.exceptions.NotAZimFile - Exception raised when a file does not appear to be a ZIM file.
      • pyzim.exceptions.OperationNotSupported - Exception raised when a class does not support an operation.
        • pyzim.exceptions.MissingDependency - Exception raised when a missing dependency prevents a feature from working.
        • pyzim.exceptions.NonMutable - Exception raised when a non-mutable/non-modifiable object is modified.
      • pyzim.exceptions.ParseError - Exception raised when a parsing failed!
      • pyzim.exceptions.UnsortedList - Exception raised when a list is not sorted even though it is supposed to be.
      • pyzim.exceptions.ZimFeatureMissing - Exception raised when a ZIM does not provide a feature.
      • pyzim.exceptions.ZimFileClosed - Exception raised when trying to operate on a closed ZIM file.
      • pyzim.exceptions.ZimWriteException - Baseclass for exception related to ZIM creation/modification.
        • pyzim.exceptions.NonMutable - Exception raised when a non-mutable/non-modifiable object is modified.
        • pyzim.exceptions.UnresolvedRedirect - Exception raised when a redirect can not be resolved during writing.
  • object
    • pyzim.bindable.BindableMixIn - A mix-in class for making objects bindable.
      • pyzim.cluster.Cluster - Implementation of a cluster in a ZIM file.
        • pyzim.cluster.EmptyCluster - A special type of pyzim.cluster.Cluster that is always empty.
        • pyzim.cluster.ModifiableClusterWrapper - A special type of cluster that wraps another cluster and adds methods for modifying the cluster.
        • pyzim.cluster.OffsetRememberingCluster - A variation of Cluster that reads offsets only once, storing them in memory.
          • pyzim.cluster.InMemoryCluster - A variation of Cluster that decompresses only once, storing all data in RAM.
      • pyzim.entry.BaseEntry - Baseclass for entries in a ZIM file.
        • pyzim.entry.ContentEntry - An entry for actual content (e.g. an article).
        • pyzim.entry.RedirectEntry - An entry for a redirect.
      • pyzim.spaceallocator.SpaceAllocator - The SpaceAllocator is used to manage the space inside a ZIM file.
    • pyzim.blob.BaseBlob - Base class for blobs
      • pyzim.blob.EmptyBlob - A BaseBlob used by EmptyBlobSource for empty blobs.
      • pyzim.blob.EntryBlob - A BaseBlob used by EntryBlobSource.
      • pyzim.blob.FileBlob - A BaseBlob used by FileBlobSource for file blobs.
      • pyzim.blob.InMemoryBlob - A BaseBlob used by InMemoryBlobSource for in-memory blobs.
    • pyzim.blob.BaseBlobSource - Base class for blob sources.
      • pyzim.blob.EmptyBlobSource - A BaseBlobSource for empty blobs.
      • pyzim.blob.EntryBlobSource - A BaseBlobSource that provides the content from an entry.
      • pyzim.blob.FileBlobSource - A BaseBlobSource for reading a blob from a file.
      • pyzim.blob.InMemoryBlobSource - A BaseBlobSource implementation for in-memory blobs.
    • pyzim.cache._DoubleLinkedList - A double linkked list used by the LRU cache.
    • pyzim.cache._DoubleLinkedListElement - An element in a double linked list used by the LRU cache.
    • pyzim.cache.BaseCache - Base class for caches.
      • pyzim.cache.HybridCache - A pyzim.cache.BaseCache that internally utilizes both a pyzim.cache.LastAccessCache and a pyzim.cache.TopAccessCache.
      • pyzim.cache.LastAccessCache - A BaseCache implementation that caches by last access.
      • pyzim.cache.NoOpCache - A BaseCache implementation that does not cache.
      • pyzim.cache.TopAccessCache - A BaseCache implementation that caches by most accessed.
    • pyzim.compression.BaseCompressionInterface - Base class for compression interfaces.
      • pyzim.compression.Bz2CompressionInterface - A pyzim.compression.BaseCompressionInterface for lzma compression.
      • pyzim.compression.LzmaCompressionInterface - A pyzim.compression.BaseCompressionInterface for lzma compression.
      • pyzim.compression.PassthroughCompressionInterface - A pyzim.compression.BaseCompressionInterface for no compression.
      • pyzim.compression.PyZstdCompressionInterface - A pyzim.compression.BaseCompressionInterface for zstd compression using pyzstd.
      • pyzim.compression.ZlibCompressionInterface - A pyzim.compression.BaseCompressionInterface for zlib compression.
      • pyzim.compression.ZstandardCompressionInterface - A pyzim.compression.BaseCompressionInterface for zstd compression using zstandard.
    • pyzim.compression.CompressionRegistry - The CompressionRegistry manages the mapping of pyzim.compression.CompressionType -> pyzim.compression.BaseCompressionInterface.
    • pyzim.compression.DecompressingReader - A helper class that helps with reading data selectively from a compressed stream.
    • pyzim.compression.PassthroughCompressor - A compressor-like object that does not compress.
    • pyzim.compression.PassthroughDecompressor - A decompressor-like object that does not decompress.
    • pyzim.compression.ZlibDecompressorWrapper - A wrapper around zlib.decompressobj to provide additional attributes.
    • pyzim.compression.ZstandardDecompressorWrapper - A wrapper around zstandard.ZstdDecompressionObj providing some missing functionality.
    • pyzim.compressionstrategy.BaseCompressionStrategy - Baseclass for compression strategies.
      • pyzim.compressionstrategy.MimetypeBasedCompressionStrategy - A compression strategy utilizing mimetypes.
      • pyzim.compressionstrategy.SimpleCompressionStrategy - A compression strategy that compresses into a single cluster.
    • pyzim.item.Item - An item is a helper for simplifying the addition of new content to a ZIM.
    • pyzim.modifiable.ModifiableMixIn - A mix-in class for modifiable objects.
      • pyzim.archive.Zim - A ZIM archive.
      • pyzim.cluster.ModifiableClusterWrapper - A special type of cluster that wraps another cluster and adds methods for modifying the cluster.
      • pyzim.counter.Counter - The counter keeps track of how many entries of each mimetype there is.
      • pyzim.entry.BaseEntry - Baseclass for entries in a ZIM file.
        • pyzim.entry.ContentEntry - An entry for actual content (e.g. an article).
        • pyzim.entry.RedirectEntry - An entry for a redirect.
      • pyzim.header.Header - The header of a ZIM file.
      • pyzim.mimetypelist.MimeTypeList - This class represents a MIME type list.
      • pyzim.pointerlist.SimplePointerList - A pointer list of a ZIM file.
        • pyzim.pointerlist.OnDiskSimplePointerList - A variant of SimplePointerList that reads pointers always from the disk.
          • pyzim.pointerlist.OnDiskOrderedPointerList - No class docstring; 1/1 method, 0/5 class method documented
            • pyzim.pointerlist.OnDiskTitlePointerList - A on-disk pointer list used by the ZIM title listings.
        • pyzim.pointerlist.OrderedPointerList - An ordered pointer list of a ZIM file.
          • pyzim.pointerlist.OnDiskOrderedPointerList - No class docstring; 1/1 method, 0/5 class method documented
            • pyzim.pointerlist.OnDiskTitlePointerList - A on-disk pointer list used by the ZIM title listings.
          • pyzim.pointerlist.TitlePointerList - A pointer list used by the ZIM title listings.
            • pyzim.pointerlist.OnDiskTitlePointerList - A on-disk pointer list used by the ZIM title listings.
    • pyzim.operationbuffer.OperationBuffer - The OperationBuffer is responsible for buffering ZIM write operations until they can be completed.
    • pyzim.policy.Policy - A policy is a configuration that influences the behavior of various pyzim classes, mostly in regards to resource management.
    • pyzim.processor.BaseProcessor - Base class for processors.
      • pyzim.counter.Counter - The counter keeps track of how many entries of each mimetype there is.
    • pyzim.search.BaseSearch - Base class for search and suggestion implementations.
      • pyzim.search.TitleStartSearch - A search for finding entries whose titles start with a certain prefix.
      • pyzim.search.XapianSearch - A search for finding entries using a xapian database.
    • pyzim.search.SearchResult - A single result of a search.
    • pyzim.search.SearchResultSet - A SearchResultSet contains the SearchResults of a search as well as some result metadata like the amount of matches.
    • pyzim.util.translator.PathReaderMixIn - A mix-in class for ZimTranslator that implements reading from path.
    • pyzim.util.translator.ZimTranslator - The ZimTranslator provides functionality to "translate" one ZIM file into another.
API Documentation for PyZim, generated by pydoctor 25.10.1 at 2026-01-21 22:55:25.