Changeset 8da69de7c06c68aed453c8a97d49f4e64bd41711

Timestamp:

03/31/08 19:54:30 (9 months ago)

Author:

Sebastien Martini <ookoi@…>

Parents:

9b43851fd710e7a621e8b31f157e50c23720cd53

Children:

53d2896aa1f94c5967209749f0d272412496f447

git-committer:

Sebastien Martini <ookoi@mars.(none)> / 2008-03-31T19:54:30Z+0200

Message:

New parameter 'quiet' for methods add_watch, update_watch
and rm_watch.

Files:

• ChangeLog (modified) (1 diff)
• not_quiet.py (added)
• pyinotify.py (modified) (16 diffs)

ChangeLog

@@ +1 @@
+2008-03-31  ookoi  <ookoi@mars>
+
+        * ChangeLog is now maintained directly with git:
+          See http://git.dbzteam.org/?p=pyinotify.git;a=log;h=HEAD
+
 2008-03-24  ookoi  <ookoi@sundae>
 

pyinotify.py

@@ -56 +56 @@
 __author__ = "seb@dbzteam.org (Sebastien Martini)"
 
-__version__ = "0.8.0p"
+__version__ = "0.8.0q"
 
 __metaclass__ = type  # Use new-style classes by default
@@ -865 +865 @@
                           poll is blocking waiting for something to read.
         @type read_freq: int
-        @param treshold: file descriptor will be read only if its size to
+        @param treshold: File descriptor will be read only if its size to
                          read is >= treshold. If != 0, you likely want to
                          use it in combination with read_freq because
@@ -1063 +1063 @@
         seconds at best and only if the size to read is >= treshold.
 
-        @param callback: functor called after each event processing.
+        @param callback: Functor called after each event processing. Expects
+                         to receive notifier object (self) as first parameter.
         @type callback: callable
-        @param daemonize: this thread is daemonized if set to True.
+        @param daemonize: This thread is daemonized if set to True.
         @type daemonize: boolean
         """
@@ -1124 +1125 @@
                           max(0, read_freq - timeout) seconds.
         @type read_freq: int
-        @param treshold: file descriptor will be read only if its size to
+        @param treshold: File descriptor will be read only if its size to
                          read is >= treshold. If != 0, you likely want to
                          use it in combination with read_freq because
@@ -1226 +1227 @@
 
 
+class WatchManagerError(Exception):
+    """
+    WatchManager Exception. Raised on error encountered on watches
+    operations.
+
+    """
+    def __init__(self, msg, wmd):
+        """
+        @param msg: Exception string's description.
+        @type msg: string
+        @param wmd: Results of previous operations made by the same function
+                    on previous wd or paths. It also contains the item which
+                    raised this exception.
+        @type wmd: dict
+        """
+        self.wmd = wmd
+        Exception.__init__(self, msg)
+
+
 class WatchManager:
     """
@@ -1248 +1268 @@
         wd_ = LIBC.inotify_add_watch(self._fd, path, mask)
         if wd_ < 0:
-            log.error('add_watch: cannot watch %s (WD=%d)' % (path, wd_))
             return wd_
         watch_ = Watch(wd=wd_, path=os.path.normpath(path), mask=mask,
@@ -1263 +1282 @@
 
     def add_watch(self, path, mask, proc_fun=None, rec=False,
-                  auto_add=False, do_glob=False):
+                  auto_add=False, do_glob=False, quiet=True):
         """
         Add watch(s) on given path(s) with the specified mask and
@@ -1285 +1304 @@
         @param do_glob: Do globbing on pathname.
         @type do_glob: bool
+        @param quiet: if True raise an WatchManagerError exception on
+                      error. See example not_quiet.py
+        @type quiet: bool
         @return: dict of paths associated to watch descriptors. A wd value
                  is positive if the watch has been sucessfully added,
@@ -1299 +1321 @@
                 # recursively list subdirs according to rec param
                 for rpath in self.__walk_rec(apath, rec):
-                    ret_[rpath] = self.__add_watch(rpath, mask,
-                                                   proc_fun, auto_add)
+                    wd = ret_[rpath] = self.__add_watch(rpath, mask,
+                                                        proc_fun, auto_add)
+                    if wd < 0:
+                        err = 'add_watch: cannot watch %s (WD=%d)' % (rpath,
+                                                                      wd)
+                        if quiet:
+                            log.error(err)
+                        else:
+                            raise WatchManagerError(err, ret_)
         return ret_
 
@@ -1339 +1368 @@
 
     def update_watch(self, wd, mask=None, proc_fun=None, rec=False,
-                     auto_add=False):
+                     auto_add=False, quiet=True):
         """
         Update existing watch(s). Both the mask and the processing
@@ -1358 +1387 @@
                          directories in the watch's path.
         @type auto_add: bool
+        @param quiet: if True raise an WatchManagerError exception on
+                      error. See example not_quiet.py
+        @type quiet: bool
         @return: dict of watch descriptors associated to booleans values.
                  True if the corresponding wd has been successfully
@@ -1371 +1403 @@
             apath = self.get_path(awd)
             if not apath or awd < 0:
-                log.error('update_watch: invalid WD=%d' % awd)
-                continue
+                err = 'update_watch: invalid WD=%d' % awd
+                if quiet:
+                    log.error(err)
+                    continue
+                raise WatchManagerError(err, ret_)
 
             if mask:
@@ -1378 +1413 @@
                 if wd_ < 0:
                     ret_[awd] = False
-                    log.error(('update_watch: cannot update WD=%d (%s)'%
-                               (wd_, apath)))
-                    continue
+                    err = 'update_watch: cannot update WD=%d (%s)' % (wd_,
+                                                                      apath)
+                    if quiet:
+                        log.error(err)
+                        continue
+                    raise WatchManagerError(err, ret_)
+
                 assert(awd == wd_)
 
@@ -1459 +1498 @@
                 yield root
 
-    def rm_watch(self, wd, rec=False):
+    def rm_watch(self, wd, rec=False, quiet=True):
         """
         Removes watch(s).
@@ -1469 +1508 @@
                     subdirectories and subfiles.
         @type rec: bool
+        @param quiet: if True raise an WatchManagerError exception on
+                      error. See example not_quiet.py
+        @type quiet: bool
         @return: dict of watch descriptors associated to booleans values.
                  True if the corresponding wd has been successfully
@@ -1484 +1526 @@
             if wd_ < 0:
                 ret_[awd] = False
-                log.error('rm_watch: cannot remove WD=%d' % awd)
-                continue
+                err = 'rm_watch: cannot remove WD=%d' % awd
+                if quiet:
+                    log.error(err)
+                    continue
+                raise WatchManagerError(err, ret_)
 
             ret_[awd] = True