From: Maria Matejka <mq@ucw.cz>
Date: Sun, 21 May 2023 11:38:34 +0000 (+0200)
Subject: Python CLI Package: first try of a GUI
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bef77416afd30ac9565f219c0e89ae539807b692;p=thirdparty%2Fbird.git

Python CLI Package: first try of a GUI

based on an example from https://doc.qt.io/qtforpython-6/examples/example_async_minimal.html
---

diff --git a/python/gui_view.py b/python/gui_view.py
new file mode 100644
index 000000000..84809a3c6
--- /dev/null
+++ b/python/gui_view.py
@@ -0,0 +1,129 @@
+from PySide6.QtCore import (Qt, QEvent, QObject, Signal, Slot)
+from PySide6.QtWidgets import (QApplication, QLabel, QMainWindow, QPushButton, QVBoxLayout, QWidget)
+
+from BIRD import BIRD
+
+import asyncio
+import signal
+import sys
+
+
+
+class MainWindow(QMainWindow):
+
+    start_signal = Signal()
+    done_signal = Signal()
+
+    def __init__(self):
+        super().__init__()
+
+        self.bird = BIRD("/run/bird/bird.ctl")
+        self.initial_layout()
+
+    def initial_layout(self):
+        widget = QWidget()
+        self.setCentralWidget(widget)
+
+        layout = QVBoxLayout(widget)
+
+        self.text = QLabel("No connection to BIRD.")
+        layout.addWidget(self.text, alignment=Qt.AlignmentFlag.AlignCenter)
+
+        async_trigger = QPushButton(text="Connect")
+        async_trigger.clicked.connect(self.async_start)
+        layout.addWidget(async_trigger, alignment=Qt.AlignmentFlag.AlignCenter)
+
+    @Slot()
+    def async_start(self):
+        self.start_signal.emit()
+
+    async def bird_connect(self):
+        async with self.bird as b:
+            await b.version.update()
+            await b.status.update()
+
+            self.text.setText(f"Connected to {b.version.name} {b.version.version}")
+
+        self.done_signal.emit()
+
+class AsyncHelper(QObject):
+
+    class ReenterQtObject(QObject):
+        """ This is a QObject to which an event will be posted, allowing
+            asyncio to resume when the event is handled. event.fn() is
+            the next entry point of the asyncio event loop. """
+        def event(self, event):
+            if event.type() == QEvent.Type.User + 1:
+                event.fn()
+                return True
+            return False
+
+    class ReenterQtEvent(QEvent):
+        """ This is the QEvent that will be handled by the ReenterQtObject.
+            self.fn is the next entry point of the asyncio event loop. """
+        def __init__(self, fn):
+            super().__init__(QEvent.Type(QEvent.Type.User + 1))
+            self.fn = fn
+
+    def __init__(self, worker, entry):
+        super().__init__()
+        self.reenter_qt = self.ReenterQtObject()
+        self.entry = entry
+        self.loop = asyncio.new_event_loop()
+        self.done = False
+
+        self.worker = worker
+        if hasattr(self.worker, "start_signal") and isinstance(self.worker.start_signal, Signal):
+            self.worker.start_signal.connect(self.on_worker_started)
+        if hasattr(self.worker, "done_signal") and isinstance(self.worker.done_signal, Signal):
+            self.worker.done_signal.connect(self.on_worker_done)
+
+    @Slot()
+    def on_worker_started(self):
+        """ To use asyncio and Qt together, one must run the asyncio
+            event loop as a "guest" inside the Qt "host" event loop. """
+        if not self.entry:
+            raise Exception("No entry point for the asyncio event loop was set.")
+        asyncio.set_event_loop(self.loop)
+        self.loop.create_task(self.entry())
+        self.loop.call_soon(self.next_guest_run_schedule)
+        self.done = False  # Set this explicitly as we might want to restart the guest run.
+        self.loop.run_forever()
+
+    @Slot()
+    def on_worker_done(self):
+        """ When all our current asyncio tasks are finished, we must end
+            the "guest run" lest we enter a quasi idle loop of switching
+            back and forth between the asyncio and Qt loops. We can
+            launch a new guest run by calling launch_guest_run() again. """
+        self.done = True
+
+    def continue_loop(self):
+        """ This function is called by an event posted to the Qt event
+            loop to continue the asyncio event loop. """
+        if not self.done:
+            self.loop.call_soon(self.next_guest_run_schedule)
+            self.loop.run_forever()
+
+    def next_guest_run_schedule(self):
+        """ This function serves to pause and re-schedule the guest
+            (asyncio) event loop inside the host (Qt) event loop. It is
+            registered in asyncio as a callback to be called at the next
+            iteration of the event loop. When this function runs, it
+            first stops the asyncio event loop, then by posting an event
+            on the Qt event loop, it both relinquishes to Qt's event
+            loop and also schedules the asyncio event loop to run again.
+            Upon handling this event, a function will be called that
+            resumes the asyncio event loop. """
+        self.loop.stop()
+        QApplication.postEvent(self.reenter_qt, self.ReenterQtEvent(self.continue_loop))
+
+if __name__ == "__main__":
+    app = QApplication(sys.argv)
+    main_window = MainWindow()
+    async_helper = AsyncHelper(main_window, main_window.bird_connect)
+
+    main_window.show()
+
+    signal.signal(signal.SIGINT, signal.SIG_DFL)
+    app.exec()