zms._exportable

module documentation

(source)

_exportable.py - ZMS Exportable Mixin

This module implements the Exportable mixin, which provides methods for exporting Zope objects to the filesystem, including binary files, images, and folder structures. It handles encoding, file writing, and recursive export of folder contents. The module also includes helper functions for localizing HTML content and managing export paths. The Exportable mixin can be used by ZMS content classes to enable export functionality.

License: GNU General Public License v2 or later, Organization: ZMS Publishing

Class	`Exportable`	Mixin that provides XML, HTML, and archive export helpers.
Function	`exportFiles`	Export binary file and image objects from a folder to the filesystem.
Function	`exportFolder`	Recursively export a Zope folder and its renderable objects.
Function	`findDelimiter`	Find the first occurrence of any delimiter in a string.
Function	`localHtml`	Convert rendered HTML to the charset configured for the request.
Function	`localIndexHtml`	Rewrite exported markup so links resolve in static HTML archives.
Function	`rfindDelimiter`	Find the last occurrence of any delimiter in a string.
Function	`writeFile`	Write export data to disk using the preferred encoding.

def exportFiles(self, root, id, path): (source) ¶

Export binary file and image objects from a folder to the filesystem.

Parameters
self	Undocumented
root:`OFS.ObjectManager.ObjectManager`	Container holding the exported folder.
id:`str`	Folder id on the container.
path:`str`	Destination directory.

def exportFolder(self, root, path, id, REQUEST, depth=0): (source) ¶

Recursively export a Zope folder and its renderable objects.

Parameters
self	Undocumented
root:`OFS.ObjectManager.ObjectManager`	Parent folder that contains the exported folder.
path:`str`	Base export directory.
id:`str`	Folder id to export.
REQUEST:`ZPublisher.HTTPRequest`	Current request used to render templates.
depth:`int`	Additional relative path depth for nested exports.

def findDelimiter(s, delimiters=['"', '\'']): (source) ¶

Find the first occurrence of any delimiter in a string.

Parameters
s:`str`	Text to search.
delimiters:`list`	Candidate delimiter characters.
Returns
`int`	Position of the first delimiter or `-1`.

def localHtml(self, html): (source) ¶

Convert rendered HTML to the charset configured for the request.

Parameters
self	Undocumented
html:`str` or `bytes`	Rendered markup.
Returns
`bytes` or `str`	Encoded markup.

def localIndexHtml(self, obj, level, html, xhtml=False): (source) ¶

Rewrite exported markup so links resolve in static HTML archives.

Parameters
self	Undocumented
obj:`OFS.SimpleItem.Item`	Exported content object.
level:`int`	Relative depth from the export root.
html:`str` or `bytes`	Rendered markup.
xhtml:`bool`	Flag indicating XHTML export mode.
Returns
`str`	Localized markup with rewritten links.

def rfindDelimiter(s, delimiters=['"', '\'']): (source) ¶

Find the last occurrence of any delimiter in a string.

Parameters
s:`str`	Text to search.
delimiters:`list`	Candidate delimiter characters.
Returns
`int`	Position of the last delimiter or `-1`.

def writeFile(self, filename, data, mode='w', encoding='utf-8'): (source) ¶

Write export data to disk using the preferred encoding.

Parameters
self	Undocumented
filename:`str`	Target file path.
data:`str` or `bytes`	Export payload to persist.
mode:`str`	File open mode.
encoding:`str`	Text encoding used for unicode content.