summaryrefslogtreecommitdiff
path: root/pyinotify.WatchManager-class.html
blob: 204abd1eafc52cd7ee7e75f70bf7fd9b4010cf1c (plain)
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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
<?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.WatchManager</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>&nbsp;&nbsp;&nbsp;<a
        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;pyinotify</a> ::
        Class&nbsp;WatchManager
      </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&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pyinotify.WatchManager-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class WatchManager</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_pyinotif_24" name="uml_class_diagram_for_pyinotif_24">
<area shape="rect" id="node1_15" href="pyinotify.WatchManager-class.html#watches" title="Get a reference on the internal watch manager dictionary." alt="" coords="17,29,740,49"/>
<area shape="rect" id="node1_16" href="pyinotify.WatchManager-class.html#ignore_events" title="pyinotify.WatchManager.ignore_events" alt="" coords="17,49,740,69"/>
<area shape="rect" id="node1_17" href="pyinotify.WatchManager-class.html#__init__" title="Initialization: init inotify, init watch manager dictionary." alt="" coords="17,72,740,92"/>
<area shape="rect" id="node1_18" href="pyinotify.WatchManager-class.html#close" title="Close inotify&#39;s file descriptor, this action will also automatically remove (i.e." alt="" coords="17,92,740,112"/>
<area shape="rect" id="node1_19" href="pyinotify.WatchManager-class.html#get_fd" title="Return assigned inotify&#39;s file descriptor." alt="" coords="17,112,740,132"/>
<area shape="rect" id="node1_20" href="pyinotify.WatchManager-class.html#get_watch" title="Get watch from provided watch descriptor wd." alt="" coords="17,132,740,152"/>
<area shape="rect" id="node1_21" href="pyinotify.WatchManager-class.html#del_watch" title="Remove watch entry associated to watch descriptor wd." alt="" coords="17,152,740,172"/>
<area shape="rect" id="node1_22" href="pyinotify.WatchManager-class.html#add_watch" title="Add watch(s) on the provided |path|(s) with associated |mask| flag value &#160;and optionally with a processing |proc_fun| function and recursive flag &#160;|rec| set to True." alt="" coords="17,172,740,192"/>
<area shape="rect" id="node1_23" href="pyinotify.WatchManager-class.html#update_watch" title="Update existing watch descriptors |wd|." alt="" coords="17,192,740,212"/>
<area shape="rect" id="node1_24" href="pyinotify.WatchManager-class.html#get_wd" title="Returns the watch descriptor associated to path." alt="" coords="17,212,740,232"/>
<area shape="rect" id="node1_25" href="pyinotify.WatchManager-class.html#get_path" title="Returns the path associated to WD, if WD is unknown it returns None." alt="" coords="17,232,740,252"/>
<area shape="rect" id="node1_26" href="pyinotify.WatchManager-class.html#rm_watch" title="Removes watch(s)." alt="" coords="17,252,740,272"/>
<area shape="rect" id="node1_27" href="pyinotify.WatchManager-class.html#watch_transient_file" title="Watch a transient file, which will be created and deleted frequently over &#160;time (e.g." alt="" coords="17,272,740,292"/>
<area shape="rect" id="node1_28" href="pyinotify.WatchManager-class.html#get_ignore_events" title="pyinotify.WatchManager.get_ignore_events" alt="" coords="17,292,740,312"/>
<area shape="rect" id="node1_29" href="pyinotify.WatchManager-class.html#set_ignore_events" title="pyinotify.WatchManager.set_ignore_events" alt="" coords="17,312,740,332"/>
<area shape="rect" id="node1" href="pyinotify.WatchManager-class.html" title="Provide operations for watching files and directories." alt="" coords="5,5,752,339"/>
</map>
  <img src="uml_class_diagram_for_pyinotif_24.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_24" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Provide operations for watching files and directories. Its internal 
  dictionary is used to reference watched items. When used inside threaded 
  code, one must instanciate as many WatchManager instances as there are 
  ThreadedNotifier instances.</p>

<!-- ==================== 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">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">exclude_filter</span>=<span class="summary-sig-default">&lt;function &lt;lambda&gt; at 0x7f64fff3ede8&gt;</span>)</span><br />
      Initialization: init inotify, init watch manager dictionary.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Close inotify's file descriptor, this action will also automatically 
      remove (i.e.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.close">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#get_fd" class="summary-sig-name">get_fd</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Return assigned inotify's file descriptor.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_fd">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#get_watch" class="summary-sig-name">get_watch</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">wd</span>)</span><br />
      Get watch from provided watch descriptor wd.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_watch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#del_watch" class="summary-sig-name">del_watch</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">wd</span>)</span><br />
      Remove watch entry associated to watch descriptor wd.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.del_watch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__format_path"></a><span class="summary-sig-name">__format_path</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path</span>)</span><br />
      Format path to its internal (stored in watch manager) representation.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__format_path">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#__add_watch" class="summary-sig-name" onclick="show_private();">__add_watch</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path</span>,
        <span class="summary-sig-arg">mask</span>,
        <span class="summary-sig-arg">proc_fun</span>,
        <span class="summary-sig-arg">auto_add</span>,
        <span class="summary-sig-arg">exclude_filter</span>)</span><br />
      Add a watch on path, build a Watch object and insert it in the watch 
      manager dictionary.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__add_watch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__glob"></a><span class="summary-sig-name">__glob</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path</span>,
        <span class="summary-sig-arg">do_glob</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__glob">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">dict of {str: int}</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">path</span>,
        <span class="summary-sig-arg">mask</span>,
        <span class="summary-sig-arg">proc_fun</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">rec</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">auto_add</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">do_glob</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">quiet</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">exclude_filter</span>=<span class="summary-sig-default">None</span>)</span><br />
      Add watch(s) on the provided |path|(s) with associated |mask| flag 
      value and optionally with a processing |proc_fun| function and 
      recursive flag |rec| set to True.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.add_watch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list of int</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#__get_sub_rec" class="summary-sig-name" onclick="show_private();">__get_sub_rec</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">lpath</span>)</span><br />
      Get every wd from self._wmd if its path is under the path of one (at 
      least) of those in lpath.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__get_sub_rec">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">dict of {int: bool}</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">wd</span>,
        <span class="summary-sig-arg">mask</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">proc_fun</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">rec</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">auto_add</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">quiet</span>=<span class="summary-sig-default">True</span>)</span><br />
      Update existing watch descriptors |wd|.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.update_watch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list of type(param)</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#__format_param" class="summary-sig-name" onclick="show_private();">__format_param</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">param</span>)</span><br />
      Returns:
      wrap param.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__format_param">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int or None</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">path</span>)</span><br />
      Returns the watch descriptor associated to path.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_wd">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string or None</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">wd</span>)</span><br />
      Returns the path associated to WD, if WD is unknown it returns None.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_path">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#__walk_rec" class="summary-sig-name" onclick="show_private();">__walk_rec</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">top</span>,
        <span class="summary-sig-arg">rec</span>)</span><br />
      Yields each subdirectories of top, doesn't follow symlinks.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__walk_rec">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">dict of {int: bool}</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">wd</span>,
        <span class="summary-sig-arg">rec</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">quiet</span>=<span class="summary-sig-default">True</span>)</span><br />
      Removes watch(s).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.rm_watch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">Same as add_watch().</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">filename</span>,
        <span class="summary-sig-arg">mask</span>,
        <span class="summary-sig-arg">proc_class</span>)</span><br />
      Watch a transient file, which will be created and deleted frequently 
      over time (e.g.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.watch_transient_file">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_ignore_events"></a><span class="summary-sig-name">get_ignore_events</span>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_ignore_events">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="set_ignore_events"></a><span class="summary-sig-name">set_ignore_events</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">nval</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.set_ignore_events">source&nbsp;code</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>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</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 width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">dict</span>
    </td><td class="summary">
        <a href="pyinotify.WatchManager-class.html#watches" class="summary-name">watches</a><br />
      Get a reference on the internal watch manager dictionary.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyinotify.WatchManager-class.html#ignore_events" class="summary-name">ignore_events</a>
    </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">exclude_filter</span>=<span class="sig-default">&lt;function &lt;lambda&gt; at 0x7f64fff3ede8&gt;</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Initialization: init inotify, init watch manager dictionary. Raise 
  OSError if initialization fails, raise InotifyBindingNotFoundError if no 
  inotify binding was found (through ctypes or from direct access to 
  syscalls).</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>exclude_filter</code></strong> (callable object) - boolean function, returns True if current path must be excluded 
          from being watched. Convenient for providing a common exclusion 
          filter for every call to add_watch.</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="close"></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">close</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.close">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Close inotify's file descriptor, this action will also automatically 
  remove (i.e. stop watching) all its associated watch descriptors. After a
  call to this method the WatchManager's instance become useless and cannot
  be reused, a new instance must then be instanciated. It makes sense to 
  call this method in few situations for instance if several independant 
  WatchManager must be instanciated or if all watches must be removed and 
  no other watches need to be added.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_fd"></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">get_fd</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_fd">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Return assigned inotify's file descriptor.</p>
  <dl class="fields">
    <dt>Returns: int</dt>
        <dd>File descriptor.</dd>
  </dl>
</td></tr></table>
</div>
<a name="get_watch"></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">get_watch</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">wd</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_watch">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Get watch from provided watch descriptor wd.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>wd</code></strong> (int) - Watch descriptor.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="del_watch"></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">del_watch</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">wd</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.del_watch">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Remove watch entry associated to watch descriptor wd.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>wd</code></strong> (int) - Watch descriptor.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="__add_watch"></a>
<div class="private">
<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">__add_watch</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">path</span>,
        <span class="sig-arg">mask</span>,
        <span class="sig-arg">proc_fun</span>,
        <span class="sig-arg">auto_add</span>,
        <span class="sig-arg">exclude_filter</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__add_watch">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Add a watch on path, build a Watch object and insert it in the watch 
  manager dictionary. Return the wd value.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="add_watch"></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">add_watch</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">path</span>,
        <span class="sig-arg">mask</span>,
        <span class="sig-arg">proc_fun</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">rec</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">auto_add</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">do_glob</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">quiet</span>=<span class="sig-default">True</span>,
        <span class="sig-arg">exclude_filter</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.add_watch">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Add watch(s) on the provided |path|(s) with associated |mask| flag 
  value and optionally with a processing |proc_fun| function and recursive 
  flag |rec| set to True. Ideally |path| components should not be unicode 
  objects. Note that although unicode paths are accepted there are 
  converted to byte strings before a watch is put on that path. The 
  encoding used for converting the unicode object is given by 
  sys.getfilesystemencoding(). If |path| is already watched it is ignored, 
  but if it is called with option rec=True a watch is put on each one of 
  its not-watched subdirectory.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>path</code></strong> (string or list of strings) - Path to watch, the path can either be a file or a directory. Also
          accepts a sequence (list) of paths.</li>
        <li><strong class="pname"><code>mask</code></strong> (int) - Bitmask of events.</li>
        <li><strong class="pname"><code>proc_fun</code></strong> (function or ProcessEvent instance or instance of one of its 
          subclasses or callable object.) - Processing object.</li>
        <li><strong class="pname"><code>rec</code></strong> (bool) - Recursively add watches from path on all its subdirectories, set 
          to False by default (doesn't follows symlinks in any case).</li>
        <li><strong class="pname"><code>auto_add</code></strong> (bool) - Automatically add watches on newly created directories in watched
          parent |path| directory. If |auto_add| is True, IN_CREATE is ored
          with |mask| when the watch is added.</li>
        <li><strong class="pname"><code>do_glob</code></strong> (bool) - Do globbing on pathname (see standard globbing module for more 
          informations).</li>
        <li><strong class="pname"><code>quiet</code></strong> (bool) - if False raises a WatchManagerError exception on error. See 
          example not_quiet.py.</li>
        <li><strong class="pname"><code>exclude_filter</code></strong> (callable object) - predicate (boolean function), which returns True if the current 
          path must be excluded from being watched. This argument has 
          precedence over exclude_filter passed to the class' constructor.</li>
    </ul></dd>
    <dt>Returns: dict of {str: int}</dt>
        <dd>dict of paths associated to watch descriptors. A wd value is 
          positive if the watch was added sucessfully, otherwise the value 
          is negative. If the path was invalid or was already watched it is
          not included into this returned dictionary.</dd>
  </dl>
</td></tr></table>
</div>
<a name="__get_sub_rec"></a>
<div class="private">
<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">__get_sub_rec</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">lpath</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__get_sub_rec">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Get every wd from self._wmd if its path is under the path of one (at 
  least) of those in lpath. Doesn't follow symlinks.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>lpath</code></strong> (list of int) - list of watch descriptor</li>
    </ul></dd>
    <dt>Returns: list of int</dt>
        <dd>list of watch descriptor</dd>
  </dl>
</td></tr></table>
</div>
<a name="update_watch"></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">update_watch</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">wd</span>,
        <span class="sig-arg">mask</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">proc_fun</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">rec</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">auto_add</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">quiet</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.update_watch">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Update existing watch descriptors |wd|. The |mask| value, the 
  processing object |proc_fun|, the recursive param |rec| and the 
  |auto_add| and |quiet| flags can all be updated.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>wd</code></strong> (int or list of int) - Watch Descriptor to update. Also accepts a list of watch 
          descriptors.</li>
        <li><strong class="pname"><code>mask</code></strong> (int) - Optional new bitmask of events.</li>
        <li><strong class="pname"><code>proc_fun</code></strong> (function or ProcessEvent instance or instance of one of its 
          subclasses or callable object.) - Optional new processing function.</li>
        <li><strong class="pname"><code>rec</code></strong> (bool) - Optionally adds watches recursively on all subdirectories 
          contained into |wd| directory.</li>
        <li><strong class="pname"><code>auto_add</code></strong> (bool) - Automatically adds watches on newly created directories in the 
          watch's path corresponding to |wd|. If |auto_add| is True, 
          IN_CREATE is ored with |mask| when the watch is updated.</li>
        <li><strong class="pname"><code>quiet</code></strong> (bool) - If False raises a WatchManagerError exception on error. See 
          example not_quiet.py</li>
    </ul></dd>
    <dt>Returns: dict of {int: bool}</dt>
        <dd>dict of watch descriptors associated to booleans values. True if 
          the corresponding wd has been successfully updated, False 
          otherwise.</dd>
  </dl>
</td></tr></table>
</div>
<a name="__format_param"></a>
<div class="private">
<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">__format_param</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">param</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__format_param">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>param</code></strong> (string or int) - Parameter.</li>
    </ul></dd>
    <dt>Returns: list of type(param)</dt>
        <dd>wrap param.</dd>
  </dl>
</td></tr></table>
</div>
<a name="get_wd"></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">get_wd</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">path</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_wd">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the watch descriptor associated to path. This method presents 
  a prohibitive cost, always prefer to keep the WD returned by add_watch().
  If the path is unknown it returns None.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>path</code></strong> (str) - Path.</li>
    </ul></dd>
    <dt>Returns: int or None</dt>
        <dd>WD or None.</dd>
  </dl>
</td></tr></table>
</div>
<a name="get_path"></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">get_path</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">wd</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.get_path">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the path associated to WD, if WD is unknown it returns 
  None.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>wd</code></strong> (int) - Watch descriptor.</li>
    </ul></dd>
    <dt>Returns: string or None</dt>
        <dd>Path or None.</dd>
  </dl>
</td></tr></table>
</div>
<a name="__walk_rec"></a>
<div class="private">
<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">__walk_rec</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">top</span>,
        <span class="sig-arg">rec</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.__walk_rec">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Yields each subdirectories of top, doesn't follow symlinks. If rec is 
  false, only yield top.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>top</code></strong> (string) - root directory.</li>
        <li><strong class="pname"><code>rec</code></strong> (bool) - recursive flag.</li>
    </ul></dd>
    <dt>Returns: string</dt>
        <dd>path of one subdirectory.</dd>
  </dl>
</td></tr></table>
</div>
<a name="rm_watch"></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">rm_watch</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">wd</span>,
        <span class="sig-arg">rec</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">quiet</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.rm_watch">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes watch(s).</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>wd</code></strong> (int or list of int.) - Watch Descriptor of the file or directory to unwatch. Also 
          accepts a list of WDs.</li>
        <li><strong class="pname"><code>rec</code></strong> (bool) - Recursively removes watches on every already watched 
          subdirectories and subfiles.</li>
        <li><strong class="pname"><code>quiet</code></strong> (bool) - If False raises a WatchManagerError exception on error. See 
          example not_quiet.py</li>
    </ul></dd>
    <dt>Returns: dict of {int: bool}</dt>
        <dd>dict of watch descriptors associated to booleans values. True if 
          the corresponding wd has been successfully removed, False 
          otherwise.</dd>
  </dl>
</td></tr></table>
</div>
<a name="watch_transient_file"></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">watch_transient_file</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>,
        <span class="sig-arg">mask</span>,
        <span class="sig-arg">proc_class</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyinotify-pysrc.html#WatchManager.watch_transient_file">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Watch a transient file, which will be created and deleted frequently 
  over time (e.g. pid file).</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>filename</code></strong> (string) - Filename.</li>
        <li><strong class="pname"><code>mask</code></strong> (int) - Bitmask of events, should contain IN_CREATE and IN_DELETE.</li>
        <li><strong class="pname"><code>proc_class</code></strong> (ProcessEvent's instance or of one of its subclasses.) - ProcessEvent (or of one of its subclass), beware of accepting a 
          ProcessEvent's instance as argument into __init__, see 
          transient_file.py example for more details.</li>
    </ul></dd>
    <dt>Returns: Same as add_watch().</dt>
        <dd>Same as add_watch().</dd>
  </dl>
<div class="fields">      <p><strong>Attention:</strong>
        Currently under the call to this function it is not possible to 
        correctly watch the events triggered into the same base directory 
        than the directory where is located this watched transient file. 
        For instance it would be wrong to make these two successive calls: 
        wm.watch_transient_file('/var/run/foo.pid', ...) and 
        wm.add_watch('/var/run/', ...)
      </p>
</div></td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></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">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="watches"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">watches</h3>
  <p>Get a reference on the internal watch manager dictionary.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.watches(<span class="summary-sig-arg">self</span>)</span>
        - Get a reference on the internal watch manager dictionary.
    </dd>
    <dt>Type:</dt>
      <dd>dict</dd>
  </dl>
</td></tr></table>
</div>
<a name="ignore_events"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">ignore_events</h3>
  
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#get_ignore_events" class="summary-sig-name">get_ignore_events</a>(<span class="summary-sig-arg">self</span>)</span>
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="pyinotify.WatchManager-class.html#set_ignore_events" class="summary-sig-name">set_ignore_events</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">nval</span>)</span>
    </dd>
    <dt>Delete Method:</dt>
    <dd class="value"><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">Make watch manager ignoring new events.</code><code class="variable-quote">'</code>
</pre></td></tr></table>

    </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>&nbsp;&nbsp;&nbsp;<a
        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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:21 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>