linspector/linspector-old
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs update

Browse source
This commit is contained in:
Johannes Findeisen 2013-06-18 03:08:37 +02:00
commit 679dc8cc20
143 changed files with 15625 additions and 645 deletions
Download patch file Download diff file Expand all files Collapse all files

497
docs/linspector.lib.config.parser.ConfigParser-class.html Normal file
View file

@ -0,0 +1,497 @@
<?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>&nbsp;&nbsp;&nbsp;<a
href="linspector-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;linspector</a> ::
<a href="linspector.lib-module.html">Package&nbsp;lib</a> ::
<a href="linspector.lib.config-module.html">Package&nbsp;config</a> ::
<a href="linspector.lib.config.parser-module.html">Module&nbsp;parser</a> ::
Class&nbsp;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&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="linspector.lib.config.parser.ConfigParser-class.html"
target="_top">no&nbsp;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&nbsp;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">&nbsp;</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&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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#_get_as_list" class="summary-sig-name" onclick="show_private();">_get_as_list</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">configValue</span>)</span><br />
In some cases the config permits to define a list or a single value.</td>
<td align="right" valign="top">
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._get_as_list">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_create_raw_Object"></a><span class="summary-sig-name">_create_raw_Object</span>(<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></td>
<td align="right" valign="top">
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._create_raw_Object">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="create_layouts_from_json"></a><span class="summary-sig-name">create_layouts_from_json</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">jsonLayouts</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.create_layouts_from_json">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="create_hostgroups_from_json"></a><span class="summary-sig-name">create_hostgroups_from_json</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">jsonHostGroups</span>)</span><br />
creates Hostgroups from the jsonConfig</td>
<td align="right" valign="top">
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.create_hostgroups_from_json">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="create_members_from_json"></a><span class="summary-sig-name">create_members_from_json</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">jsonMembers</span>)</span><br />
creates Members from the jsonConfig</td>
<td align="right" valign="top">
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.create_members_from_json">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_load_module"></a><span class="summary-sig-name">_load_module</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">clazz</span>,
<span class="summary-sig-arg">modPart</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._load_module">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="replace_with_import"></a><span class="summary-sig-name">replace_with_import</span>(<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></td>
<td align="right" valign="top">
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.replace_with_import">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="replace_pointer"></a><span class="summary-sig-name">replace_pointer</span>(<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></td>
<td align="right" valign="top">
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.replace_pointer">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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#parse_config" class="summary-sig-name">parse_config</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">configFilename</span>)</span><br />
parses the json configuration and returns a list of layouts,
which contains all nessesary information of the config file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser.parse_config">source&nbsp;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&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
initializes a new ConfigParser Object
params:
log: pre configured logger Object to post messages while parsing&quot;
</pre>
<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&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
reads the config File and returns a dictionary, while lowering the first keys
params:
configFilename: the path under which the configuration file should be found
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_get_as_list"></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">_get_as_list</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">configValue</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="linspector.lib.config.parser-pysrc.html#ConfigParser._get_as_list">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>In some cases the config permits to define a list or a single
value.</p>
<p>returns the value as list</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="parse_config"></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">parse_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.parse_config">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
parses the json configuration and returns a list of layouts,
which contains all nessesary information of the config file.
It will only parse nessesary Objects.
Parsing will be done in 3 steps:
1. get raw Config Objects by just passing the values defined inside the config
2. replace references by objects
3. do sanity checks
params:
configFilename: indicates which configuration file to parse
</pre>
<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>&nbsp;&nbsp;&nbsp;<a
href="linspector-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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 Tue Jun 18 03:07:33 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>