Merge pull request #188 from pjeanjean/master

Add decorator syntax for event handlers

Author: Tony Crisci

i3ipc/aio/connection.py

@@ -514,7 +514,17 @@ async def subscribe(self, events: Union[List[Event], List[str]], force: bool = F
 
         await self._loop.sock_sendall(self._sub_socket, _pack(MessageType.SUBSCRIBE, payload))
 
-    def on(self, event: Union[Event, str], handler: Callable[['Connection', IpcBaseEvent], None]):
+    def on(self, event: Union[Event, str], handler: Callable[['Connection', IpcBaseEvent], None] = None):
+        def on_wrapped(handler):
+            self._on(event, handler)
+            return handler
+
+        if handler:
+            return on_wrapped(handler)
+        else:
+            return on_wrapped
+
+    def _on(self, event: Union[Event, str], handler: Callable[['Connection', IpcBaseEvent], None]):
         """Subscribe to the event and call the handler when it is emitted by
         the i3 ipc.
 

i3ipc/connection.py

@@ -406,7 +406,17 @@ def off(self, handler: Callable[['Connection', IpcBaseEvent], None]):
         """
         self._pubsub.unsubscribe(handler)
 
-    def on(self, event: Union[Event, str], handler: Callable[['Connection', IpcBaseEvent], None]):
+    def on(self, event: Union[Event, str], handler: Callable[['Connection', IpcBaseEvent], None] = None):
+        def on_wrapped(handler):
+            self._on(event, handler)
+            return handler
+
+        if handler:
+            return on_wrapped(handler)
+        else:
+            return on_wrapped
+
+    def _on(self, event: Union[Event, str], handler: Callable[['Connection', IpcBaseEvent], None]):
         """Subscribe to the event and call the handler when it is emitted by
         the i3 ipc.
 

test/aio/test_window.py

@@ -65,6 +65,35 @@ async def generate_events():
         for e in events:
             assert e.change == 'focus'
 
+    @pytest.mark.asyncio
+    async def test_detailed_window_event_decorator(self, i3):
+        events = []
+
+        async def generate_events():
+            win1 = self.open_window()
+            win2 = self.open_window()
+            await i3.command(f'[id={win1}] kill; [id={win2}] kill')
+            # TODO sync protocol
+            await asyncio.sleep(0.01)
+            i3.main_quit()
+
+        @i3.on(Event.WINDOW_NEW)
+        @i3.on(Event.WINDOW_FOCUS)
+        async def on_window(i3, e):
+            nonlocal events
+            events.append(e)
+
+        asyncio.ensure_future(generate_events())
+        await i3.main()
+
+        assert len(events)
+        for e in events:
+            assert e.change in ['new', 'focus']
+        assert len([e for e in events if e.change == 'new'])
+        assert len([e for e in events if e.change == 'focus'])
+
+        i3.off(on_window)
+
     @pytest.mark.asyncio
     async def test_marks(self, i3):
         await self.fresh_workspace()

test/test_window.py

@@ -61,6 +61,34 @@ def on_window(i3, e):
         for e in events:
             assert e.change == 'focus'
 
+    def test_detailed_window_event_decorator(self, i3):
+        events = []
+
+        def generate_events():
+            win1 = self.open_window()
+            win2 = self.open_window()
+            i3.command(f'[id={win1}] kill; [id={win2}] kill')
+            # TODO sync protocol
+            time.sleep(0.01)
+            i3.main_quit()
+
+        @i3.on(Event.WINDOW_NEW)
+        @i3.on(Event.WINDOW_FOCUS)
+        def on_window(i3, e):
+            nonlocal events
+            events.append(e)
+
+        Timer(0.01, generate_events).start()
+        i3.main(timeout=2)
+
+        assert len(events)
+        for e in events:
+            assert e.change in ['new', 'focus']
+        assert len([e for e in events if e.change == 'new'])
+        assert len([e for e in events if e.change == 'focus'])
+
+        i3.off(on_window)
+
     def test_resize(self, i3):
         self.fresh_workspace()
         self.open_window()