twisted.persisted.aot.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.aot</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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&nbsp;twisted</a> ::
        <a href="twisted.persisted.html">Package&nbsp;persisted</a> ::
        Module&nbsp;aot
      </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>&nbsp;|&nbsp;<a href="twisted.persisted.aot.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.persisted.aot</h2>

AOT: Abstract Object Trees The source-code-marshallin'est 
abstract-object-serializin'est persister this side of Marmalade!
<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.aot._NoStateObj.html"><code>_NoStateObj</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.AOTJellier.html"><code>AOTJellier</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.AOTUnjellier.html"><code>AOTUnjellier</code></a></b></td>
  <td>I handle the unjellying of an Abstract Object Tree.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.Class.html"><code>Class</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.Copyreg.html"><code>Copyreg</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.Deref.html"><code>Deref</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.Function.html"><code>Function</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.Instance.html"><code>Instance</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.InstanceMethod.html"><code>InstanceMethod</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.Module.html"><code>Module</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.Named.html"><code>Named</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.Ref.html"><code>Ref</code></a></b></td>
  <td>&nbsp;</td></tr>
</table><br />


<!-- =========== START OF EXCEPTIONS =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Exceptions</th></tr>
<tr><td width="15%">
  <b><a href="twisted.persisted.aot.NonFormattableDict.html"><code>NonFormattableDict</code></a></b></td>
  <td>A dictionary was not formattable.</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">&nbsp;</font></td>
  <td><code><a name="dictToKW"></a><span class="summary-sig"><span class="summary-sig-name">dictToKW</span>(<span class=summary-sig-arg>d</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.persisted.aot.html#getSource" class="summary-sig-name"><code>getSource</code></a>(<span class=summary-sig-arg>ao</span>)</span></code>
<br />
Pass me an AO, I'll return a nicely-formatted source 
representation.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="indentify"></a><span class="summary-sig"><span class="summary-sig-name">indentify</span>(<span class=summary-sig-arg>s</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.persisted.aot.html#jellyToAOT" class="summary-sig-name"><code>jellyToAOT</code></a>(<span class=summary-sig-arg>obj</span>)</span></code>
<br />
Convert an object to an Abstract Object Tree.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.persisted.aot.html#jellyToSource" class="summary-sig-name"><code>jellyToSource</code></a>(<span class=summary-sig-arg>obj</span>,
          <span class=summary-sig-arg>file</span>)</span></code>
<br />
Pass me an object and, optionally, a file object.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="prettify"></a><span class="summary-sig"><span class="summary-sig-name">prettify</span>(<span class=summary-sig-arg>obj</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.persisted.aot.html#unjellyFromAOT" class="summary-sig-name"><code>unjellyFromAOT</code></a>(<span class=summary-sig-arg>aot</span>)</span></code>
<br />
Pass me an Abstract Object Tree, and I'll unjelly it for you.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.persisted.aot.html#unjellyFromSource" class="summary-sig-name"><code>unjellyFromSource</code></a>(<span class=summary-sig-arg>stringOrFile</span>)</span></code>
<br />
Pass me a string of code or a filename that defines an 'app' variable 
(in terms of Abstract Objects!), and I'll execute it and unjelly the 
resulting AOT for you, returning a newly unpersisted Application 
object!</td></tr>
</table><br />


<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="twisted.persisted.aot._NoStateObj.html" 
          class="link"><code>_NoStateObj</code></a></font></td>
<td><b><a href="twisted.persisted.aot.html#NoStateObj"><code>NoStateObj</code></a></b> = <span title="&lt;twisted.persisted.aot._NoStateObj instance at 0x8acfc24&gt;"><code>&lt;twisted.persisted.aot._NoStateObj&nbsp;instance<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
<td><b><a href="twisted.persisted.aot.html#r"><code>r</code></a></b> = <span title="&lt;_sre.SRE_Pattern object at 0x8782d58&gt;"><code><span class="re"><span class="re-group">[</span>a<span class="re-group">-</span>zA<span class="re-group">-</span>Z_<span class="re-group">]</span><span class="re-group">[</span>a<span class="re-group">-</span>zA<span class="re-group">-</span>Z0<span class="re-group">-</span>9_<span class="re-group">]</span><span class="re-op">*</span><span class="re-char">$</span></span>                              </code>
</span></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="getSource"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">getSource</span>(<span class=sig-arg>ao</span>)</span>
  </h3>
  Pass me an AO, I'll return a nicely-formatted source 
  representation.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="jellyToAOT"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">jellyToAOT</span>(<span class=sig-arg>obj</span>)</span>
  </h3>
  Convert an object to an Abstract Object Tree.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="jellyToSource"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">jellyToSource</span>(<span class=sig-arg>obj</span>,
          <span class=sig-arg>file</span>=<span class=sig-default>None</span>)</span>
  </h3>
  Pass me an object and, optionally, a file object. I'll convert the 
  object to an AOT either return it (if no file was specified) or write 
  it to the file.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="unjellyFromAOT"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">unjellyFromAOT</span>(<span class=sig-arg>aot</span>)</span>
  </h3>
  Pass me an Abstract Object Tree, and I'll unjelly it for you.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="unjellyFromSource"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">unjellyFromSource</span>(<span class=sig-arg>stringOrFile</span>)</span>
  </h3>
  Pass me a string of code or a filename that defines an 'app' 
  variable (in terms of Abstract Objects!), and I'll execute it and 
  unjelly the resulting AOT for you, returning a newly unpersisted 
  Application object!
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
<br />


<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
  <th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="NoStateObj"></a>
<h3>NoStateObj</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <a href="twisted.persisted.aot._NoStateObj.html" 
          class="link"><code>_NoStateObj</code></a>

      </dd>
<span title="&lt;twisted.persisted.aot._NoStateObj instance at 0x8acfc24&gt;">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
&lt;twisted.persisted.aot._NoStateObj instance at 0x8acfc24&gt;              </pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="r"></a>
<h3>r</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>SRE_Pattern</code>

      </dd>
<span title="&lt;_sre.SRE_Pattern object at 0x8782d58&gt;">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
<span class="re"><span class="re-group">[</span>a<span class="re-group">-</span>zA<span class="re-group">-</span>Z_<span class="re-group">]</span><span class="re-group">[</span>a<span class="re-group">-</span>zA<span class="re-group">-</span>Z0<span class="re-group">-</span>9_<span class="re-group">]</span><span class="re-op">*</span><span class="re-char">$</span></span>                                                </pre>
        </td></tr></table></dd>
</span>    </dl>
  </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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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:07:50 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>