diff options
Diffstat (limited to 'html/SmootLight.util.Config-module.html')
| -rw-r--r-- | html/SmootLight.util.Config-module.html | 496 |
1 files changed, 496 insertions, 0 deletions
diff --git a/html/SmootLight.util.Config-module.html b/html/SmootLight.util.Config-module.html new file mode 100644 index 0000000..1297bbc --- /dev/null +++ b/html/SmootLight.util.Config-module.html @@ -0,0 +1,496 @@ +<?xml version="1.0" encoding="ascii"?> +<!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>SmootLight.util.Config</title> + <link rel="stylesheet" href="epydoc.css" type="text/css" /> + <script type="text/javascript" src="epydoc.js"></script> +</head> + +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="SmootLight-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <th class="navbar" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + <a href="SmootLight-module.html">Package SmootLight</a> :: + <a href="SmootLight.util-module.html">Package util</a> :: + Module Config + </span> + </td> + <td> + <table cellpadding="0" cellspacing="0"> + <!-- hide/show private --> + <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" + onclick="toggle_private();">hide private</a>]</span></td></tr> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="SmootLight.util.Config-module.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== MODULE DESCRIPTION ==================== --> +<h1 class="epydoc">Module Config</h1><p class="nomargin-top"><span class="codelink"><a href="SmootLight.util.Config-pysrc.html">source code</a></span></p> +<!-- ==================== FUNCTIONS ==================== --> +<a name="section-Functions"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Functions</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Functions" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="loadParamRequirementDict"></a><span class="summary-sig-name">loadParamRequirementDict</span>(<span class="summary-sig-arg">className</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#loadParamRequirementDict">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="SmootLight.util.Config-module.html#loadConfigFile" class="summary-sig-name">loadConfigFile</a>(<span class="summary-sig-arg">fileName</span>)</span><br /> + Loads a config file.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#loadConfigFile">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="SmootLight.util.Config-module.html#getElement" class="summary-sig-name">getElement</a>(<span class="summary-sig-arg">el</span>)</span><br /> + Takes an Element or an ElementTree.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#getElement">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="SmootLight.util.Config-module.html#compositeXMLTrees" class="summary-sig-name">compositeXMLTrees</a>(<span class="summary-sig-arg">parentTree</span>, + <span class="summary-sig-arg">overridingTree</span>)</span><br /> + XML tree composition.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#compositeXMLTrees">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="findElementsByTag"></a><span class="summary-sig-name">findElementsByTag</span>(<span class="summary-sig-arg">tag</span>, + <span class="summary-sig-arg">eList</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#findElementsByTag">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="fileToDict"></a><span class="summary-sig-name">fileToDict</span>(<span class="summary-sig-arg">fileName</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#fileToDict">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="pullArgsFromItem"></a><span class="summary-sig-name">pullArgsFromItem</span>(<span class="summary-sig-arg">parentNode</span>)</span><br /> + Parses arguments into python objects if possible, otherwise leaves as + strings</td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#pullArgsFromItem">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="SmootLight.util.Config-module.html#attemptEval" class="summary-sig-name">attemptEval</a>(<span class="summary-sig-arg">val</span>)</span><br /> + Runs an eval if possible, or converts into a lambda expression if + indicated.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#attemptEval">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="generateArgDict"></a><span class="summary-sig-name">generateArgDict</span>(<span class="summary-sig-arg">parentNode</span>, + <span class="summary-sig-arg">recurse</span>=<span class="summary-sig-default">False</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#generateArgDict">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="SmootLight.util.Config-module.html#resolveDocumentInheritances" class="summary-sig-name">resolveDocumentInheritances</a>(<span class="summary-sig-arg">el</span>)</span><br /> + In place resolution of document inheritances.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#resolveDocumentInheritances">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="SmootLight.util.Config-module.html#resolveInheritance" class="summary-sig-name">resolveInheritance</a>(<span class="summary-sig-arg">el</span>)</span><br /> + In place resolution of inheritence.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.util.Config-pysrc.html#resolveInheritance">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +</table> +<!-- ==================== VARIABLES ==================== --> +<a name="section-Variables"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Variables</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Variables" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a name="classArgsMem"></a><span class="summary-name">classArgsMem</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code> + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a name="CONFIG_PATH"></a><span class="summary-name">CONFIG_PATH</span> = <code title="'config/'"><code class="variable-quote">'</code><code class="variable-string">config/</code><code class="variable-quote">'</code></code> + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a name="DEFAULT_OVERRIDE_MODE"></a><span class="summary-name">DEFAULT_OVERRIDE_MODE</span> = <code title="'Merge'"><code class="variable-quote">'</code><code class="variable-string">Merge</code><code class="variable-quote">'</code></code> + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'SmootLight.util'"><code class="variable-quote">'</code><code class="variable-string">SmootLight.util</code><code class="variable-quote">'</code></code> + </td> + </tr> +</table> +<!-- ==================== FUNCTION DETAILS ==================== --> +<a name="section-FunctionDetails"></a> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Function Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-FunctionDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="loadConfigFile"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">loadConfigFile</span>(<span class="sig-arg">fileName</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="SmootLight.util.Config-pysrc.html#loadConfigFile">source code</a></span> + </td> + </tr></table> + + <p>Loads a config file. If its an xml file, inheritances are + automatically resolved.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="getElement"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">getElement</span>(<span class="sig-arg">el</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="SmootLight.util.Config-pysrc.html#getElement">source code</a></span> + </td> + </tr></table> + + <p>Takes an Element or an ElementTree. If it is a tree, it returns its + root. Otherwise, just returns it</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="compositeXMLTrees"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">compositeXMLTrees</span>(<span class="sig-arg">parentTree</span>, + <span class="sig-arg">overridingTree</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="SmootLight.util.Config-pysrc.html#compositeXMLTrees">source code</a></span> + </td> + </tr></table> + + <p>XML tree composition. Returns the resulting tree, but happens + in-place in the overriding tree.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="attemptEval"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">attemptEval</span>(<span class="sig-arg">val</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="SmootLight.util.Config-pysrc.html#attemptEval">source code</a></span> + </td> + </tr></table> + + <p>Runs an eval if possible, or converts into a lambda expression if + indicated. Otherwise, leaves as a string.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="resolveDocumentInheritances"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">resolveDocumentInheritances</span>(<span class="sig-arg">el</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="SmootLight.util.Config-pysrc.html#resolveDocumentInheritances">source code</a></span> + </td> + </tr></table> + + <p>In place resolution of document inheritances. Doesn't return + anything.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="resolveInheritance"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">resolveInheritance</span>(<span class="sig-arg">el</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="SmootLight.util.Config-pysrc.html#resolveInheritance">source code</a></span> + </td> + </tr></table> + + <p>In place resolution of inheritence. Doesn't return anything.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="SmootLight-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <th class="navbar" width="100%"></th> + </tr> +</table> +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> + <tr> + <td align="left" class="footer"> + Generated by Epydoc 3.0.1 on Fri Feb 18 16:55:25 2011 + </td> + <td align="right" class="footer"> + <a target="mainFrame" href="http://epydoc.sourceforge.net" + >http://epydoc.sourceforge.net</a> + </td> + </tr> +</table> + +<script type="text/javascript"> + <!-- + // Private objects are initially displayed (because if + // javascript is turned off then we want them to be + // visible); but by default, we want to hide them. So hide + // them unless we have a cookie that says to show them. + checkCookie(); + // --> +</script> +</body> +</html> |