1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
|
<?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>pyinotify.ProcessEvent</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="pyinotify-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="pyinotify-module.html">Module pyinotify</a> ::
Class ProcessEvent
</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="pyinotify.ProcessEvent-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ProcessEvent</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_pyinotif_15" name="uml_class_diagram_for_pyinotif_15">
<area shape="rect" id="node1_8" href="pyinotify.ProcessEvent-class.html#pevent" title="pyinotify.ProcessEvent.pevent" alt="" coords="32,107,275,127"/>
<area shape="rect" id="node1_9" href="pyinotify.ProcessEvent-class.html#__init__" title="Enable chaining of ProcessEvent instances." alt="" coords="32,129,275,149"/>
<area shape="rect" id="node1_10" href="pyinotify.ProcessEvent-class.html#my_init" title="This method is called from ProcessEvent.__init__()." alt="" coords="32,149,275,169"/>
<area shape="rect" id="node1_11" href="pyinotify.ProcessEvent-class.html#__call__" title="To behave like a functor the object must be callable." alt="" coords="32,169,275,189"/>
<area shape="rect" id="node1_12" href="pyinotify.ProcessEvent-class.html#nested_pevent" title="pyinotify.ProcessEvent.nested_pevent" alt="" coords="32,189,275,209"/>
<area shape="rect" id="node1_13" href="pyinotify.ProcessEvent-class.html#process_IN_Q_OVERFLOW" title="By default this method only reports warning messages, you can overredide it by subclassing ProcessEvent and implement your own process_IN_Q_OVERFLOW  method." alt="" coords="32,209,275,229"/>
<area shape="rect" id="node1_14" href="pyinotify.ProcessEvent-class.html#process_default" title="Default processing event method." alt="" coords="32,229,275,249"/>
<area shape="rect" id="node1" href="pyinotify.ProcessEvent-class.html" title="Process events objects, can be specialized via subclassing, thus its behavior can be overriden:" alt="" coords="20,83,287,256"/>
<area shape="rect" id="node3" href="pyinotify.Stats-class.html" title="Compute and display trivial statistics about processed events." alt="" coords="5,275,72,313"/>
<area shape="rect" id="node4" href="pyinotify.ChainIfTrue-class.html" title="Makes conditional chaining depending on the result of the nested processing instance." alt="" coords="101,275,205,313"/>
<area shape="rect" id="node5" href="pyinotify.PrintAllEvents-class.html" title="Dummy class used to print events strings representations." alt="" coords="235,275,354,313"/>
<area shape="rect" id="node2_15" href="pyinotify._ProcessEvent-class.html#__repr__" title="repr(x)" alt="" coords="108,37,197,57"/>
<area shape="rect" id="node2" href="pyinotify._ProcessEvent-class.html" title="Abstract processing event class." alt="" coords="95,5,209,64"/>
</map>
<img src="uml_class_diagram_for_pyinotif_15.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_15" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Process events objects, can be specialized via subclassing, thus its
behavior can be overriden:</p>
<p>Note: you should not override __init__ in your subclass instead define
a my_init() method, this method will be called automatically from the
constructor of this class with its optionals parameters.</p>
<ol start="1">
<li>
Provide specialized individual methods, e.g. process_IN_DELETE for
processing a precise type of event (e.g. IN_DELETE in this case).
</li>
<li>
Or/and provide methods for processing events by 'family', e.g.
process_IN_CLOSE method will process both IN_CLOSE_WRITE and
IN_CLOSE_NOWRITE events (if process_IN_CLOSE_WRITE and
process_IN_CLOSE_NOWRITE aren't defined though).
</li>
<li>
Or/and override process_default for catching and processing all the
remaining types of events.
</li>
</ol>
<!-- ==================== 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="pyinotify.ProcessEvent-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">pevent</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kargs</span>)</span><br />
Enable chaining of ProcessEvent instances.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.__init__">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="pyinotify.ProcessEvent-class.html#my_init" class="summary-sig-name">my_init</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**kargs</span>)</span><br />
This method is called from ProcessEvent.__init__().</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.my_init">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">bool</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">event</span>)</span><br />
To behave like a functor the object must be callable.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.__call__">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="nested_pevent"></a><span class="summary-sig-name">nested_pevent</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.nested_pevent">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="pyinotify.ProcessEvent-class.html#process_IN_Q_OVERFLOW" class="summary-sig-name">process_IN_Q_OVERFLOW</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">event</span>)</span><br />
By default this method only reports warning messages, you can
overredide it by subclassing ProcessEvent and implement your own
process_IN_Q_OVERFLOW method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.process_IN_Q_OVERFLOW">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="pyinotify.ProcessEvent-class.html#process_default" class="summary-sig-name">process_default</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">event</span>)</span><br />
Default processing event method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.process_default">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyinotify._ProcessEvent-class.html" onclick="show_private();">_ProcessEvent</a></code></b>:
<code><a href="pyinotify._ProcessEvent-class.html#__repr__">__repr__</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
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="pevent"></a><span class="summary-name">pevent</span> = <code title="None">None</code>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></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">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</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">pevent</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kargs</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.__init__">source code</a></span>
</td>
</tr></table>
<p>Enable chaining of ProcessEvent instances.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>pevent</code></strong> (callable) - Optional callable object, will be called on event processing
(before self).</li>
<li><strong class="pname"><code>kargs</code></strong> (dict) - This constructor is implemented as a template method delegating
its optionals keyworded arguments to the method my_init().</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="my_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">my_init</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**kargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.my_init">source code</a></span>
</td>
</tr></table>
<p>This method is called from ProcessEvent.__init__(). This method is
empty here and must be redefined to be useful. In effect, if you need to
specifically initialize your subclass' instance then you just have to
override this method in your subclass. Then all the keyworded arguments
passed to ProcessEvent.__init__() will be transmitted as parameters to
this method. Beware you MUST pass keyword arguments though.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>kargs</code></strong> (dict) - optional delegated arguments from __init__().</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="__call__"></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">__call__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">event</span>)</span>
<br /><em class="fname">(Call operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.__call__">source code</a></span>
</td>
</tr></table>
<p>To behave like a functor the object must be callable. This method is a
dispatch method. Its lookup order is:</p>
<ol start="1">
<li>
process_MASKNAME method
</li>
<li>
process_FAMILY_NAME method
</li>
<li>
otherwise calls process_default
</li>
</ol>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>event</code></strong> - Event to be processed.</li>
</ul></dd>
<dt>Returns: bool</dt>
<dd>By convention when used from the ProcessEvent class:
<ul>
<li>
Returning False or None (default value) means keep on
executing next chained functors (see chain.py example).
</li>
<li>
Returning True instead means do not execute next processing
functions.
</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="pyinotify.ProcessEventError-class.html">ProcessEventError</a></strong></code> - Event object undispatchable, unknown event.</li>
</ul></dd>
<dt>Overrides:
<a href="pyinotify._ProcessEvent-class.html#__call__">_ProcessEvent.__call__</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="process_IN_Q_OVERFLOW"></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">process_IN_Q_OVERFLOW</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">event</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.process_IN_Q_OVERFLOW">source code</a></span>
</td>
</tr></table>
<p>By default this method only reports warning messages, you can
overredide it by subclassing ProcessEvent and implement your own
process_IN_Q_OVERFLOW method. The actions you can take on receiving this
event is either to update the variable max_queued_events in order to
handle more simultaneous events or to modify your code in order to
accomplish a better filtering diminishing the number of raised events.
Because this method is defined, IN_Q_OVERFLOW will never get transmitted
as arguments to process_default calls.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>event</code></strong> (dict) - IN_Q_OVERFLOW event.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="process_default"></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">process_default</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">event</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#ProcessEvent.process_default">source code</a></span>
</td>
</tr></table>
<p>Default processing event method. By default does nothing. Subclass
ProcessEvent and redefine this method in order to modify its
behavior.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>event</code></strong> (Event instance) - Event to be processed. Can be of any type of events but
IN_Q_OVERFLOW events (see method process_IN_Q_OVERFLOW).</li>
</ul></dd>
</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="pyinotify-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 Thu Jun 4 11:54:20 2015
</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>
|
