476 lines
20 KiB
HTML
476 lines
20 KiB
HTML
<?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>linspector.lib.config.parser.ConfigParser</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="linspector-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="linspector-module.html">Package linspector</a> ::
|
|
<a href="linspector.lib-module.html">Package lib</a> ::
|
|
<a href="linspector.lib.config-module.html">Package config</a> ::
|
|
<a href="linspector.lib.config.parser-module.html">Module parser</a> ::
|
|
Class ConfigParser
|
|
</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="linspector.lib.config.parser.ConfigParser-class.html"
|
|
target="_top">no frames</a>]</span></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">Class ConfigParser</h1><p class="nomargin-top"><span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser">source code</a></span></p>
|
|
<dl><dt>Known Subclasses:</dt>
|
|
<dd>
|
|
<ul class="subclass-list">
|
|
<li><a href="linspector.lib.config.parser.FullConfigParser-class.html">FullConfigParser</a></li> </ul>
|
|
</dd></dl>
|
|
|
|
<hr />
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<a name="section-InstanceMethods"></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">Instance Methods</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-InstanceMethods"
|
|
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 href="linspector.lib.config.parser.ConfigParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">log</span>)</span><br />
|
|
initializes a new ConfigParser Object</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.__init__">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="private">
|
|
<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="_create_new_config_dict"></a><span class="summary-sig-name">_create_new_config_dict</span>(<span class="summary-sig-arg">self</span>)</span></td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._create_new_config_dict">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="create_config"></a><span class="summary-sig-name">create_config</span>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">config</span>)</span></td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.create_config">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="private">
|
|
<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="linspector.lib.config.parser.ConfigParser-class.html#_read_json_config" class="summary-sig-name" onclick="show_private();">_read_json_config</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">configFilename</span>)</span><br />
|
|
reads the config File and returns a dictionary, while lowering the
|
|
first keys</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._read_json_config">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="private">
|
|
<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="linspector.lib.config.parser.ConfigParser-class.html#_create_raw_Object" class="summary-sig-name" onclick="show_private();">_create_raw_Object</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">jsonDict</span>,
|
|
<span class="summary-sig-arg">msgName</span>,
|
|
<span class="summary-sig-arg">creator</span>)</span><br />
|
|
creates an Main object from the configuration, but just parses raw
|
|
data and hands it to the object</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._create_raw_Object">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="private">
|
|
<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="linspector.lib.config.parser.ConfigParser-class.html#_load_module" class="summary-sig-name" onclick="show_private();">_load_module</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">clazz</span>,
|
|
<span class="summary-sig-arg">modPart</span>)</span><br />
|
|
imports and caches a module.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._load_module">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="linspector.lib.config.parser.ConfigParser-class.html#replace_with_import" class="summary-sig-name">replace_with_import</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">objList</span>,
|
|
<span class="summary-sig-arg">modPart</span>,
|
|
<span class="summary-sig-arg">items_func</span>,
|
|
<span class="summary-sig-arg">class_check</span>)</span><br />
|
|
replaces configuration dicts with their objects by importing and
|
|
creating it in the first step.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.replace_with_import">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="linspector.lib.config.parser.ConfigParser-class.html#replace_pointer" class="summary-sig-name">replace_pointer</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">objectList</span>,
|
|
<span class="summary-sig-arg">replObjectList</span>,
|
|
<span class="summary-sig-arg">id_list_func</span>,
|
|
<span class="summary-sig-arg">id_get_func</span>)</span><br />
|
|
replaces objects from the config by ids.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.replace_pointer">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="parse_config"></a><span class="summary-sig-name">parse_config</span>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">configFilename</span>)</span></td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.parse_config">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<a name="section-MethodDetails"></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">Method Details</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-MethodDetails"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="__init__"></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">__init__</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">log</span>)</span>
|
|
<br /><em class="fname">(Constructor)</em>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.__init__">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>initializes a new ConfigParser Object</p>
|
|
<p>:param log: pre configured logger Object to post messages while
|
|
parsing"</p>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="_read_json_config"></a>
|
|
<div class="private">
|
|
<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">_read_json_config</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">configFilename</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._read_json_config">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>reads the config File and returns a dictionary, while lowering the
|
|
first keys</p>
|
|
<p>:param configFilename: the path under which the configuration file
|
|
should be found</p>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="_create_raw_Object"></a>
|
|
<div class="private">
|
|
<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">_create_raw_Object</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">jsonDict</span>,
|
|
<span class="sig-arg">msgName</span>,
|
|
<span class="sig-arg">creator</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._create_raw_Object">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>creates an Main object from the configuration, but just parses raw
|
|
data and hands it to the object</p>
|
|
<p>:param jsonDict: the configuration file part as dict :param msgName:
|
|
name of object for error message :param creator: function pointer which
|
|
is taking two arguments: identifier of the object and arguments. :should
|
|
return an object :return: a list of objects returned by creator</p>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="_load_module"></a>
|
|
<div class="private">
|
|
<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">_load_module</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">clazz</span>,
|
|
<span class="sig-arg">modPart</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._load_module">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>imports and caches a module.</p>
|
|
<p>:param clazz: the filename of the module (i.e email, ping...) :param
|
|
modPart: the folder of the module. (i.e services, parsers...) :return:
|
|
the imported/cached module, or throws an error if it couldn't find it</p>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="replace_with_import"></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">replace_with_import</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">objList</span>,
|
|
<span class="sig-arg">modPart</span>,
|
|
<span class="sig-arg">items_func</span>,
|
|
<span class="sig-arg">class_check</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.replace_with_import">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>replaces configuration dicts with their objects by importing and
|
|
creating it in the first step. In the second step the original list of
|
|
json config dicts gets replaced by the loaded objects</p>
|
|
<p>:param objList: the list of objects which is iterated on :param
|
|
modPart: the folder from the module (i.e tasks, parsers) :param
|
|
items_func: function to get a pointer on the list of json-config-objects
|
|
to replace. Takes one argument and :param class_check: currently
|
|
unsupported</p>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="replace_pointer"></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">replace_pointer</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">objectList</span>,
|
|
<span class="sig-arg">replObjectList</span>,
|
|
<span class="sig-arg">id_list_func</span>,
|
|
<span class="sig-arg">id_get_func</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.replace_pointer">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>replaces objects from the config by ids.</p>
|
|
<p>:param objectList: the list of objects to be iterated on :param
|
|
replObjectList: the list of objects to replace :param id_list_func:
|
|
function taking one argument as object and should return a list of config
|
|
ids to replace :param id_get_func: function taking one config-object as
|
|
argument and should return the config id to compare</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="linspector-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 Wed Jun 19 03:26:56 2013
|
|
</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>
|