root / docstrings / pyinotify-module.html

Revision a17385ae4cd3f952f689cfeee0d6e04841a4325e, 30.2 kB (checked in by Sebastien Martini <seb@…>, 50 minutes 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</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 bgcolor="#70b0f0" class="navbar-select"
19          >&nbsp;&nbsp;&nbsp;Home&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        Module&nbsp;pyinotify
41      </span>
42    </td>
43    <td>
44      <table cellpadding="0" cellspacing="0">
45        <!-- hide/show private -->
46        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
47    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
48        <tr><td align="right"><span class="options"
49            >[<a href="frames.html" target="_top">frames</a
50            >]&nbsp;|&nbsp;<a href="pyinotify-module.html"
51            target="_top">no&nbsp;frames</a>]</span></td></tr>
52      </table>
53    </td>
54  </tr>
55</table>
56<!-- ==================== MODULE DESCRIPTION ==================== -->
57<h1 class="epydoc">Module pyinotify</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html">source&nbsp;code</a></span></p>
58<p>pyinotify</p>
59
60<hr />
61<div class="fields">      <p><strong>Author:</strong>
62        Sebastien Martini
63      </p>
64      <p><strong>License:</strong>
65        GPL 2
66      </p>
67      <p><strong>Contact:</strong>
68        seb@dbzteam.org
69      </p>
70      <p><strong>Version:</strong>
71        0.8.2
72      </p>
73</div><!-- ==================== CLASSES ==================== -->
74<a name="section-Classes"></a>
75<table class="summary" border="1" cellpadding="3"
76       cellspacing="0" width="100%" bgcolor="white">
77<tr bgcolor="#70b0f0" class="table-header">
78  <td colspan="2" class="table-header">
79    <table border="0" cellpadding="0" cellspacing="0" width="100%">
80      <tr valign="top">
81        <td align="left"><span class="table-header">Classes</span></td>
82        <td align="right" valign="top"
83         ><span class="options">[<a href="#section-Classes"
84         class="privatelink" onclick="toggle_private();"
85         >hide private</a>]</span></td>
86      </tr>
87    </table>
88  </td>
89</tr>
90<tr>
91    <td width="15%" align="right" valign="top" class="summary">
92      <span class="summary-type">&nbsp;</span>
93    </td><td class="summary">
94        <a href="pyinotify.PyinotifyError-class.html" class="summary-name">PyinotifyError</a><br />
95      Indicates exceptions raised by a Pyinotify class.
96    </td>
97  </tr>
98<tr>
99    <td width="15%" align="right" valign="top" class="summary">
100      <span class="summary-type">&nbsp;</span>
101    </td><td class="summary">
102        <a href="pyinotify.UnsupportedPythonVersionError-class.html" class="summary-name">UnsupportedPythonVersionError</a><br />
103      Raised for unsupported Python version.
104    </td>
105  </tr>
106<tr>
107    <td width="15%" align="right" valign="top" class="summary">
108      <span class="summary-type">&nbsp;</span>
109    </td><td class="summary">
110        <a href="pyinotify.UnsupportedLibcVersionError-class.html" class="summary-name">UnsupportedLibcVersionError</a><br />
111      Raised for unsupported libc version.
112    </td>
113  </tr>
114<tr>
115    <td width="15%" align="right" valign="top" class="summary">
116      <span class="summary-type">&nbsp;</span>
117    </td><td class="summary">
118        <a href="pyinotify.SysCtlINotify-class.html" class="summary-name">SysCtlINotify</a><br />
119      Access (read, write) inotify's variables through sysctl.
120    </td>
121  </tr>
122<tr>
123    <td width="15%" align="right" valign="top" class="summary">
124      <span class="summary-type">&nbsp;</span>
125    </td><td class="summary">
126        <a href="pyinotify.EventsCodes-class.html" class="summary-name">EventsCodes</a><br />
127      Set of codes corresponding to each kind of events.
128    </td>
129  </tr>
130<tr class="private">
131    <td width="15%" align="right" valign="top" class="summary">
132      <span class="summary-type">&nbsp;</span>
133    </td><td class="summary">
134        <a href="pyinotify._Event-class.html" class="summary-name" onclick="show_private();">_Event</a><br />
135      Event structure, represent events raised by the system.
136    </td>
137  </tr>
138<tr class="private">
139    <td width="15%" align="right" valign="top" class="summary">
140      <span class="summary-type">&nbsp;</span>
141    </td><td class="summary">
142        <a href="pyinotify._RawEvent-class.html" class="summary-name" onclick="show_private();">_RawEvent</a><br />
143      Raw event, it contains only the informations provided by the
144        system.
145    </td>
146  </tr>
147<tr>
148    <td width="15%" align="right" valign="top" class="summary">
149      <span class="summary-type">&nbsp;</span>
150    </td><td class="summary">
151        <a href="pyinotify.Event-class.html" class="summary-name">Event</a><br />
152      This class contains all the useful informations about the observed
153        event.
154    </td>
155  </tr>
156<tr>
157    <td width="15%" align="right" valign="top" class="summary">
158      <span class="summary-type">&nbsp;</span>
159    </td><td class="summary">
160        <a href="pyinotify.ProcessEventError-class.html" class="summary-name">ProcessEventError</a><br />
161      ProcessEventError Exception.
162    </td>
163  </tr>
164<tr class="private">
165    <td width="15%" align="right" valign="top" class="summary">
166      <span class="summary-type">&nbsp;</span>
167    </td><td class="summary">
168        <a href="pyinotify._ProcessEvent-class.html" class="summary-name" onclick="show_private();">_ProcessEvent</a><br />
169      Abstract processing event class.
170    </td>
171  </tr>
172<tr class="private">
173    <td width="15%" align="right" valign="top" class="summary">
174      <span class="summary-type">&nbsp;</span>
175    </td><td class="summary">
176        <a href="pyinotify._SysProcessEvent-class.html" class="summary-name" onclick="show_private();">_SysProcessEvent</a><br />
177      There is three kind of processing according to each event:
178    </td>
179  </tr>
180<tr>
181    <td width="15%" align="right" valign="top" class="summary">
182      <span class="summary-type">&nbsp;</span>
183    </td><td class="summary">
184        <a href="pyinotify.ProcessEvent-class.html" class="summary-name">ProcessEvent</a><br />
185      Process events objects, can be specialized via subclassing, thus
186        its behavior can be overriden:
187    </td>
188  </tr>
189<tr>
190    <td width="15%" align="right" valign="top" class="summary">
191      <span class="summary-type">&nbsp;</span>
192    </td><td class="summary">
193        <a href="pyinotify.ChainIf-class.html" class="summary-name">ChainIf</a><br />
194      Makes conditional chaining depending on the result of the nested
195        processing instance.
196    </td>
197  </tr>
198<tr>
199    <td width="15%" align="right" valign="top" class="summary">
200      <span class="summary-type">&nbsp;</span>
201    </td><td class="summary">
202        <a href="pyinotify.Stats-class.html" class="summary-name">Stats</a>
203    </td>
204  </tr>
205<tr>
206    <td width="15%" align="right" valign="top" class="summary">
207      <span class="summary-type">&nbsp;</span>
208    </td><td class="summary">
209        <a href="pyinotify.NotifierError-class.html" class="summary-name">NotifierError</a><br />
210      Notifier Exception.
211    </td>
212  </tr>
213<tr>
214    <td width="15%" align="right" valign="top" class="summary">
215      <span class="summary-type">&nbsp;</span>
216    </td><td class="summary">
217        <a href="pyinotify.Notifier-class.html" class="summary-name">Notifier</a><br />
218      Read notifications, process events.
219    </td>
220  </tr>
221<tr>
222    <td width="15%" align="right" valign="top" class="summary">
223      <span class="summary-type">&nbsp;</span>
224    </td><td class="summary">
225        <a href="pyinotify.ThreadedNotifier-class.html" class="summary-name">ThreadedNotifier</a><br />
226      This notifier inherits from threading.Thread for instantiating a
227        separate thread, and also inherits from Notifier, because it is a
228        threaded notifier.
229    </td>
230  </tr>
231<tr>
232    <td width="15%" align="right" valign="top" class="summary">
233      <span class="summary-type">&nbsp;</span>
234    </td><td class="summary">
235        <a href="pyinotify.Watch-class.html" class="summary-name">Watch</a><br />
236      Represent a watch, i.e.
237    </td>
238  </tr>
239<tr>
240    <td width="15%" align="right" valign="top" class="summary">
241      <span class="summary-type">&nbsp;</span>
242    </td><td class="summary">
243        <a href="pyinotify.ExcludeFilter-class.html" class="summary-name">ExcludeFilter</a><br />
244      ExcludeFilter is an exclusion filter.
245    </td>
246  </tr>
247<tr>
248    <td width="15%" align="right" valign="top" class="summary">
249      <span class="summary-type">&nbsp;</span>
250    </td><td class="summary">
251        <a href="pyinotify.WatchManagerError-class.html" class="summary-name">WatchManagerError</a><br />
252      WatchManager Exception.
253    </td>
254  </tr>
255<tr>
256    <td width="15%" align="right" valign="top" class="summary">
257      <span class="summary-type">&nbsp;</span>
258    </td><td class="summary">
259        <a href="pyinotify.WatchManager-class.html" class="summary-name">WatchManager</a><br />
260      Provide operations for watching files and directories.
261    </td>
262  </tr>
263<tr>
264    <td width="15%" align="right" valign="top" class="summary">
265      <span class="summary-type">&nbsp;</span>
266    </td><td class="summary">
267        <a href="pyinotify.Color-class.html" class="summary-name">Color</a>
268    </td>
269  </tr>
270<tr>
271    <td width="15%" align="right" valign="top" class="summary">
272      <span class="summary-type">&nbsp;</span>
273    </td><td class="summary">
274        <a href="pyinotify.ColorTheme-class.html" class="summary-name">ColorTheme</a>
275    </td>
276  </tr>
277<tr>
278    <td width="15%" align="right" valign="top" class="summary">
279      <span class="summary-type">&nbsp;</span>
280    </td><td class="summary">
281        <a href="pyinotify.NoTheme-class.html" class="summary-name">NoTheme</a>
282    </td>
283  </tr>
284<tr>
285    <td width="15%" align="right" valign="top" class="summary">
286      <span class="summary-type">&nbsp;</span>
287    </td><td class="summary">
288        <a href="pyinotify.AnsiColorTheme-class.html" class="summary-name">AnsiColorTheme</a>
289    </td>
290  </tr>
291<tr>
292    <td width="15%" align="right" valign="top" class="summary">
293      <span class="summary-type">&nbsp;</span>
294    </td><td class="summary">
295        <a href="pyinotify.BlackAndWhite-class.html" class="summary-name">BlackAndWhite</a>
296    </td>
297  </tr>
298<tr>
299    <td width="15%" align="right" valign="top" class="summary">
300      <span class="summary-type">&nbsp;</span>
301    </td><td class="summary">
302        <a href="pyinotify.DefaultTheme-class.html" class="summary-name">DefaultTheme</a>
303    </td>
304  </tr>
305</table>
306<!-- ==================== FUNCTIONS ==================== -->
307<a name="section-Functions"></a>
308<table class="summary" border="1" cellpadding="3"
309       cellspacing="0" width="100%" bgcolor="white">
310<tr bgcolor="#70b0f0" class="table-header">
311  <td colspan="2" class="table-header">
312    <table border="0" cellpadding="0" cellspacing="0" width="100%">
313      <tr valign="top">
314        <td align="left"><span class="table-header">Functions</span></td>
315        <td align="right" valign="top"
316         ><span class="options">[<a href="#section-Functions"
317         class="privatelink" onclick="toggle_private();"
318         >hide private</a>]</span></td>
319      </tr>
320    </table>
321  </td>
322</tr>
323<tr>
324    <td width="15%" align="right" valign="top" class="summary">
325      <span class="summary-type">&nbsp;</span>
326    </td><td class="summary">
327      <table width="100%" cellpadding="0" cellspacing="0" border="0">
328        <tr>
329          <td><span class="summary-sig"><a name="iglob"></a><span class="summary-sig-name">iglob</span>(<span class="summary-sig-arg">pathname</span>)</span></td>
330          <td align="right" valign="top">
331            <span class="codelink"><a href="pyinotify-pysrc.html#iglob">source&nbsp;code</a></span>
332           
333          </td>
334        </tr>
335      </table>
336     
337    </td>
338  </tr>
339<tr>
340    <td width="15%" align="right" valign="top" class="summary">
341      <span class="summary-type">&nbsp;</span>
342    </td><td class="summary">
343      <table width="100%" cellpadding="0" cellspacing="0" border="0">
344        <tr>
345          <td><span class="summary-sig"><a name="glob1"></a><span class="summary-sig-name">glob1</span>(<span class="summary-sig-arg">dirname</span>,
346        <span class="summary-sig-arg">pattern</span>)</span></td>
347          <td align="right" valign="top">
348            <span class="codelink"><a href="pyinotify-pysrc.html#glob1">source&nbsp;code</a></span>
349           
350          </td>
351        </tr>
352      </table>
353     
354    </td>
355  </tr>
356<tr>
357    <td width="15%" align="right" valign="top" class="summary">
358      <span class="summary-type">&nbsp;</span>
359    </td><td class="summary">
360      <table width="100%" cellpadding="0" cellspacing="0" border="0">
361        <tr>
362          <td><span class="summary-sig"><a name="glob0"></a><span class="summary-sig-name">glob0</span>(<span class="summary-sig-arg">dirname</span>,
363        <span class="summary-sig-arg">basename</span>)</span></td>
364          <td align="right" valign="top">
365            <span class="codelink"><a href="pyinotify-pysrc.html#glob0">source&nbsp;code</a></span>
366           
367          </td>
368        </tr>
369      </table>
370     
371    </td>
372  </tr>
373<tr>
374    <td width="15%" align="right" valign="top" class="summary">
375      <span class="summary-type">&nbsp;</span>
376    </td><td class="summary">
377      <table width="100%" cellpadding="0" cellspacing="0" border="0">
378        <tr>
379          <td><span class="summary-sig"><a name="has_magic"></a><span class="summary-sig-name">has_magic</span>(<span class="summary-sig-arg">s</span>)</span></td>
380          <td align="right" valign="top">
381            <span class="codelink"><a href="pyinotify-pysrc.html#has_magic">source&nbsp;code</a></span>
382           
383          </td>
384        </tr>
385      </table>
386     
387    </td>
388  </tr>
389<tr>
390    <td width="15%" align="right" valign="top" class="summary">
391      <span class="summary-type">&nbsp;</span>
392    </td><td class="summary">
393      <table width="100%" cellpadding="0" cellspacing="0" border="0">
394        <tr>
395          <td><span class="summary-sig"><a name="command_line"></a><span class="summary-sig-name">command_line</span>()</span></td>
396          <td align="right" valign="top">
397            <span class="codelink"><a href="pyinotify-pysrc.html#command_line">source&nbsp;code</a></span>
398           
399          </td>
400        </tr>
401      </table>
402     
403    </td>
404  </tr>
405</table>
406<!-- ==================== VARIABLES ==================== -->
407<a name="section-Variables"></a>
408<table class="summary" border="1" cellpadding="3"
409       cellspacing="0" width="100%" bgcolor="white">
410<tr bgcolor="#70b0f0" class="table-header">
411  <td colspan="2" class="table-header">
412    <table border="0" cellpadding="0" cellspacing="0" width="100%">
413      <tr valign="top">
414        <td align="left"><span class="table-header">Variables</span></td>
415        <td align="right" valign="top"
416         ><span class="options">[<a href="#section-Variables"
417         class="privatelink" onclick="toggle_private();"
418         >hide private</a>]</span></td>
419      </tr>
420    </table>
421  </td>
422</tr>
423<tr>
424    <td width="15%" align="right" valign="top" class="summary">
425      <span class="summary-type">&nbsp;</span>
426    </td><td class="summary">
427        <a name="__author__"></a><span class="summary-name">__author__</span> = <code title="'seb@dbzteam.org (Sebastien Martini)'"><code class="variable-quote">'</code><code class="variable-string">seb@dbzteam.org (Sebastien Martini)</code><code class="variable-quote">'</code></code>
428    </td>
429  </tr>
430<tr>
431    <td width="15%" align="right" valign="top" class="summary">
432      <span class="summary-type">&nbsp;</span>
433    </td><td<