zim.export.exporters.Exporter

class documentation

class Exporter(object): (source)

Known subclasses: zim.export.exporters.files.FilesExporterBase, zim.export.exporters.mhtml.MHTMLExporter

View In Hierarchy

Base class that defines the public API for exporter objects
Method export Export pages @param pages: a PageSelection object
Method export_iter Export pages while yielding page objects that are exported for progress monitoring
def export(self, pages): (source)
Export pages
Parameters
pagesa PageSelection object
def export_iter(self, pages): (source)
overridden in zim.export.exporters.files.MultiFileExporter, zim.export.exporters.files.SingleFileExporter, zim.export.exporters.mhtml.MHTMLExporter

Export pages while yielding page objects that are exported for progress monitoring

Also note that implementations must be robust to ignore errors when exporting pages.

Parameters
pagesa PageSelection object
Unknown Field: implementation
must be implemented by subclasses