pyzim.compressionstrategy.SimpleCompressionStrategy

class documentation

class SimpleCompressionStrategy(BaseCompressionStrategy):

A compression strategy that compresses into a single cluster.

New clusters are created if the current cluster's uncompressed size would exceed SimpleCompressionStrategy.max_size.

Method	`__init__`	The default constructor.
Method	`add_item`	Handle the addition of an item (e.g. create entries, ...).
Method	`flush`	Flush all current items.
Method	`has_items`	True if this compression strategy still has items to be written.
Instance Variable	`cluster`	current cluster
Instance Variable	`compression_type`	compression type to use
Instance Variable	`entries`	list of entries to compress
Instance Variable	`max_size`	max (uncompressed) size the cluster should have. This may be exceeded.
Method	`_finalize_current_cluster`	Finalize the current cluster, writing it and the various items.
Method	`_new_cluster`	Instantiate a new cluster.
Method	`_new_cluster_needed`	Check if a new cluster is needed for the item.
Instance Variable	`_lock`	thread safety lock

Instance Variable zim zim archive this compression strategy compresses for

def __init__(self, zim, compression_type, max_size=2 * 1024 * 1024): ¶

overrides pyzim.compressionstrategy.BaseCompressionStrategy.__init__

The default constructor.

Parameters
zim:`pyzim.archive.Zim`	zim archive this compression strategy compresses for
compression_type:`pyzim.compression.CompressionType`	compression type to use
max_size:`int`	max (uncompressed) size the cluster should have. This may be exceeded.

def add_item(self, item): ¶

overrides pyzim.compressionstrategy.BaseCompressionStrategy.add_item

Handle the addition of an item (e.g. create entries, ...).

Parameters
item:`pyzim.item.Item`	item to add

def flush(self): ¶

overrides pyzim.compressionstrategy.BaseCompressionStrategy.flush

Flush all current items.

This should create and flush all remaining clusters and entries.

def has_items(self): ¶

overrides pyzim.compressionstrategy.BaseCompressionStrategy.has_items

True if this compression strategy still has items to be written.

Returns
`bool`	whether there are some items that still need to be written

cluster: pyzim.cluster.ModifiableClusterWrapper = ¶

current cluster

compression_type: pyzim.compression.CompressionType = ¶

compression type to use

entries: list of pyzim.entry.BaseEntry = ¶

list of entries to compress

max_size: int = ¶

max (uncompressed) size the cluster should have. This may be exceeded.

def _finalize_current_cluster(self): ¶

Finalize the current cluster, writing it and the various items.

def _new_cluster(self): ¶

Instantiate a new cluster.

The new cluster is in SimpleCompressionStrategy.cluster. This method does not take care of flushing the previous cluster.

def _new_cluster_needed(self, item): ¶

Check if a new cluster is needed for the item.

Parameters
item:`pyzim.item.Item`	item to check

Returns
`bool`	True if the current cluster should be finalized.

_lock: threading.Lock = ¶

thread safety lock