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
|
<?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._SysProcessEvent</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 _SysProcessEvent
</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._SysProcessEvent-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class _SysProcessEvent</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_pyinotif_29" name="uml_class_diagram_for_pyinotif_29">
<area shape="rect" href="pyinotify._SysProcessEvent-class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="17,129,292,148"/>
<area shape="rect" href="pyinotify._SysProcessEvent-class.html#cleanup" title="Cleanup (delete) old (>1mn) records contained in self._mv_cookie and  self._mv." alt="" coords="17,148,292,166"/>
<area shape="rect" href="pyinotify._SysProcessEvent-class.html#process_IN_CREATE" title="If the event concerns a directory and the auto_add flag of the targetted  watch is set to True, a new watch is added on this new directory, with the  same attributes's values than those of this watch." alt="" coords="17,166,292,185"/>
<area shape="rect" href="pyinotify._SysProcessEvent-class.html#process_IN_MOVED_FROM" title="Map the cookie with the source path (+ date for cleaning)." alt="" coords="17,185,292,204"/>
<area shape="rect" href="pyinotify._SysProcessEvent-class.html#process_IN_MOVED_TO" title="Map the source path with the destination path (+ date for cleaning)." alt="" coords="17,204,292,222"/>
<area shape="rect" href="pyinotify._SysProcessEvent-class.html#process_IN_MOVE_SELF" title="STATUS: the following bug has been fixed in the recent kernels (fixme:  which version ?)." alt="" coords="17,222,292,241"/>
<area shape="rect" href="pyinotify._SysProcessEvent-class.html#process_IN_Q_OVERFLOW" title="Only signal overflow, most of the common flags are irrelevant for this  event (path, wd, name)." alt="" coords="17,241,292,260"/>
<area shape="rect" href="pyinotify._SysProcessEvent-class.html#process_IN_IGNORED" title="The watch descriptor raised by this event is now ignored (forever), it can  be safely deleted from watch manager dictionary." alt="" coords="17,260,292,278"/>
<area shape="rect" href="pyinotify._SysProcessEvent-class.html#process_default" title="Common handling for the following events:" alt="" coords="17,278,292,297"/>
<area shape="rect" href="pyinotify._SysProcessEvent-class.html" title="There is three kind of processing according to each event:" alt="" coords="16,104,293,298"/>
<area shape="rect" href="pyinotify._ProcessEvent-class.html#__call__" title="To behave like a functor the object must be callable." alt="" coords="95,36,215,54"/>
<area shape="rect" href="pyinotify._ProcessEvent-class.html#__repr__" title="repr(x)" alt="" coords="95,54,215,73"/>
<area shape="rect" href="pyinotify._ProcessEvent-class.html" title="Abstract processing event class." alt="" coords="93,10,216,74"/>
</map>
<img src="uml_class_diagram_for_pyinotif_29.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_29" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>There is three kind of processing according to each event:</p>
<ol start="1">
<li>
special handling (deletion from internal container, bug, ...).
</li>
<li>
default treatment: which is applied to most of events.
</li>
</ol>
<ol start="4">
<li>
IN_ISDIR is never sent alone, he is piggybacked with a standart
event, he is not processed as the others events, instead, its value
is captured and appropriately aggregated to dst event.
</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._SysProcessEvent-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">wm</span>,
<span class="summary-sig-arg">notifier</span>)</span><br />
x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.__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 name="cleanup"></a><span class="summary-sig-name">cleanup</span>(<span class="summary-sig-arg">self</span>)</span><br />
Cleanup (delete) old (>1mn) records contained in self._mv_cookie
and self._mv.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.cleanup">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="process_IN_CREATE"></a><span class="summary-sig-name">process_IN_CREATE</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">raw_event</span>)</span><br />
If the event concerns a directory and the auto_add flag of the
targetted watch is set to True, a new watch is added on this new
directory, with the same attributes's values than those of this
watch.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.process_IN_CREATE">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="process_IN_MOVED_FROM"></a><span class="summary-sig-name">process_IN_MOVED_FROM</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">raw_event</span>)</span><br />
Map the cookie with the source path (+ date for cleaning).</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.process_IN_MOVED_FROM">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="process_IN_MOVED_TO"></a><span class="summary-sig-name">process_IN_MOVED_TO</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">raw_event</span>)</span><br />
Map the source path with the destination path (+ date for cleaning).</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.process_IN_MOVED_TO">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._SysProcessEvent-class.html#process_IN_MOVE_SELF" class="summary-sig-name">process_IN_MOVE_SELF</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">raw_event</span>)</span><br />
STATUS: the following bug has been fixed in the recent kernels
(fixme: which version ?).</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.process_IN_MOVE_SELF">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="process_IN_Q_OVERFLOW"></a><span class="summary-sig-name">process_IN_Q_OVERFLOW</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">raw_event</span>)</span><br />
Only signal overflow, most of the common flags are irrelevant for
this event (path, wd, name).</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.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._SysProcessEvent-class.html#process_IN_IGNORED" class="summary-sig-name">process_IN_IGNORED</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">raw_event</span>)</span><br />
The watch descriptor raised by this event is now ignored (forever),
it can be safely deleted from watch manager dictionary.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.process_IN_IGNORED">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._SysProcessEvent-class.html#process_default" class="summary-sig-name">process_default</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">raw_event</span>,
<span class="summary-sig-arg">to_append</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span><br />
Common handling for the following events:</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.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#__call__">__call__</a></code>,
<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>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__str__</code>
</p>
</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">wm</span>,
<span class="sig-arg">notifier</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.__init__">source code</a></span>
</td>
</tr></table>
<p>x.__init__(...) initializes x; see x.__class__.__doc__ for
signature</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>wm</code></strong> (WatchManager instance) - Watch Manager.</li>
<li><strong class="pname"><code>notifier</code></strong> (Instance of Notifier.) - notifier.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="process_IN_MOVE_SELF"></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_MOVE_SELF</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">raw_event</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.process_IN_MOVE_SELF">source code</a></span>
</td>
</tr></table>
<p>STATUS: the following bug has been fixed in the recent kernels (fixme:
which version ?). Now it raises IN_DELETE_SELF instead.</p>
<p>Old kernels are bugged, this event is raised when the watched item was
moved, so we must update its path, but under some circumstances it can be
impossible: if its parent directory and its destination directory aren't
watched. The kernel (see include/linux/fsnotify.h) doesn't bring us
enough informations like the destination path of moved items.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="process_IN_IGNORED"></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_IGNORED</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">raw_event</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.process_IN_IGNORED">source code</a></span>
</td>
</tr></table>
<p>The watch descriptor raised by this event is now ignored (forever), it
can be safely deleted from watch manager dictionary. After this event we
can be sure that neither the event queue neither the system will raise an
event associated to this wd.</p>
<dl class="fields">
</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">raw_event</span>,
<span class="sig-arg">to_append</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#_SysProcessEvent.process_default">source code</a></span>
</td>
</tr></table>
<p>Common handling for the following events:</p>
<p>IN_ACCESS, IN_MODIFY, IN_ATTRIB, IN_CLOSE_WRITE, IN_CLOSE_NOWRITE,
IN_OPEN, IN_DELETE, IN_DELETE_SELF, IN_UNMOUNT.</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="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 Tue Jan 6 22:57:24 2009
</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>
|
