pyzim.entry.ContentEntry

class documentation

class ContentEntry(BaseEntry):

Constructor: ContentEntry(mimetype, namespace, revision, cluster_number, ...)

An entry for actual content (e.g. an article).

Class Method	`from_file`	Read a content entry from a file.
Method	`__init__`	The default constructor.
Method	`blob_number.setter`	The number of the blob within the specified cluster where the content of this entry is stored.
Method	`cluster_number.setter`	The number of the cluster the content of this entry is stored in
Method	`get_cluster`	Get the cluster containing the blob containing the content of this entry.
Method	`get_disk_size`	Calculate the size of this object when written to a file.
Method	`get_size`	Return the (decompressed) size of the content of this entry.
Method	`iter_read`	Read the content of this entry iteratively.
Method	`read`	Read the content of this entry.
Method	`set_content`	Set the content of this entry.
Method	`to_bytes`	Serialize this entry into a bytestring and return it.
Constant	`FORMAT_NMT`	the format of this entry, excluding the mimetype
Constant	`LENGTH_NMT`	Undocumented
Class Variable	`LENGTH_FMT`	length of this entry, excluding mimetype and zero terminated parts
Property	`blob_number`	The number of the blob within the specified cluster where the content of this entry is stored.
Property	`cluster_number`	The number of the cluster the content of this entry is stored in.
Instance Variable	`_blob_number`	number of the blob within the specified cluster where the content of this entry is stored
Instance Variable	`_cluster_number`	number of the cluster the content of this entry is stored in

Inherited from BaseEntry:

Method	`after_flush_or_read`	This method should be called after this object has been read and/or flushed to disk. In other words, it should be called at least once whenever this object matches the state of the object on the disk.
Method	`flush`	Write this entry to the archive if it is dirty.
Method	`full_url.setter`	The full URL, composed of namespace and url.
Method	`is_article.setter`	Whether this entry is an article or not.
Method	`mimetype.setter`	The mimetype as a string. Only available when bound.
Method	`mimetype_id.setter`	The index of the mimetype in the mimetypelist.
Method	`namespace.setter`	The namespace this entry is part of.
Method	`parameters.setter`	The extra parameters of this entry.
Method	`remove`	Remove this entry from the archive it is bound to.
Method	`resolve`	If this entry is a redirect, follow this redirect and any subsequent redirects until a non-redirect is reached and return it. Otherwise, return this entry.
Method	`revision.setter`	The revision of the content of this entry. Unused, must be 0..
Method	`title.setter`	The title of this entry.
Method	`url.setter`	The URL of this entry.
Constant	`FORMAT_MT`	the struct format to parse the mimetype
Constant	`LENGTH_MT`	length of the mimetype part of the struct
Constant	`MIMETYPE_ID_REDIRECT`	mimetype index that identifies redirects
Instance Variable	`mimetype_id`	The index of the mimetype in the mimetypelist.
Instance Variable	`namespace`	The namespace this entry is part of.
Instance Variable	`url`	The URL of this entry.
Property	`full_url`	The full URL, composed of namespace and url.
Property	`is_article`	Whether this entry is an article or not.
Property	`is_redirect`	True if this entry is a redirect, False otherwise.
Property	`mimetype`	The mimetype as string. Only available when bound.
Property	`parameters`	The extra parameters of this entry.
Property	`revision`	The revision of the content of this entry. Unused, must be 0.
Property	`title`	The title of this entry.
Property	`unmodified_full_url`	The full URL of this entry of the time this entry was last read or flushed.
Method	`_get_mimetype_size`	Return the size of the mimetype on disk in bytes.
Instance Variable	`_force_is_article`	force-set the article state of this entry
Instance Variable	`_mimetype_id`	index of mimetype in the mimetypelist.
Instance Variable	`_namespace`	namespace this entry is part of
Instance Variable	`_old_full_url`	full URL of entry as of last read/flush
Instance Variable	`_parameters`	extra parameters. Unused, must be None.
Instance Variable	`_revision`	the revision of the content of this entry. Unused, must be 0.
Instance Variable	`_title`	title of this entry
Instance Variable	`_url`	url of this entry

Inherited from BindableMixIn (via BaseEntry):

Method	`bind`	Bind this object to a ZIM file.
Method	`unbind`	Unbind this object. Can be called multiple times.
Property	`bound`	Whether this object is bound to a ZIM file or not.
Property	`zim`	The bound ZIM archive, if any is bound. Otherwise None.
Instance Variable	`_zim`	the bound ZIM archive or None

Inherited from ModifiableMixIn (via BaseEntry, BindableMixIn):

Method	`add_submodifiable`	Add another modifiable object as a child of this one.
Method	`dirty.setter`	Setter for `ModifiableMixIn.dirty`
Method	`ensure_mutable`	If this object is non-mutable, raise an Exception.
Method	`get_initial_disk_size`	Return the size of this object on disk as it has been read.
Method	`get_unmodified_disk_size`	Return the size of this object when written to a file before any modifications has been made since the last read/flush.
Method	`mark_dirty`	Convenience function to mark this object as dirty.
Method	`remove_submodifiable`	Remove a submodifiable from this object.
Instance Variable	`dirty`	True if this object or a sub-modifiable has been modified.
Instance Variable	`mutable`	if not nonzero, prevent modifications of this object.
Instance Variable	`_dirty`	a boolean flag that's nonzero if this object has been modified
Instance Variable	`_old_disk_size`	the size of this object on disk before any modifications since the last flush/read
Instance Variable	`_submodifiables`	a list of child objects, whose dirty state will affect this objects dirty state.

@classmethod

def from_file(cls, f, mimetype=None, seek=None): ¶

overrides pyzim.entry.BaseEntry.from_file

Read a content entry from a file.

Parameters
f:file-like	file-like object to read from
mimetype:`int`	index of mimetype. If specified, do not read it from file
seek:`int` or `None`	if specified, seek this position of the file before reading

Returns
`pyzim.entry.ContentEntry`	the entry read from the file

def __init__(self, mimetype, namespace, revision, cluster_number, blob_number, url, title, parameters): ¶

overrides pyzim.entry.BaseEntry.__init__

The default constructor.

Parameters
mimetype:`int`	index of mimetype in the mimetypelist.
namespace:`str`	namespace this entry is part of
revision:`int`	the revision of the content of this entry. Unused, must be 0.
cluster_number:`int`	number of the cluster the content of this entry is stored in
blob_number:`int`	number of the blob within the specified cluster where the content of this entry is stored
url:`str`	url of this entry
title:`str`	title of this entry
parameters:`list`	extra parameters. Unused, must be empty.

@blob_number.setter

def blob_number(self, value): ¶

The number of the blob within the specified cluster where the content of this entry is stored.

Parameters
value:`int`	value to set

Raises
`TypeError`	if value is not an integer
`pyzim.exceptions.NonMutable`	if this entry is set to be inmutable.
`ValueError`	if the value is invalid (e.g. negative)

@cluster_number.setter

def cluster_number(self, value): ¶

The number of the cluster the content of this entry is stored in

Parameters
value:`int`	value to set

Raises
`TypeError`	if value is not an integer
`pyzim.exceptions.NonMutable`	if this entry is set to be inmutable.
`ValueError`	if the value is invalid (e.g. negative)

def get_cluster(self): ¶

Get the cluster containing the blob containing the content of this entry.

Returns
`pyzim.cluster.Cluster`	the cluster, which contains the blob that contains the content of this entry

Raises
`pyzim.exceptions.BindRequired`	when not bound

def get_disk_size(self): ¶

overrides pyzim.entry.BaseEntry.get_disk_size

Calculate the size of this object when written to a file.

NOTE: in this context, size refers to the direct size of the object. If this object contains references to other objects, their sizes will not be included. For example, a pyzim.entry.ContentEntry also links to a blob, but this function will only return the size of the entry itself, excluding the referenced blob.

Returns
`int`	the size, in bytes

def get_size(self): ¶

Return the (decompressed) size of the content of this entry.

Returns
`int`	the size of the content of this entry

Raises
`pyzim.exceptions.BindRequired`	when not bound

def iter_read(self, buffersize=4096, start=None, end=None): ¶

Read the content of this entry iteratively.

The parameters 'start' and 'end' can be used to specify a range within the content of the entry to read. In this case, both values are interpreted relative to the actual blob start. Similar to how python slices work, the 'start' value will be inclusive and the 'end' value exclusive. If start >= size of the blob, the return value will be b"". If the end lies outside the blob, read only up until the end of the blob.

Parameters
buffersize:`int`	number of bytes to read at once
start	Undocumented
end	Undocumented

Yields
`bytes`	chunks of the content of this entry in sequential order

Raises
`pyzim.exceptions.BindRequired`	when not bound
`TypeError`	on invalid parameter type
`ValueError`	on invalid parameter value

def read(self, start=None, end=None): ¶

Read the content of this entry.

Parameters
start:`None` or `int`	if specified, the offset relative to the start of the blob to start reading from
end:`None` or `int`	if specified, the offset relative to the start of the blob to stop reading at

Returns
`bytes`	the content of this entry

Raises
`pyzim.exceptions.BindRequired`	when not bound
`TypeError`	on invalid parameter type
`ValueError`	on invalid parameter value

def set_content(self, blob_source): ¶

Set the content of this entry.

This method does not flush the modified cluster, but it does return the cluster, so you can just call .flush() on this.

Parameters
blob_source:`pyzim.blob.BaseBlobSource` or `str` or `bytes`	blob source or str/bytes to use as content

Returns
`pyzim.cluster.ModifiableClusterWrapper`	the cluster this blob is part of

Raises
`TypeError`	on invalid type
`pyzim.exceptions.BindRequired`	when not bound
`pyzim.exceptions.NonMutable`	if this entry is set to be inmutable.

def to_bytes(self): ¶

overrides pyzim.entry.BaseEntry.to_bytes

Serialize this entry into a bytestring and return it.

Returns
`bytes`	a bytestring representing the content of this entry.

FORMAT_NMT: str = ¶

the format of this entry, excluding the mimetype

Value

constants.ENDIAN + 'BcIII'

LENGTH_NMT = ¶

Undocumented

Value

struct.calcsize(FORMAT_NMT)

LENGTH_FMT: int = ¶

length of this entry, excluding mimetype and zero terminated parts

@property

blob_number: int = ¶

The number of the blob within the specified cluster where the content of this entry is stored.

@property

cluster_number: int = ¶

The number of the cluster the content of this entry is stored in.

_blob_number: int = ¶

number of the blob within the specified cluster where the content of this entry is stored

_cluster_number: int = ¶

number of the cluster the content of this entry is stored in