pyzim.blob.FileBlob

class documentation

class FileBlob(BaseBlob):

Constructor: FileBlob(path)

A BaseBlob used by FileBlobSource for file blobs.

Method	`__init__`	The default constructor.
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.
Instance Variable	`_f`	file-like object handling the data
Instance Variable	`_path`	path to file
Instance Variable	`_size`	size of the file/blob

def __init__(self, path): ¶

The default constructor.

Parameters
path:`str`	path to file

def close(self): ¶

overrides pyzim.blob.BaseBlob.close

Called when this blob is no longer needed.

Use this method to clean up any associated resources.

def get_size(self): ¶

overrides pyzim.blob.BaseBlob.get_size

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): ¶

overrides pyzim.blob.BaseBlob.read

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

_f: file-like = ¶

file-like object handling the data

_path: str = ¶

path to file

_size: int = ¶

size of the file/blob