diff options
| author | Sebastien Martini <seb@dbzteam.org> | 2009-09-02 02:32:50 +0200 |
|---|---|---|
| committer | Sebastien Martini <seb@dbzteam.org> | 2009-09-02 02:32:50 +0200 |
| commit | a75000aa1afe511ce4452f7e7480077f8a8c0f5a (patch) | |
| tree | 595152d8d6e028db4d8e6b90c087cd9d21bf3e4e | |
| parent | 5554734940f8ec44b5272102f6a03069de8f507e (diff) | |
| download | pyinotify-a75000aa1afe511ce4452f7e7480077f8a8c0f5a.tar.gz | |
Updated comments and documentation.
34 files changed, 93 insertions, 93 deletions
diff --git a/docstrings/class-tree.html b/docstrings/class-tree.html index 68dff70..75086b2 100644 --- a/docstrings/class-tree.html +++ b/docstrings/class-tree.html @@ -229,7 +229,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:40 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:18 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/help.html b/docstrings/help.html index 4cbdbb6..d1b8e73 100644 --- a/docstrings/help.html +++ b/docstrings/help.html @@ -246,7 +246,7 @@ page was last updated. </p> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:40 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:18 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/identifier-index.html b/docstrings/identifier-index.html index cccff29..5a6178f 100644 --- a/docstrings/identifier-index.html +++ b/docstrings/identifier-index.html @@ -734,7 +734,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:40 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:18 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/module-tree.html b/docstrings/module-tree.html index 017e2d1..2a71d15 100644 --- a/docstrings/module-tree.html +++ b/docstrings/module-tree.html @@ -83,7 +83,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:40 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:18 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify-module.html b/docstrings/pyinotify-module.html index 45a7d40..6e64d77 100644 --- a/docstrings/pyinotify-module.html +++ b/docstrings/pyinotify-module.html @@ -464,7 +464,7 @@ <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> - <a name="LIBC"></a><span class="summary-name">LIBC</span> = <code title="<CDLL 'libc.so.6', handle 400527f8 at 9ec6b2c>"><CDLL 'libc.so.6', handle 400527f8 at 9ec6b2c></code> + <a name="LIBC"></a><span class="summary-name">LIBC</span> = <code title="<CDLL 'libc.so.6', handle 400537f8 at 8e9a98c>"><CDLL 'libc.so.6', handle 400537f8 at 8e9a98c></code> </td> </tr> <tr> @@ -825,7 +825,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:40 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:18 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify-pysrc.html b/docstrings/pyinotify-pysrc.html index 3cede9f..b14d350 100644 --- a/docstrings/pyinotify-pysrc.html +++ b/docstrings/pyinotify-pysrc.html @@ -59,7 +59,7 @@ <a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"># -*- coding: iso-8859-1 -*-</tt> </tt> <a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"># pyinotify.py - python interface to inotify</tt> </tt> -<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"># Copyright (C) Sébastien Martini <sebastien.martini@gmail.com></tt> </tt> +<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"># Copyright (C) Sebastien Martini <sebastien.martini@gmail.com></tt> </tt> <a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> <a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"># This program is free software; you can redistribute it and/or</tt> </tt> <a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"># modify it under the terms of the GNU General Public License</tt> </tt> @@ -1819,13 +1819,13 @@ pyinotify._SysProcessEvent.__init__" class="py-name" href="#" onclick="return do <a name="L1533"></a><tt class="py-lineno">1533</tt> <tt class="py-line"> <tt class="py-param">auto_add</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">do_glob</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">quiet</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt> <a name="L1534"></a><tt class="py-lineno">1534</tt> <tt class="py-line"> <tt class="py-param">exclude_filter</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> </div><div id="WatchManager.add_watch-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="WatchManager.add_watch-expanded"><a name="L1535"></a><tt class="py-lineno">1535</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> -<a name="L1536"></a><tt class="py-lineno">1536</tt> <tt class="py-line"><tt class="py-docstring"> Add watch(s) on provided |path|(s) with associated |mask| flag</tt> </tt> -<a name="L1537"></a><tt class="py-lineno">1537</tt> <tt class="py-line"><tt class="py-docstring"> value and optionally with a processing |proc_fun| function and the</tt> </tt> +<a name="L1536"></a><tt class="py-lineno">1536</tt> <tt class="py-line"><tt class="py-docstring"> Add watch(s) on the provided |path|(s) with associated |mask| flag</tt> </tt> +<a name="L1537"></a><tt class="py-lineno">1537</tt> <tt class="py-line"><tt class="py-docstring"> value and optionally with a processing |proc_fun| function and</tt> </tt> <a name="L1538"></a><tt class="py-lineno">1538</tt> <tt class="py-line"><tt class="py-docstring"> recursive flag |rec| set to True.</tt> </tt> -<a name="L1539"></a><tt class="py-lineno">1539</tt> <tt class="py-line"><tt class="py-docstring"> Ideally |path| components should not be unicode objects. Note</tt> </tt> -<a name="L1540"></a><tt class="py-lineno">1540</tt> <tt class="py-line"><tt class="py-docstring"> that unicode paths are accepted but are converted to byte strings</tt> </tt> -<a name="L1541"></a><tt class="py-lineno">1541</tt> <tt class="py-line"><tt class="py-docstring"> before a watch is put on the path. The encoding used for converting</tt> </tt> -<a name="L1542"></a><tt class="py-lineno">1542</tt> <tt class="py-line"><tt class="py-docstring"> the unicode object is given by sys.getfilesystemencoding().</tt> </tt> +<a name="L1539"></a><tt class="py-lineno">1539</tt> <tt class="py-line"><tt class="py-docstring"> Ideally |path| components should not be unicode objects. Note that</tt> </tt> +<a name="L1540"></a><tt class="py-lineno">1540</tt> <tt class="py-line"><tt class="py-docstring"> although unicode paths are accepted there are converted to byte</tt> </tt> +<a name="L1541"></a><tt class="py-lineno">1541</tt> <tt class="py-line"><tt class="py-docstring"> strings before a watch is put on that path. The encoding used for</tt> </tt> +<a name="L1542"></a><tt class="py-lineno">1542</tt> <tt class="py-line"><tt class="py-docstring"> converting the unicode object is given by sys.getfilesystemencoding().</tt> </tt> <a name="L1543"></a><tt class="py-lineno">1543</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> <a name="L1544"></a><tt class="py-lineno">1544</tt> <tt class="py-line"><tt class="py-docstring"> @param path: Path to watch, the path can either be a file or a</tt> </tt> <a name="L1545"></a><tt class="py-lineno">1545</tt> <tt class="py-line"><tt class="py-docstring"> directory. Also accepts a sequence (list) of paths.</tt> </tt> @@ -1950,7 +1950,7 @@ pyinotify._SysProcessEvent.__init__" class="py-name" href="#" onclick="return do <a name="L1664"></a><tt class="py-lineno">1664</tt> <tt class="py-line"><tt class="py-docstring"> @return: dict of watch descriptors associated to booleans values.</tt> </tt> <a name="L1665"></a><tt class="py-lineno">1665</tt> <tt class="py-line"><tt class="py-docstring"> True if the corresponding wd has been successfully</tt> </tt> <a name="L1666"></a><tt class="py-lineno">1666</tt> <tt class="py-line"><tt class="py-docstring"> updated, False otherwise.</tt> </tt> -<a name="L1667"></a><tt class="py-lineno">1667</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: dict of int: bool</tt> </tt> +<a name="L1667"></a><tt class="py-lineno">1667</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: dict of {int: bool}</tt> </tt> <a name="L1668"></a><tt class="py-lineno">1668</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> <a name="L1669"></a><tt class="py-lineno">1669</tt> <tt class="py-line"> <tt class="py-name">lwd</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-274" class="py-name"><a title="pyinotify.WatchManager.__format_param" class="py-name" href="#" onclick="return doclink('link-274', '__format_param', 'link-266');">__format_param</a></tt><tt class="py-op">(</tt><tt class="py-name">wd</tt><tt class="py-op">)</tt> </tt> <a name="L1670"></a><tt class="py-lineno">1670</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rec</tt><tt class="py-op">:</tt> </tt> @@ -2071,7 +2071,7 @@ pyinotify._SysProcessEvent.__init__" class="py-name" href="#" onclick="return do <a name="L1785"></a><tt class="py-lineno">1785</tt> <tt class="py-line"><tt class="py-docstring"> @return: dict of watch descriptors associated to booleans values.</tt> </tt> <a name="L1786"></a><tt class="py-lineno">1786</tt> <tt class="py-line"><tt class="py-docstring"> True if the corresponding wd has been successfully</tt> </tt> <a name="L1787"></a><tt class="py-lineno">1787</tt> <tt class="py-line"><tt class="py-docstring"> removed, False otherwise.</tt> </tt> -<a name="L1788"></a><tt class="py-lineno">1788</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: dict of int: bool</tt> </tt> +<a name="L1788"></a><tt class="py-lineno">1788</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: dict of {int: bool}</tt> </tt> <a name="L1789"></a><tt class="py-lineno">1789</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> <a name="L1790"></a><tt class="py-lineno">1790</tt> <tt class="py-line"> <tt class="py-name">lwd</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-290" class="py-name"><a title="pyinotify.WatchManager.__format_param" class="py-name" href="#" onclick="return doclink('link-290', '__format_param', 'link-266');">__format_param</a></tt><tt class="py-op">(</tt><tt class="py-name">wd</tt><tt class="py-op">)</tt> </tt> <a name="L1791"></a><tt class="py-lineno">1791</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rec</tt><tt class="py-op">:</tt> </tt> @@ -2115,8 +2115,8 @@ pyinotify._SysProcessEvent.__init__" class="py-name" href="#" onclick="return do <a name="L1829"></a><tt class="py-lineno">1829</tt> <tt class="py-line"><tt class="py-docstring"> __init__, see transient_file.py example for more</tt> </tt> <a name="L1830"></a><tt class="py-lineno">1830</tt> <tt class="py-line"><tt class="py-docstring"> details.</tt> </tt> <a name="L1831"></a><tt class="py-lineno">1831</tt> <tt class="py-line"><tt class="py-docstring"> @type proc_class: ProcessEvent's instance or of one of its subclasses.</tt> </tt> -<a name="L1832"></a><tt class="py-lineno">1832</tt> <tt class="py-line"><tt class="py-docstring"> @return: See add_watch().</tt> </tt> -<a name="L1833"></a><tt class="py-lineno">1833</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: See add_watch().</tt> </tt> +<a name="L1832"></a><tt class="py-lineno">1832</tt> <tt class="py-line"><tt class="py-docstring"> @return: Same as add_watch().</tt> </tt> +<a name="L1833"></a><tt class="py-lineno">1833</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: Same as add_watch().</tt> </tt> <a name="L1834"></a><tt class="py-lineno">1834</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> <a name="L1835"></a><tt class="py-lineno">1835</tt> <tt class="py-line"> <tt class="py-name">dirname</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">dirname</tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt> </tt> <a name="L1836"></a><tt class="py-lineno">1836</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">dirname</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt> @@ -2310,7 +2310,7 @@ expandto(location.href); <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:42 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:20 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.AsyncNotifier-class.html b/docstrings/pyinotify.AsyncNotifier-class.html index c81ecd8..7ced00f 100644 --- a/docstrings/pyinotify.AsyncNotifier-class.html +++ b/docstrings/pyinotify.AsyncNotifier-class.html @@ -390,7 +390,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:40 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:18 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.ChainIfTrue-class.html b/docstrings/pyinotify.ChainIfTrue-class.html index 12eee01..0d2fd17 100644 --- a/docstrings/pyinotify.ChainIfTrue-class.html +++ b/docstrings/pyinotify.ChainIfTrue-class.html @@ -306,7 +306,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:40 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.Color-class.html b/docstrings/pyinotify.Color-class.html index fecae24..68c26bc 100644 --- a/docstrings/pyinotify.Color-class.html +++ b/docstrings/pyinotify.Color-class.html @@ -377,7 +377,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:40 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.Event-class.html b/docstrings/pyinotify.Event-class.html index 635d140..e7ce7fd 100644 --- a/docstrings/pyinotify.Event-class.html +++ b/docstrings/pyinotify.Event-class.html @@ -257,7 +257,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:40 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.EventsCodes-class.html b/docstrings/pyinotify.EventsCodes-class.html index 20f66f5..f803239 100644 --- a/docstrings/pyinotify.EventsCodes-class.html +++ b/docstrings/pyinotify.EventsCodes-class.html @@ -694,7 +694,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.ExcludeFilter-class.html b/docstrings/pyinotify.ExcludeFilter-class.html index c8be55d..bbf290e 100644 --- a/docstrings/pyinotify.ExcludeFilter-class.html +++ b/docstrings/pyinotify.ExcludeFilter-class.html @@ -306,7 +306,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.Notifier-class.html b/docstrings/pyinotify.Notifier-class.html index 9485219..bad0a1d 100644 --- a/docstrings/pyinotify.Notifier-class.html +++ b/docstrings/pyinotify.Notifier-class.html @@ -59,7 +59,6 @@ <center> <center> <map id="uml_class_diagram_for_pyinotif_7" name="uml_class_diagram_for_pyinotif_7"> <area shape="rect" href="pyinotify.AsyncNotifier-class.html" title="This notifier inherits from asyncore.file_dispatcher in order to be able to use pyinotify along with the asyncore framework." alt="" coords="207,216,297,243"/> -<area shape="rect" href="pyinotify.ThreadedNotifier-class.html" title="This notifier inherits from threading.Thread for instanciating a separate thread, and also inherits from Notifier, because it is a threaded notifier." alt="" coords="348,216,455,243"/> <area shape="rect" href="pyinotify.Notifier-class.html#__init__" title="Initialization." alt="" coords="17,36,636,55"/> <area shape="rect" href="pyinotify.Notifier-class.html#append_event" title="Append a raw event to the event queue." alt="" coords="17,55,636,73"/> <area shape="rect" href="pyinotify.Notifier-class.html#proc_fun" title="pyinotify.Notifier.proc_fun" alt="" coords="17,73,636,92"/> @@ -69,6 +68,7 @@ <area shape="rect" href="pyinotify.Notifier-class.html#loop" title="Events are read only once time every min(read_freq, timeout) seconds at  best and only if the size to read is >= treshold." alt="" coords="17,148,636,167"/> <area shape="rect" href="pyinotify.Notifier-class.html#stop" title="Close inotify's instance (close its file descriptor)." alt="" coords="17,167,636,185"/> <area shape="rect" href="pyinotify.Notifier-class.html" title="Read notifications, process events." alt="" coords="16,11,637,187"/> +<area shape="rect" href="pyinotify.ThreadedNotifier-class.html" title="This notifier inherits from threading.Thread for instanciating a separate thread, and also inherits from Notifier, because it is a threaded notifier." alt="" coords="348,216,455,243"/> </map> <img src="uml_class_diagram_for_pyinotif_7.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_7" ismap="ismap" class="graph-without-title" /> </center> @@ -555,7 +555,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.NotifierError-class.html b/docstrings/pyinotify.NotifierError-class.html index 3ffd631..d8e28cc 100644 --- a/docstrings/pyinotify.NotifierError-class.html +++ b/docstrings/pyinotify.NotifierError-class.html @@ -248,7 +248,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.ProcessEvent-class.html b/docstrings/pyinotify.ProcessEvent-class.html index 662b0c2..2ee0505 100644 --- a/docstrings/pyinotify.ProcessEvent-class.html +++ b/docstrings/pyinotify.ProcessEvent-class.html @@ -459,7 +459,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.ProcessEventError-class.html b/docstrings/pyinotify.ProcessEventError-class.html index f9f07b0..22a5d36 100644 --- a/docstrings/pyinotify.ProcessEventError-class.html +++ b/docstrings/pyinotify.ProcessEventError-class.html @@ -248,7 +248,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.PyinotifyError-class.html b/docstrings/pyinotify.PyinotifyError-class.html index 228f281..3c452cc 100644 --- a/docstrings/pyinotify.PyinotifyError-class.html +++ b/docstrings/pyinotify.PyinotifyError-class.html @@ -58,27 +58,27 @@ <h1 class="epydoc">Class PyinotifyError</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#PyinotifyError">source code</a></span></p> <center> <center> <map id="uml_class_diagram_for_pyinotif_11" name="uml_class_diagram_for_pyinotif_11"> -<area shape="rect" href="pyinotify.NotifierError-class.html" title="Notifier Exception." alt="" coords="16,440,99,467"/> -<area shape="rect" href="pyinotify.UnsupportedLibcVersionError-class.html" title="Raised on unsupported libc versions." alt="" coords="149,440,333,467"/> -<area shape="rect" href="pyinotify.ProcessEventError-class.html" title="ProcessEventError Exception." alt="" coords="384,440,507,467"/> -<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="265,28,420,47"/> -<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="265,47,420,65"/> -<area shape="rect" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="265,68,420,87"/> -<area shape="rect" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="265,87,420,105"/> -<area shape="rect" href="javascript:void(0);" title="x[y]" alt="" coords="265,105,420,124"/> -<area shape="rect" href="javascript:void(0);" title="x[i:j]" alt="" coords="265,124,420,143"/> -<area shape="rect" href="javascript:void(0);" title="helper for pickle" alt="" coords="265,143,420,161"/> -<area shape="rect" href="javascript:void(0);" title="repr(x)" alt="" coords="265,161,420,180"/> -<area shape="rect" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="265,180,420,199"/> -<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="265,199,420,217"/> -<area shape="rect" href="javascript:void(0);" title="str(x)" alt="" coords="265,217,420,236"/> -<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="265,236,420,255"/> -<area shape="rect" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="264,11,421,256"/> -<area shape="rect" href="javascript:void(0);" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="280,311,405,329"/> -<area shape="rect" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="280,329,405,348"/> -<area shape="rect" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="279,285,407,349"/> -<area shape="rect" href="pyinotify.PyinotifyError-class.html" title="Indicates exceptions raised by a Pyinotify class." alt="" coords="301,379,384,411"/> -<area shape="rect" href="pyinotify.UnsupportedPythonVersionError-class.html" title="Raised on unsupported Python versions." alt="" coords="557,440,757,467"/> +<area shape="rect" href="pyinotify.PyinotifyError-class.html" title="Indicates exceptions raised by a Pyinotify class." alt="" coords="419,379,501,411"/> +<area shape="rect" href="pyinotify.UnsupportedPythonVersionError-class.html" title="Raised on unsupported Python versions." alt="" coords="16,440,216,467"/> +<area shape="rect" href="pyinotify.UnsupportedLibcVersionError-class.html" title="Raised on unsupported libc versions." alt="" coords="267,440,451,467"/> +<area shape="rect" href="pyinotify.ProcessEventError-class.html" title="ProcessEventError Exception." alt="" coords="501,440,624,467"/> +<area shape="rect" href="pyinotify.NotifierError-class.html" title="Notifier Exception." alt="" coords="675,440,757,467"/> +<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="383,28,537,47"/> +<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="383,47,537,65"/> +<area shape="rect" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="383,68,537,87"/> +<area shape="rect" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="383,87,537,105"/> +<area shape="rect" href="javascript:void(0);" title="x[y]" alt="" coords="383,105,537,124"/> +<area shape="rect" href="javascript:void(0);" title="x[i:j]" alt="" coords="383,124,537,143"/> +<area shape="rect" href="javascript:void(0);" title="helper for pickle" alt="" coords="383,143,537,161"/> +<area shape="rect" href="javascript:void(0);" title="repr(x)" alt="" coords="383,161,537,180"/> +<area shape="rect" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="383,180,537,199"/> +<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="383,199,537,217"/> +<area shape="rect" href="javascript:void(0);" title="str(x)" alt="" coords="383,217,537,236"/> +<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="383,236,537,255"/> +<area shape="rect" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="381,11,539,256"/> +<area shape="rect" href="javascript:void(0);" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="397,311,523,329"/> +<area shape="rect" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="397,329,523,348"/> +<area shape="rect" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="396,285,524,349"/> </map> <img src="uml_class_diagram_for_pyinotif_11.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_11" ismap="ismap" class="graph-without-title" /> </center> @@ -186,7 +186,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.PyinotifyLogger-class.html b/docstrings/pyinotify.PyinotifyLogger-class.html index 4a08eec..df93a06 100644 --- a/docstrings/pyinotify.PyinotifyLogger-class.html +++ b/docstrings/pyinotify.PyinotifyLogger-class.html @@ -269,7 +269,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.Stats-class.html b/docstrings/pyinotify.Stats-class.html index 68070ab..c835a47 100644 --- a/docstrings/pyinotify.Stats-class.html +++ b/docstrings/pyinotify.Stats-class.html @@ -443,7 +443,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.SysCtlINotify-class.html b/docstrings/pyinotify.SysCtlINotify-class.html index fea2efe..83c527e 100644 --- a/docstrings/pyinotify.SysCtlINotify-class.html +++ b/docstrings/pyinotify.SysCtlINotify-class.html @@ -467,7 +467,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.ThreadedNotifier-class.html b/docstrings/pyinotify.ThreadedNotifier-class.html index 0e7c455..7915869 100644 --- a/docstrings/pyinotify.ThreadedNotifier-class.html +++ b/docstrings/pyinotify.ThreadedNotifier-class.html @@ -428,7 +428,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.UnicodeLogRecord-class.html b/docstrings/pyinotify.UnicodeLogRecord-class.html index 15452d1..2f05d47 100644 --- a/docstrings/pyinotify.UnicodeLogRecord-class.html +++ b/docstrings/pyinotify.UnicodeLogRecord-class.html @@ -237,7 +237,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.UnsupportedLibcVersionError-class.html b/docstrings/pyinotify.UnsupportedLibcVersionError-class.html index 408a42e..3980b02 100644 --- a/docstrings/pyinotify.UnsupportedLibcVersionError-class.html +++ b/docstrings/pyinotify.UnsupportedLibcVersionError-class.html @@ -248,7 +248,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.UnsupportedPythonVersionError-class.html b/docstrings/pyinotify.UnsupportedPythonVersionError-class.html index e19b860..a696d34 100644 --- a/docstrings/pyinotify.UnsupportedPythonVersionError-class.html +++ b/docstrings/pyinotify.UnsupportedPythonVersionError-class.html @@ -248,7 +248,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.Watch-class.html b/docstrings/pyinotify.Watch-class.html index ef3ac3d..3610511 100644 --- a/docstrings/pyinotify.Watch-class.html +++ b/docstrings/pyinotify.Watch-class.html @@ -266,7 +266,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.WatchManager-class.html b/docstrings/pyinotify.WatchManager-class.html index 74cacae..bd4d0ae 100644 --- a/docstrings/pyinotify.WatchManager-class.html +++ b/docstrings/pyinotify.WatchManager-class.html @@ -62,7 +62,7 @@ <area shape="rect" href="pyinotify.WatchManager-class.html#get_fd" title="Return assigned inotify's file descriptor." alt="" coords="17,55,732,73"/> <area shape="rect" href="pyinotify.WatchManager-class.html#get_watch" title="Get watch from provided watch descriptor wd." alt="" coords="17,73,732,92"/> <area shape="rect" href="pyinotify.WatchManager-class.html#del_watch" title="Remove watch entry associated to watch descriptor wd." alt="" coords="17,92,732,111"/> -<area shape="rect" href="pyinotify.WatchManager-class.html#add_watch" title="Add watch(s) on provided |path|(s) with associated |mask| flag value and  optionally with a processing |proc_fun| function and the recursive flag  |rec| set to True." alt="" coords="17,111,732,129"/> +<area shape="rect" href="pyinotify.WatchManager-class.html#add_watch" title="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." alt="" coords="17,111,732,129"/> <area shape="rect" href="pyinotify.WatchManager-class.html#update_watch" title="Update existing watch descriptors |wd|." alt="" coords="17,129,732,148"/> <area shape="rect" href="pyinotify.WatchManager-class.html#get_wd" title="Returns the watch descriptor associated to path." alt="" coords="17,148,732,167"/> <area shape="rect" href="pyinotify.WatchManager-class.html#get_path" title="Returns the path associated to WD, if WD is unknown it returns None." alt="" coords="17,167,732,185"/> @@ -103,7 +103,7 @@ <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"><function <lambda> at 0x9ecb454></span>)</span><br /> + <span class="summary-sig-arg">exclude_filter</span>=<span class="summary-sig-default"><function <lambda> at 0x8e9e294></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 code</a></span> @@ -222,8 +222,8 @@ <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 provided |path|(s) with associated |mask| flag value - and optionally with a processing |proc_fun| function and the + 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 code</a></span> @@ -255,7 +255,7 @@ </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">dict of int: bool</span> + <span class="summary-type">dict of {int: bool}</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> @@ -352,7 +352,7 @@ </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">dict of int: bool</span> + <span class="summary-type">dict of {int: bool}</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> @@ -372,7 +372,7 @@ </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">See add_watch().</span> + <span class="summary-type">Same as add_watch().</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> @@ -461,7 +461,7 @@ <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"><function <lambda> at 0x9ecb454></span>)</span> + <span class="sig-arg">exclude_filter</span>=<span class="sig-default"><function <lambda> at 0x8e9e294></span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" @@ -599,12 +599,12 @@ </td> </tr></table> - <p>Add watch(s) on provided |path|(s) with associated |mask| flag value - and optionally with a processing |proc_fun| function and the recursive + <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 unicode paths are accepted but are converted to byte - strings before a watch is put on the path. The encoding used for - converting the unicode object is given by + 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().</p> <dl class="fields"> <dt>Parameters:</dt> @@ -699,7 +699,7 @@ <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> + <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> @@ -844,7 +844,7 @@ <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> + <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> @@ -879,8 +879,8 @@ ProcessEvent's instance as argument into __init__, see transient_file.py example for more details.</li> </ul></dd> - <dt>Returns: See add_watch().</dt> - <dd>See add_watch().</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 @@ -919,7 +919,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:19 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify.WatchManagerError-class.html b/docstrings/pyinotify.WatchManagerError-class.html index b184a1d..e9ab95f 100644 --- a/docstrings/pyinotify.WatchManagerError-class.html +++ b/docstrings/pyinotify.WatchManagerError-class.html @@ -252,7 +252,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:20 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify._Event-class.html b/docstrings/pyinotify._Event-class.html index 7a486e9..537b1c8 100644 --- a/docstrings/pyinotify._Event-class.html +++ b/docstrings/pyinotify._Event-class.html @@ -273,7 +273,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:20 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify._ProcessEvent-class.html b/docstrings/pyinotify._ProcessEvent-class.html index 4fec91a..533c3b1 100644 --- a/docstrings/pyinotify._ProcessEvent-class.html +++ b/docstrings/pyinotify._ProcessEvent-class.html @@ -300,7 +300,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:41 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:20 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify._RawEvent-class.html b/docstrings/pyinotify._RawEvent-class.html index 0272935..9c959f2 100644 --- a/docstrings/pyinotify._RawEvent-class.html +++ b/docstrings/pyinotify._RawEvent-class.html @@ -236,7 +236,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:42 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:20 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/pyinotify._SysProcessEvent-class.html b/docstrings/pyinotify._SysProcessEvent-class.html index 2ada358..28b7e29 100644 --- a/docstrings/pyinotify._SysProcessEvent-class.html +++ b/docstrings/pyinotify._SysProcessEvent-class.html @@ -474,7 +474,7 @@ <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Fri Aug 28 11:36:42 2009 + Generated by Epydoc 3.0.1 on Wed Sep 2 02:31:20 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" diff --git a/docstrings/uml_class_diagram_for_pyinotif_11.gif b/docstrings/uml_class_diagram_for_pyinotif_11.gif Binary files differindex 72a7c13..af6b723 100644 --- a/docstrings/uml_class_diagram_for_pyinotif_11.gif +++ b/docstrings/uml_class_diagram_for_pyinotif_11.gif diff --git a/docstrings/uml_class_diagram_for_pyinotif_20.gif b/docstrings/uml_class_diagram_for_pyinotif_20.gif Binary files differindex be8fdb5..12bfdd8 100644 --- a/docstrings/uml_class_diagram_for_pyinotif_20.gif +++ b/docstrings/uml_class_diagram_for_pyinotif_20.gif diff --git a/pyinotify.py b/pyinotify.py index 35fa277..5f6c6c9 100755 --- a/pyinotify.py +++ b/pyinotify.py @@ -2,7 +2,7 @@ # -*- coding: iso-8859-1 -*- # # pyinotify.py - python interface to inotify -# Copyright (C) Sébastien Martini <sebastien.martini@gmail.com> +# Copyright (C) Sebastien Martini <sebastien.martini@gmail.com> # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License @@ -1533,13 +1533,13 @@ class WatchManager: auto_add=False, do_glob=False, quiet=True, exclude_filter=None): """ - Add watch(s) on provided |path|(s) with associated |mask| flag - value and optionally with a processing |proc_fun| function and the + 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 unicode paths are accepted but are converted to byte strings - before a watch is put on the path. The encoding used for converting - the unicode object is given by sys.getfilesystemencoding(). + 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(). @param path: Path to watch, the path can either be a file or a directory. Also accepts a sequence (list) of paths. @@ -1664,7 +1664,7 @@ class WatchManager: @return: dict of watch descriptors associated to booleans values. True if the corresponding wd has been successfully updated, False otherwise. - @rtype: dict of int: bool + @rtype: dict of {int: bool} """ lwd = self.__format_param(wd) if rec: @@ -1785,7 +1785,7 @@ class WatchManager: @return: dict of watch descriptors associated to booleans values. True if the corresponding wd has been successfully removed, False otherwise. - @rtype: dict of int: bool + @rtype: dict of {int: bool} """ lwd = self.__format_param(wd) if rec: @@ -1829,8 +1829,8 @@ class WatchManager: __init__, see transient_file.py example for more details. @type proc_class: ProcessEvent's instance or of one of its subclasses. - @return: See add_watch(). - @rtype: See add_watch(). + @return: Same as add_watch(). + @rtype: Same as add_watch(). """ dirname = os.path.dirname(filename) if dirname == '': |
