linspector-old/docs/linspector.lib.tasks.xmpp-pysrc.html
2013-06-19 03:27:20 +02:00

136 lines
11 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.tasks.xmpp</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.tasks-module.html">Package&nbsp;tasks</a> ::
Module&nbsp;xmpp
</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.tasks.xmpp-pysrc.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="linspector.lib.tasks.xmpp-module.html">Module linspector.lib.tasks.xmpp</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-docstring">The xmpp task.</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module linspector.lib.tasks.task=linspector.lib.tasks.task-module.html"><a title="linspector.lib.tasks.task" class="py-name" href="#" onclick="return doclink('link-0', 'task', 'link-0');">task</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Class linspector.lib.config.tasks.Task=linspector.lib.config.tasks.Task-class.html,Class linspector.lib.tasks.task.Task=linspector.lib.tasks.task.Task-class.html"><a title="linspector.lib.config.tasks.Task
linspector.lib.tasks.task.Task" class="py-name" href="#" onclick="return doclink('link-1', 'Task', 'link-1');">Task</a></tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"> </tt>
<a name="XmppTask"></a><div id="XmppTask-def"><a name="L8"></a><tt class="py-lineno"> 8</tt> <a class="py-toggle" href="#" id="XmppTask-toggle" onclick="return toggle('XmppTask');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="linspector.lib.tasks.xmpp.XmppTask-class.html">XmppTask</a><tt class="py-op">(</tt><tt class="py-base-class">Task</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="XmppTask-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="XmppTask-expanded"><a name="XmppTask.__init__"></a><div id="XmppTask.__init__-def"><a name="L9"></a><tt class="py-lineno"> 9</tt> <a class="py-toggle" href="#" id="XmppTask.__init__-toggle" onclick="return toggle('XmppTask.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="linspector.lib.tasks.xmpp.XmppTask-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="XmppTask.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="XmppTask.__init__-expanded"><a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-string">"type"</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">"'type' not in typeDict "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-string">"args"</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">"typeDict "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">" has nor arguments!"</tt><tt class="py-op">)</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Method linspector.lib.tasks.task.Task.set_task_type()=linspector.lib.tasks.task.Task-class.html#set_task_type"><a title="linspector.lib.tasks.task.Task.set_task_type" class="py-name" href="#" onclick="return doclink('link-2', 'set_task_type', 'link-2');">set_task_type</a></tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-string">"type"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">recipient</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-string">"args"</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">"rcpt"</tt><tt class="py-op">]</tt> </tt>
</div><a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"> </tt>
<a name="XmppTask.execute_task"></a><div id="XmppTask.execute_task-def"><a name="L17"></a><tt class="py-lineno">17</tt> <a class="py-toggle" href="#" id="XmppTask.execute_task-toggle" onclick="return toggle('XmppTask.execute_task');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="linspector.lib.tasks.xmpp.XmppTask-class.html#execute_task">execute_task</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="XmppTask.execute_task-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="XmppTask.execute_task-expanded"><a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div></div><a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"> </tt>
<a name="create"></a><div id="create-def"><a name="L21"></a><tt class="py-lineno">21</tt> <a class="py-toggle" href="#" id="create-toggle" onclick="return toggle('create');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="linspector.lib.tasks.xmpp-module.html#create">create</a><tt class="py-op">(</tt><tt class="py-param">taskDict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="create-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="create-expanded"><a name="L22"></a><tt class="py-lineno">22</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-3" class="py-name" targets="Class linspector.lib.tasks.xmpp.XmppTask=linspector.lib.tasks.xmpp.XmppTask-class.html"><a title="linspector.lib.tasks.xmpp.XmppTask" class="py-name" href="#" onclick="return doclink('link-3', 'XmppTask', 'link-3');">XmppTask</a></tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">taskDict</tt><tt class="py-op">)</tt> </tt>
</div><a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<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 Wed Jun 19 03:26:57 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>