Merge pull request seb-m#85 from dano/master

Add asyncio-compatible Notifier sub-class.

python2/pyinotify.py

@@ -1604,6 +1604,39 @@ def handle_read(self, *args, **kwargs):
             self.handle_read_callback(self)
 
 
+class AsyncioNotifier(Notifier):
+    """
+
+    asyncio/trollius event loop adapter.
+
+    """
+    def __init__(self, watch_manager, loop, callback=None,
+                 default_proc_fun=None, read_freq=0, threshold=0, timeout=None):
+        """
+
+        See examples/asyncio_notifier.py for an example usage.
+
+        @param loop: asyncio or trollius event loop instance.
+        @type loop: asyncio.BaseEventLoop or trollius.BaseEventLoop instance.
+        @param callback: Functor called at the end of each call to handle_read.
+                         Expects to receive the notifier object (self) as 
+                         single parameter.
+        @type callback: callable object or function
+
+        """
+        self.loop = loop
+        self.handle_read_callback = callback
+        Notifier.__init__(self, watch_manager, default_proc_fun, read_freq,
+                          threshold, timeout)
+        loop.add_reader(self._fd, self.handle_read)
+
+    def handle_read(self, *args, **kwargs):
+        self.read_events()
+        self.process_events()
+        if self.handle_read_callback is not None:
+            self.handle_read_callback(self)
+
+
 class Watch:
     """
     Represent a watch, i.e. a file or directory being watched.

python3/examples/asyncio_notifier.py

@@ -0,0 +1,20 @@
+import pyinotify
+import asyncio
+
+
+def handle_read_callback(notifier):
+    """
+    Just stop receiving IO read events after the first
+    iteration (unrealistic example).
+    """
+    print('handle_read callback')
+    notifier.loop.stop()
+
+
+wm = pyinotify.WatchManager()
+loop = asyncio.get_event_loop()
+notifier = pyinotify.AsyncioNotifier(wm, loop,
+                                     callback=handle_read_callback)
+wm.add_watch('/tmp', pyinotify.ALL_EVENTS)
+loop.run_forever()
+notifier.stop()

python3/pyinotify.py

@@ -1594,6 +1594,39 @@ def handle_read(self, *args, **kwargs):
             self.handle_read_callback(self)
 
 
+class AsyncioNotifier(Notifier):
+    """
+
+    asyncio/trollius event loop adapter.
+
+    """
+    def __init__(self, watch_manager, loop, callback=None,
+                 default_proc_fun=None, read_freq=0, threshold=0, timeout=None):
+        """
+
+        See examples/asyncio_notifier.py for an example usage.
+
+        @param loop: asyncio or trollius event loop instance.
+        @type loop: asyncio.BaseEventLoop or trollius.BaseEventLoop instance.
+        @param callback: Functor called at the end of each call to handle_read.
+                         Expects to receive the notifier object (self) as 
+                         single parameter.
+        @type callback: callable object or function
+
+        """
+        self.loop = loop
+        self.handle_read_callback = callback
+        Notifier.__init__(self, watch_manager, default_proc_fun, read_freq,
+                          threshold, timeout)
+        loop.add_reader(self._fd, self.handle_read)
+
+    def handle_read(self, *args, **kwargs):
+        self.read_events()
+        self.process_events()
+        if self.handle_read_callback is not None:
+            self.handle_read_callback(self)
+
+
 class Watch:
     """
     Represent a watch, i.e. a file or directory being watched.