twisted.persisted.marmalade.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.persisted.marmalade</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.persisted.html">Package persisted</a> ::
Module marmalade
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.persisted.marmalade.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.persisted.marmalade</h2>
<p>Marmalade: jelly, with just a hint of bitterness.</p>
I can serialize a Python object to an XML DOM tree
(twisted.web.microdom), and therefore to XML data, similarly to
twisted.spread.jelly. Because both Python lists and DOM trees are tree
data-structures, many of the idioms used here are identical.
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.persisted.marmalade.DOMJellier.html"><code>DOMJellier</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.persisted.marmalade.DOMJellyable.html"><code>DOMJellyable</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.persisted.marmalade.DOMUnjellier.html"><code>DOMUnjellier</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.marmalade.html#getValueElement" class="summary-sig-name"><code>getValueElement</code></a>(<span class=summary-sig-arg>node</span>)</span></code>
<br />
Get the one child element of a given element.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="instance"></a><span class="summary-sig"><span class="summary-sig-name">instance</span>(<span class=summary-sig-arg>klass</span>,
<span class=summary-sig-arg>d</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.marmalade.html#jellyToDOM" class="summary-sig-name"><code>jellyToDOM</code></a>(<span class=summary-sig-arg>object</span>)</span></code>
<br />
Convert an Object into an twisted.web.microdom.Document.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.marmalade.html#jellyToXML" class="summary-sig-name"><code>jellyToXML</code></a>(<span class=summary-sig-arg>object</span>,
<span class=summary-sig-arg>file</span>)</span></code>
<br />
jellyToXML(object, [file]) -> None | string</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.marmalade.html#unjellyFromDOM" class="summary-sig-name"><code>unjellyFromDOM</code></a>(<span class=summary-sig-arg>document</span>)</span></code>
<br />
Convert an twisted.web.microdom.Document into a Python object.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.marmalade.html#unjellyFromXML" class="summary-sig-name"><code>unjellyFromXML</code></a>(<span class=summary-sig-arg>stringOrFile</span>)</span></code>
<br />
I convert a string or the contents of an XML file into a Python
object.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="getValueElement"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getValueElement</span>(<span class=sig-arg>node</span>)</span>
</h3>
<p>Get the one child element of a given element.</p>
If there is more than one child element, raises ValueError.
Otherwise, returns the value element.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="jellyToDOM"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">jellyToDOM</span>(<span class=sig-arg>object</span>)</span>
</h3>
Convert an Object into an twisted.web.microdom.Document.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="jellyToXML"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">jellyToXML</span>(<span class=sig-arg>object</span>,
<span class=sig-arg>file</span>=<span class=sig-default>None</span>)</span>
</h3>
<p>jellyToXML(object, [file]) -> None | string</p>
Converts a Python object to an XML stream. If you pass a file, the
XML will be written to that file; otherwise, a string of the XML will
be returned.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="unjellyFromDOM"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unjellyFromDOM</span>(<span class=sig-arg>document</span>)</span>
</h3>
Convert an twisted.web.microdom.Document into a Python object.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="unjellyFromXML"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unjellyFromXML</span>(<span class=sig-arg>stringOrFile</span>)</span>
</h3>
I convert a string or the contents of an XML file into a Python
object.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:06 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>