root / docstrings / pyinotify._ProcessEvent-class.html

Revision a17385ae4cd3f952f689cfeee0d6e04841a4325e, 12.9 kB (checked in by Sebastien Martini <seb@…>, 3 hours ago)

Updated docstrings generated documentation.

  • Property mode set to 100644
Line 
1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3          "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6  <title>pyinotify._ProcessEvent</title>
7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
8  <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12      alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15       bgcolor="#a0c0ff" cellspacing="0">
16  <tr valign="middle">
17  <!-- Home link -->
18      <th>&nbsp;&nbsp;&nbsp;<a
19        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21  <!-- Tree link -->
22      <th>&nbsp;&nbsp;&nbsp;<a
23        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25  <!-- Index link -->
26      <th>&nbsp;&nbsp;&nbsp;<a
27        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29  <!-- Help link -->
30      <th>&nbsp;&nbsp;&nbsp;<a
31        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33      <th class="navbar" width="100%"></th>
34  </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37  <tr valign="top">
38    <td width="100%">
39      <span class="breadcrumbs">
40        <a href="pyinotify-module.html">Module&nbsp;pyinotify</a> ::
41        Class&nbsp;_ProcessEvent
42      </span>
43    </td>
44    <td>
45      <table cellpadding="0" cellspacing="0">
46        <!-- hide/show private -->
47        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49        <tr><td align="right"><span class="options"
50            >[<a href="frames.html" target="_top">frames</a
51            >]&nbsp;|&nbsp;<a href="pyinotify._ProcessEvent-class.html"
52            target="_top">no&nbsp;frames</a>]</span></td></tr>
53      </table>
54    </td>
55  </tr>
56</table>
57<!-- ==================== CLASS DESCRIPTION ==================== -->
58<h1 class="epydoc">Class _ProcessEvent</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent">source&nbsp;code</a></span></p>
59<center>
60  <div class="private"><center>  <map id="uml_class_diagram_for_pyinotif_26" name="uml_class_diagram_for_pyinotif_26">
61<area shape="rect" href="pyinotify._ProcessEvent&#45;class.html#__call__" title="To behave like a functor the object must be callable." alt="" coords="108,36,228,54"/>
62<area shape="rect" href="pyinotify._ProcessEvent&#45;class.html#__repr__" title="repr(x)" alt="" coords="108,54,228,73"/>
63<area shape="rect" href="pyinotify._ProcessEvent&#45;class.html" title="Abstract processing event class." alt="" coords="107,10,229,74"/>
64<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html" title="Process events objects, can be specialized via subclassing, thus its behavior can be overriden:" alt="" coords="41,104,135,130"/>
65<area shape="rect" href="pyinotify._SysProcessEvent&#45;class.html" title="There is three kind of processing according to each event:" alt="" coords="185,104,311,130"/>
66<area shape="rect" href="pyinotify.Stats&#45;class.html" title="pyinotify.Stats" alt="" coords="16,160,61,186"/>
67<area shape="rect" href="pyinotify.ChainIf&#45;class.html" title="Makes conditional chaining depending on the result of the nested processing instance." alt="" coords="112,160,165,186"/>
68</map>
69  <img src="uml_class_diagram_for_pyinotif_26.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_26" ismap="ismap" class="graph-without-title" />
70</center></div>
71  <div class="public" style="display:none"><center>  <map id="uml_class_diagram_for_pyinotif_27" name="uml_class_diagram_for_pyinotif_27">
72<area shape="rect" href="pyinotify._ProcessEvent&#45;class.html#__call__" title="To behave like a functor the object must be callable." alt="" coords="28,36,148,54"/>
73<area shape="rect" href="pyinotify._ProcessEvent&#45;class.html#__repr__" title="repr(x)" alt="" coords="28,54,148,73"/>
74<area shape="rect" href="pyinotify._ProcessEvent&#45;class.html" title="Abstract processing event class." alt="" coords="27,10,149,74"/>
75<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html" title="Process events objects, can be specialized via subclassing, thus its behavior can be overriden:" alt="" coords="41,104,135,130"/>
76<area shape="rect" href="pyinotify.Stats&#45;class.html" title="pyinotify.Stats" alt="" coords="16,160,61,186"/>
77<area shape="rect" href="pyinotify.ChainIf&#45;class.html" title="Makes conditional chaining depending on the result of the nested processing instance." alt="" coords="112,160,165,186"/>
78</map>
79  <img src="uml_class_diagram_for_pyinotif_27.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_27" ismap="ismap" class="graph-without-title" />
80</center></div>
81</center>
82<hr />
83<p>Abstract processing event class.</p>
84
85<!-- ==================== INSTANCE METHODS ==================== -->
86<a name="section-InstanceMethods"></a>
87<table class="summary" border="1" cellpadding="3"
88       cellspacing="0" width="100%" bgcolor="white">
89<tr bgcolor="#70b0f0" class="table-header">
90  <td colspan="2" class="table-header">
91    <table border="0" cellpadding="0" cellspacing="0" width="100%">
92      <tr valign="top">
93        <td align="left"><span class="table-header">Instance Methods</span></td>
94        <td align="right" valign="top"
95         ><span class="options">[<a href="#section-InstanceMethods"
96         class="privatelink" onclick="toggle_private();"
97         >hide private</a>]</span></td>
98      </tr>
99    </table>
100  </td>
101</tr>
102<tr>
103    <td width="15%" align="right" valign="top" class="summary">
104      <span class="summary-type">bool</span>
105    </td><td class="summary">
106      <table width="100%" cellpadding="0" cellspacing="0" border="0">
107        <tr>
108          <td><span class="summary-sig"><a href="pyinotify._ProcessEvent-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
109        <span class="summary-sig-arg">event</span>)</span><br />
110      To behave like a functor the object must be callable.</td>
111          <td align="right" valign="top">
112            <span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent.__call__">source&nbsp;code</a></span>
113           
114          </td>
115        </tr>
116      </table>
117     
118    </td>
119  </tr>
120<tr>
121    <td width="15%" align="right" valign="top" class="summary">
122      <span class="summary-type">&nbsp;</span>
123    </td><td class="summary">
124      <table width="100%" cellpadding="0" cellspacing="0" border="0">
125        <tr>
126          <td><span class="summary-sig"><a href="pyinotify._ProcessEvent-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
127      repr(x)</td>
128          <td align="right" valign="top">
129            <span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent.__repr__">source&nbsp;code</a></span>
130           
131          </td>
132        </tr>
133      </table>
134     
135    </td>
136  </tr>
137  <tr>
138    <td colspan="2" class="summary">
139    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
140      <code>__delattr__</code>,
141      <code>__getattribute__</code>,
142      <code>__hash__</code>,
143      <code>__init__</code>,
144      <code>__new__</code>,
145      <code>__reduce__</code>,
146      <code>__reduce_ex__</code>,
147      <code>__setattr__</code>,
148      <code>__str__</code>
149      </p>
150    </td>
151  </tr>
152</table>
153<!-- ==================== PROPERTIES ==================== -->
154<a name="section-Properties"></a>
155<table class="summary" border="1" cellpadding="3"
156       cellspacing="0" width="100%" bgcolor="white">
157<tr bgcolor="#70b0f0" class="table-header">
158  <td colspan="2" class="table-header">
159    <table border="0" cellpadding="0" cellspacing="0" width="100%">
160      <tr valign="top">
161        <td align="left"><span class="table-header">Properties</span></td>
162        <td align="right" valign="top"
163         ><span class="options">[<a href="#section-Properties"
164         class="privatelink" onclick="toggle_private();"
165         >hide private</a>]</span></td>
166      </tr>
167    </table>
168  </td>
169</tr>
170  <tr>
171    <td colspan="2" class="summary">
172    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
173      <code>__class__</code>
174      </p>
175    </td>
176  </tr>
177</table>
178<!-- ==================== METHOD DETAILS ==================== -->
179<a name="section-MethodDetails"></a>
180<table class="details" border="1" cellpadding="3"
181       cellspacing="0" width="100%" bgcolor="white">
182<tr bgcolor="#70b0f0" class="table-header">
183  <td colspan="2" class="table-header">
184    <table border="0" cellpadding="0" cellspacing="0" width="100%">
185      <tr valign="top">
186        <td align="left"><span class="table-header">Method Details</span></td>
187        <td align="right" valign="top"
188         ><span class="options">[<a href="#section-MethodDetails"
189         class="privatelink" onclick="toggle_private();"
190         >hide private</a>]</span></td>
191      </tr>
192    </table>
193  </td>
194</tr>
195</table>
196<a name="__call__"></a>
197<div>
198<table class="details" border="1" cellpadding="3"
199       cellspacing="0" width="100%" bgcolor="white">
200<tr><td>
201  <table width="100%" cellpadding="0" cellspacing="0" border="0">
202  <tr valign="top"><td>
203  <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
204        <span class="sig-arg">event</span>)</span>
205    <br /><em class="fname">(Call operator)</em>
206  </h3>
207  </td><td align="right" valign="top"
208    ><span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent.__call__">source&nbsp;code</a></span>&nbsp;
209    </td>
210  </tr></table>
211 
212  <p>To behave like a functor the object must be callable. This method is a
213  dispatch method. Lookup order:</p>
214  <ol start="1">
215    <li>
216      process_MASKNAME method
217    </li>
218    <li>
219      process_FAMILY_NAME method
220    </li>
221    <li>
222      otherwise call process_default
223    </li>
224  </ol>
225  <dl class="fields">
226    <dt>Parameters:</dt>
227    <dd><ul class="nomargin-top">
228        <li><strong class="pname"><code>event</code></strong> (Event object) - Event to be processed.</li>
229    </ul></dd>
230    <dt>Returns: bool</dt>
231        <dd>By convention when used from the ProcessEvent class:
232          <ul>
233            <li>
234              Returning False or None (default value) means keep on
235              executing next chained functors (see chain.py example).
236            </li>
237            <li>
238              Returning True instead means do not execute next processing
239              functions.
240            </li>
241          </ul></dd>
242    <dt>Raises:</dt>
243    <dd><ul class="nomargin-top">
244        <li><code><strong class='fraise'><a href="pyinotify.ProcessEventError-class.html">ProcessEventError</a></strong></code> - Event object undispatchable, unknown event.</li>
245    </ul></dd>
246  </dl>
247</td></tr></table>
248</div>
249<a name="__repr__"></a>
250<div>
251<table class="details" border="1" cellpadding="3"
252       cellspacing="0" width="100%" bgcolor="white">
253<tr><td>
254  <table width="100%" cellpadding="0" cellspacing="0" border="0">
255  <tr valign="top"><td>
256  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
257    <br /><em class="fname">(Representation operator)</em>
258  </h3>
259  </td><td align="right" valign="top"
260    ><span class="codelink"><a href="pyinotify-pysrc.html#_ProcessEvent.__repr__">source&nbsp;code</a></span>&nbsp;
261    </td>
262  </tr></table>
263 
264  <p>repr(x)</p>
265  <dl class="fields">
266    <dt>Overrides:
267        object.__repr__
268        <dd><em class="note">(inherited documentation)</em></dd>
269    </dt>
270  </dl>
271</td></tr></table>
272</div>
273<br />
274<!-- ==================== NAVIGATION BAR ==================== -->
275<table class="navbar" border="0" width="100%" cellpadding="0"
276       bgcolor="#a0c0ff" cellspacing="0">
277  <tr valign="middle">
278  <!-- Home link -->
279      <th>&nbsp;&nbsp;&nbsp;<a
280        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
281
282  <!-- Tree link -->
283      <th>&nbsp;&nbsp;&nbsp;<a
284        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
285
286  <!-- Index link -->
287      <th>&nbsp;&nbsp;&nbsp;<a
288        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
289
290  <!-- Help link -->
291      <th>&nbsp;&nbsp;&nbsp;<a
292        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
293
294      <th class="navbar" width="100%"></th>
295  </tr>
296</table>
297<table border="0" cellpadding="0" cellspacing="0" width="100%%">
298  <tr>
299    <td align="left" class="footer">
300    Generated by Epydoc 3.0.1 on Tue Jan  6 22:57:24 2009
301    </td>
302    <td align="right" class="footer">
303      <a target="mainFrame" href="http://epydoc.sourceforge.net"
304        >http://epydoc.sourceforge.net</a>
305    </td>
306  </tr>
307</table>
308
309<script type="text/javascript">
310  <!--
311  // Private objects are initially displayed (because if
312  // javascript is turned off then we want them to be
313  // visible); but by default, we want to hide them.  So hide
314  // them unless we have a cookie that says to show them.
315  checkCookie();
316  // -->
317</script>
318</body>
319</html>
Note: See TracBrowser for help on using the browser.