root / docstrings / pyinotify.WatchManager-class.html

Revision f7cd60146b00bdffd25b207639d1d2fb326a2174, 34.6 kB (checked in by Sebastien Martini <ookoi@…>, 5 months ago)

- Documentation updated.
- Version 0.8.0t released.

  • 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.WatchManager</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;WatchManager
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.WatchManager-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 WatchManager</h1><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager">source&nbsp;code</a></span><br /><br />
59<center>
60<center>  <map id="uml_class_diagram_for_pyinotif_19" name="uml_class_diagram_for_pyinotif_19">
61<area shape="rect" href="pyinotify.WatchManager&#45;class.html#__init__" title="Initialization: init inotify, init watch manager dictionary." alt="" coords="17,36,732,55"/>
62<area shape="rect" href="pyinotify.WatchManager&#45;class.html#rm_watch" title="Removes watch(s)." alt="" coords="17,55,732,74"/>
63<area shape="rect" href="pyinotify.WatchManager&#45;class.html#get_wd" title="Returns the watch descriptor associated to path." alt="" coords="17,74,732,92"/>
64<area shape="rect" href="pyinotify.WatchManager&#45;class.html#update_watch" title="Update existing watch(s)." alt="" coords="17,92,732,111"/>
65<area shape="rect" href="pyinotify.WatchManager&#45;class.html#add_watch" title="Add watch(s) on given path(s) with the specified mask and optionnally with  a processing function and recursive flag." alt="" coords="17,111,732,130"/>
66<area shape="rect" href="pyinotify.WatchManager&#45;class.html#get_path" title="Returns the path associated to WD, if WD is unknown None is returned." alt="" coords="17,130,732,148"/>
67<area shape="rect" href="pyinotify.WatchManager&#45;class.html#watch_transient_file" title="Watch a transient file, which will be created and deleted frequently over  time (e.g." alt="" coords="17,148,732,167"/>
68<area shape="rect" href="pyinotify.WatchManager&#45;class.html" title="Provide operations for watching files and directories." alt="" coords="16,11,733,168"/>
69</map>
70  <img src="uml_class_diagram_for_pyinotif_19.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_19" ismap="ismap" class="graph-without-title" />
71</center></center>
72<hr />
73Provide operations for watching files and directories. Integrated
74  dictionary is used to reference watched items.<br /><br />
75
76<!-- ==================== INSTANCE METHODS ==================== -->
77<a name="section-InstanceMethods"></a>
78<table class="summary" border="1" cellpadding="3"
79       cellspacing="0" width="100%" bgcolor="white">
80<tr bgcolor="#70b0f0" class="table-header">
81  <td colspan="2" class="table-header">
82    <table border="0" cellpadding="0" cellspacing="0" width="100%">
83      <tr valign="top">
84        <td align="left"><span class="table-header">Instance Methods</span></td>
85        <td align="right" valign="top"
86         ><span class="options">[<a href="#section-InstanceMethods"
87         class="privatelink" onclick="toggle_private();"
88         >hide private</a>]</span></td>
89      </tr>
90    </table>
91  </td>
92</tr>
93<tr>
94    <td width="15%" align="right" valign="top" class="summary">
95      <span class="summary-type">&nbsp;</span>
96    </td><td class="summary">
97      <table width="100%" cellpadding="0" cellspacing="0" border="0">
98        <tr>
99          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
100        <span class="summary-sig-arg">exclude_filter</span>=<span class="summary-sig-default">&lt;function &lt;lambda&gt; at 0x84b172c&gt;</span>)</span><br />
101      Initialization: init inotify, init watch manager dictionary.</td>
102          <td align="right" valign="top">
103            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__init__">source&nbsp;code</a></span>
104           
105          </td>
106        </tr>
107      </table>
108     
109    </td>
110  </tr>
111<tr class="private">
112    <td width="15%" align="right" valign="top" class="summary">
113      <span class="summary-type">&nbsp;</span>
114    </td><td class="summary">
115      <table width="100%" cellpadding="0" cellspacing="0" border="0">
116        <tr>
117          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#__add_watch" class="summary-sig-name">__add_watch</a>(<span class="summary-sig-arg">self</span>,
118        <span class="summary-sig-arg">path</span>,
119        <span class="summary-sig-arg">mask</span>,
120        <span class="summary-sig-arg">proc_fun</span>,
121        <span class="summary-sig-arg">auto_add</span>)</span><br />
122      Add a watch on path, build a Watch object and insert it in the
123      watch manager dictionary.</td>
124          <td align="right" valign="top">
125            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__add_watch">source&nbsp;code</a></span>
126           
127          </td>
128        </tr>
129      </table>
130     
131    </td>
132  </tr>
133<tr class="private">
134    <td width="15%" align="right" valign="top" class="summary">
135      <span class="summary-type">&nbsp;</span>
136    </td><td class="summary">
137      <table width="100%" cellpadding="0" cellspacing="0" border="0">
138        <tr>
139          <td><span class="summary-sig"><a name="__glob"></a><span class="summary-sig-name">__glob</span>(<span class="summary-sig-arg">self</span>,
140        <span class="summary-sig-arg">path</span>,
141        <span class="summary-sig-arg">do_glob</span>)</span></td>
142          <td align="right" valign="top">
143            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__glob">source&nbsp;code</a></span>
144           
145          </td>
146        </tr>
147      </table>
148     
149    </td>
150  </tr>
151<tr>
152    <td width="15%" align="right" valign="top" class="summary">
153      <span class="summary-type">dict of {str: int}</span>
154    </td><td class="summary">
155      <table width="100%" cellpadding="0" cellspacing="0" border="0">
156        <tr>
157          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#add_watch" class="summary-sig-name">add_watch</a>(<span class="summary-sig-arg">self</span>,
158        <span class="summary-sig-arg">path</span>,
159        <span class="summary-sig-arg">mask</span>,
160        <span class="summary-sig-arg">proc_fun</span>=<span class="summary-sig-default">None</span>,
161        <span class="summary-sig-arg">rec</span>=<span class="summary-sig-default">False</span>,
162        <span class="summary-sig-arg">auto_add</span>=<span class="summary-sig-default">False</span>,
163        <span class="summary-sig-arg">do_glob</span>=<span class="summary-sig-default">False</span>,
164        <span class="summary-sig-arg">quiet</span>=<span class="summary-sig-default">True</span>,
165        <span class="summary-sig-arg">exclude_filter</span>=<span class="summary-sig-default">None</span>)</span><br />
166      Add watch(s) on given path(s) with the specified mask and
167      optionnally with a processing function and recursive flag.</td>
168          <td align="right" valign="top">
169            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.add_watch">source&nbsp;code</a></span>
170           
171          </td>
172        </tr>
173      </table>
174     
175    </td>
176  </tr>
177<tr class="private">
178    <td width="15%" align="right" valign="top" class="summary">
179      <span class="summary-type">list of int</span>
180    </td><td class="summary">
181      <table width="100%" cellpadding="0" cellspacing="0" border="0">
182        <tr>
183          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#__get_sub_rec" class="summary-sig-name">__get_sub_rec</a>(<span class="summary-sig-arg">self</span>,
184        <span class="summary-sig-arg">lpath</span>)</span><br />
185      Get every wd from self._wmd if its path is under the path of one
186      (at least) of those in lpath.</td>
187          <td align="right" valign="top">
188            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__get_sub_rec">source&nbsp;code</a></span>
189           
190          </td>
191        </tr>
192      </table>
193     
194    </td>
195  </tr>
196<tr>
197    <td width="15%" align="right" valign="top" class="summary">
198      <span class="summary-type">dict of int: bool</span>
199    </td><td class="summary">
200      <table width="100%" cellpadding="0" cellspacing="0" border="0">
201        <tr>
202          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#update_watch" class="summary-sig-name">update_watch</a>(<span class="summary-sig-arg">self</span>,
203        <span class="summary-sig-arg">wd</span>,
204        <span class="summary-sig-arg">mask</span>=<span class="summary-sig-default">None</span>,
205        <span class="summary-sig-arg">proc_fun</span>=<span class="summary-sig-default">None</span>,
206        <span class="summary-sig-arg">rec</span>=<span class="summary-sig-default">False</span>,
207        <span class="summary-sig-arg">auto_add</span>=<span class="summary-sig-default">False</span>,
208        <span class="summary-sig-arg">quiet</span>=<span class="summary-sig-default">True</span>)</span><br />
209      Update existing watch(s).</td>
210          <td align="right" valign="top">
211            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.update_watch">source&nbsp;code</a></span>
212           
213          </td>
214        </tr>
215      </table>
216     
217    </td>
218  </tr>
219<tr class="private">
220    <td width="15%" align="right" valign="top" class="summary">
221      <span class="summary-type">list of type(param)</span>
222    </td><td class="summary">
223      <table width="100%" cellpadding="0" cellspacing="0" border="0">
224        <tr>
225          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#__format_param" class="summary-sig-name">__format_param</a>(<span class="summary-sig-arg">self</span>,
226        <span class="summary-sig-arg">param</span>)</span><br />
227      Returns:
228      wrap param.</td>
229          <td align="right" valign="top">
230            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__format_param">source&nbsp;code</a></span>
231           
232          </td>
233        </tr>
234      </table>
235     
236    </td>
237  </tr>
238<tr>
239    <td width="15%" align="right" valign="top" class="summary">
240      <span class="summary-type">int or None</span>
241    </td><td class="summary">
242      <table width="100%" cellpadding="0" cellspacing="0" border="0">
243        <tr>
244          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#get_wd" class="summary-sig-name">get_wd</a>(<span class="summary-sig-arg">self</span>,
245        <span class="summary-sig-arg">path</span>)</span><br />
246      Returns the watch descriptor associated to path.</td>
247          <td align="right" valign="top">
248            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_wd">source&nbsp;code</a></span>
249           
250          </td>
251        </tr>
252      </table>
253     
254    </td>
255  </tr>
256<tr>
257    <td width="15%" align="right" valign="top" class="summary">
258      <span class="summary-type">string or None</span>
259    </td><td class="summary">
260      <table width="100%" cellpadding="0" cellspacing="0" border="0">
261        <tr>
262          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#get_path" class="summary-sig-name">get_path</a>(<span class="summary-sig-arg">self</span>,
263        <span class="summary-sig-arg">wd</span>)</span><br />
264      Returns the path associated to WD, if WD is unknown None is
265      returned.</td>
266          <td align="right" valign="top">
267            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_path">source&nbsp;code</a></span>
268           
269          </td>
270        </tr>
271      </table>
272     
273    </td>
274  </tr>
275<tr class="private">
276    <td width="15%" align="right" valign="top" class="summary">
277      <span class="summary-type">string</span>
278    </td><td class="summary">
279      <table width="100%" cellpadding="0" cellspacing="0" border="0">
280        <tr>
281          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#__walk_rec" class="summary-sig-name">__walk_rec</a>(<span class="summary-sig-arg">self</span>,
282        <span class="summary-sig-arg">top</span>,
283        <span class="summary-sig-arg">rec</span>)</span><br />
284      Yields each subdirectories of top, doesn't follow symlinks.</td>
285          <td align="right" valign="top">
286            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__walk_rec">source&nbsp;code</a></span>
287           
288          </td>
289        </tr>
290      </table>
291     
292    </td>
293  </tr>
294<tr>
295    <td width="15%" align="right" valign="top" class="summary">
296      <span class="summary-type">dict of int: bool</span>
297    </td><td class="summary">
298      <table width="100%" cellpadding="0" cellspacing="0" border="0">
299        <tr>
300          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#rm_watch" class="summary-sig-name">rm_watch</a>(<span class="summary-sig-arg">self</span>,
301        <span class="summary-sig-arg">wd</span>,
302        <span class="summary-sig-arg">rec</span>=<span class="summary-sig-default">False</span>,
303        <span class="summary-sig-arg">quiet</span>=<span class="summary-sig-default">True</span>)</span><br />
304      Removes watch(s).</td>
305          <td align="right" valign="top">
306            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.rm_watch">source&nbsp;code</a></span>
307           
308          </td>
309        </tr>
310      </table>
311     
312    </td>
313  </tr>
314<tr>
315    <td width="15%" align="right" valign="top" class="summary">
316      <span class="summary-type">See add_watch().</span>
317    </td><td class="summary">
318      <table width="100%" cellpadding="0" cellspacing="0" border="0">
319        <tr>
320          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#watch_transient_file" class="summary-sig-name">watch_transient_file</a>(<span class="summary-sig-arg">self</span>,
321        <span class="summary-sig-arg">filename</span>,
322        <span class="summary-sig-arg">mask</span>,
323        <span class="summary-sig-arg">proc_class</span>)</span><br />
324      Watch a transient file, which will be created and deleted
325      frequently over time (e.g.</td>
326          <td align="right" valign="top">
327            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.watch_transient_file">source&nbsp;code</a></span>
328           
329          </td>
330        </tr>
331      </table>
332     
333    </td>
334  </tr>
335  <tr>
336    <td colspan="2" class="summary">
337    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
338      <code>__delattr__</code>,
339      <code>__getattribute__</code>,
340      <code>__hash__</code>,
341      <code>__new__</code>,
342      <code>__reduce__</code>,
343      <code>__reduce_ex__</code>,
344      <code>__repr__</code>,
345      <code>__setattr__</code>,
346      <code>__str__</code>
347      </p>
348    </td>
349  </tr>
350</table>
351<!-- ==================== PROPERTIES ==================== -->
352<a name="section-Properties"></a>
353<table class="summary" border="1" cellpadding="3"
354       cellspacing="0" width="100%" bgcolor="white">
355<tr bgcolor="#70b0f0" class="table-header">
356  <td colspan="2" class="table-header">
357    <table border="0" cellpadding="0" cellspacing="0" width="100%">
358      <tr valign="top">
359        <td align="left"><span class="table-header">Properties</span></td>
360        <td align="right" valign="top"
361         ><span class="options">[<a href="#section-Properties"
362         class="privatelink" onclick="toggle_private();"
363         >hide private</a>]</span></td>
364      </tr>
365    </table>
366  </td>
367</tr>
368  <tr>
369    <td colspan="2" class="summary">
370    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
371      <code>__class__</code>
372      </p>
373    </td>
374  </tr>
375</table>
376<!-- ==================== METHOD DETAILS ==================== -->
377<a name="section-MethodDetails"></a>
378<table class="details" border="1" cellpadding="3"
379       cellspacing="0" width="100%" bgcolor="white">
380<tr bgcolor="#70b0f0" class="table-header">
381  <td colspan="2" class="table-header">
382    <table border="0" cellpadding="0" cellspacing="0" width="100%">
383      <tr valign="top">
384        <td align="left"><span class="table-header">Method Details</span></td>
385        <td align="right" valign="top"
386         ><span class="options">[<a href="#section-MethodDetails"
387         class="privatelink" onclick="toggle_private();"
388         >hide private</a>]</span></td>
389      </tr>
390    </table>
391  </td>
392</tr>
393</table>
394<a name="__init__"></a>
395<div>
396<table class="details" border="1" cellpadding="3"
397       cellspacing="0" width="100%" bgcolor="white">
398<tr><td>
399