pyzim.blob.BaseBlob

class documentation

class BaseBlob(object):

Base class for blobs

A Blob provides binary content to be written to a ZIM file.

In a simplified manner, a BaseBlob behaves similiar to a file-like object.

Method	`close`	Called when this blob is no longer needed.
Method	`get_size`	Return the size of this blob.
Method	`read`	Read up to n bytes from the blob.

def close(self): ¶

overridden in pyzim.blob.EmptyBlob, pyzim.blob.EntryBlob, pyzim.blob.FileBlob, pyzim.blob.InMemoryBlob

Called when this blob is no longer needed.

Use this method to clean up any associated resources.

def get_size(self): ¶

overridden in pyzim.blob.EmptyBlob, pyzim.blob.EntryBlob, pyzim.blob.FileBlob, pyzim.blob.InMemoryBlob

Return the size of this blob.

This value should never be lower than the actual size.

Returns
`int`	the size of this blob in bytes

def read(self, n): ¶

overridden in pyzim.blob.EmptyBlob, pyzim.blob.EntryBlob, pyzim.blob.FileBlob, pyzim.blob.InMemoryBlob

Read up to n bytes from the blob.

The "n" parameter indicates the max amount of bytes that should be returned. It is meant as a mere suggestion and can safely be ignored.

This function should return an empty bytestring if all data has been read.

Returns
`bytes`	a chunk of data read from the blob