twisted.enterprise.util.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.enterprise.util</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.enterprise.html">Package enterprise</a> ::
Module util
</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.enterprise.util.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.enterprise.util</h2>
<!-- =========== 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.enterprise.util._TableInfo.html"><code>_TableInfo</code></a></b></td>
<td>(internal)</td></tr>
<tr><td width="15%">
<b><a href="twisted.enterprise.util._TableRelationship.html"><code>_TableRelationship</code></a></b></td>
<td>(Internal)</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.enterprise.util.DBError.html"><code>DBError</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.enterprise.util.html#defaultFactoryMethod" class="summary-sig-name"><code>defaultFactoryMethod</code></a>(<span class=summary-sig-arg>rowClass</span>,
<span class=summary-sig-arg>data</span>,
<span class=summary-sig-arg>kw</span>)</span></code>
<br />
Used by loadObjects to create rowObject instances.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getKeyColumn"></a><span class="summary-sig"><span class="summary-sig-name">getKeyColumn</span>(<span class=summary-sig-arg>rowClass</span>,
<span class=summary-sig-arg>name</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.enterprise.util.html#makeKW" class="summary-sig-name"><code>makeKW</code></a>(<span class=summary-sig-arg>rowClass</span>,
<span class=summary-sig-arg>args</span>)</span></code>
<br />
Utility method to construct a dictionary for the attributes of an
object from set of args.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.enterprise.util.html#quote" class="summary-sig-name"><code>quote</code></a>(<span class=summary-sig-arg>value</span>,
<span class=summary-sig-arg>typeCode</span>,
<span class=summary-sig-arg>string_escaper</span>)</span></code>
<br />
Add quotes for text types and no quotes for integer types.</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"><code>dict</code></font></td>
<td><b><a href="twisted.enterprise.util.html#dbTypeMap"><code>dbTypeMap</code></a></b> = <span title="{'real': 1, 'smallint': 1, 'float8': 1, 'varchar': 2, 'timestamp': 2, 'int': 1, 'text': 2, 'time': 2, 'bigint': 1, 'numeric': 1, 'char': 2, 'int4': 1, 'boolean': 2, 'bool': 2, 'int2': 1, 'date': 2, 'integer': 1, 'float4': 1, 'int8': 1, 'bytea': 2}"><code>{'real': 1, 'smallint': 1, 'float8': 1, 'var<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.enterprise.util.html#NOQUOTE"><code>NOQUOTE</code></a></b> = <span title="1">1 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.enterprise.util.html#USEQUOTE"><code>USEQUOTE</code></a></b> = <span title="2">2 </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="defaultFactoryMethod"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">defaultFactoryMethod</span>(<span class=sig-arg>rowClass</span>,
<span class=sig-arg>data</span>,
<span class=sig-arg>kw</span>)</span>
</h3>
Used by loadObjects to create rowObject instances.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="makeKW"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">makeKW</span>(<span class=sig-arg>rowClass</span>,
<span class=sig-arg>args</span>)</span>
</h3>
Utility method to construct a dictionary for the attributes of an
object from set of args. This also fixes the case of column names.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="quote"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">quote</span>(<span class=sig-arg>value</span>,
<span class=sig-arg>typeCode</span>,
<span class=sig-arg>string_escaper</span>=<span class=sig-default><function safe at 0x8345294></span>)</span>
</h3>
Add quotes for text types and no quotes for integer types. NOTE:
uses Postgresql type codes..
<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="dbTypeMap"></a>
<h3>dbTypeMap</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'real': 1, 'smallint': 1, 'float8': 1, 'varchar': 2, 'timestamp': 2, 'int': 1, 'text': 2, 'time': 2, 'bigint': 1, 'numeric': 1, 'char': 2, 'int4': 1, 'boolean': 2, 'bool': 2, 'int2': 1, 'date': 2, 'integer': 1, 'float4': 1, 'int8': 1, 'bytea': 2}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'bigint': 1,
'bool': 2,
'boolean': 2,
'bytea': 2,
'char': 2,
'date': 2,
'float4': 1,
'float8': 1,
<span class="variable-ellipsis">...</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="NOQUOTE"></a>
<h3>NOQUOTE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="1"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
1 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="USEQUOTE"></a>
<h3>USEQUOTE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="2"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
2 </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"> <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:17 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>