EditorApp does not subclass QApplication.

Instead QApplication is created separately and EditorApp just holds a reference to it.
Merged BaseEditorApp and EditorApp into one class.

NOTES.org

@@ -1,12 +1,7 @@
 # -*- org-tags-column: -98 -*-
 
-NEXT: make qtapp attribute of EditorApp
-
 * runtests: warn if selector did not match any tests                                     :TESTING:
 * what is the proper type for target in noisicaa.ui.tools?                               :CLEANUP:
-* refactor noisicaa.ui.editor_app                                                        :CLEANUP:
-- some better way to make it testable than this BaseEditorApp/EditorApp split.
-- perhaps don't subclass QApplication, just be a QObject with a reference to the QApplication?
 * refactor noisicaa.ui.editor_window                                                     :CLEANUP:
 - just an empty shell that hosts project views
 - menubar, toolbar, etc are owned by ProjectView

noisicaa/ui/editor_app.py

@@ -77,7 +77,7 @@ class AudioProcClientImpl(audioproc.AudioProcClientBase):  # pylint: disable=abs
         pass
 
 class AudioProcClient(audioproc.AudioProcClientMixin, AudioProcClientImpl):
-    def __init__(self, app: 'BaseEditorApp', *args: Any, **kwargs: Any) -> None:
+    def __init__(self, app: 'EditorApp', *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
         self.__app = app
 
@@ -85,17 +85,29 @@ class AudioProcClient(audioproc.AudioProcClientMixin, AudioProcClientImpl):
         self.__app.onPipelineStatus(status)
 
 
-class BaseEditorApp(ui_base.AbstractEditorApp):  # pylint: disable=abstract-method
+class QApplication(QtWidgets.QApplication):
+    def __init__(self) -> None:
+        super().__init__(['noisicaä'])
+
+        self.setQuitOnLastWindowClosed(False)
+
+
+class EditorApp(ui_base.AbstractEditorApp):
     def __init__(
             self, *,
+            qt_app: QtWidgets.QApplication,
             process: core.ProcessBase,
+            paths: Sequence[str],
             runtime_settings: runtime_settings_lib.RuntimeSettings,
             settings: Optional[QtCore.QSettings] = None
     ) -> None:
         self.__context = ui_base.CommonContext(app=self)
 
-        self.process = process
+        super().__init__()
 
+        self.paths = paths
+        self.qt_app = qt_app
+        self.process = process
         self.runtime_settings = runtime_settings
 
         if settings is None:
@@ -113,14 +125,22 @@ class BaseEditorApp(ui_base.AbstractEditorApp):  # pylint: disable=abstract-meth
         self.audioproc_process = None  # type: str
         self.node_db = None  # type: node_db.NodeDBClient
         self.instrument_db = None  # type: instrument_db.InstrumentDBClient
-
         self.__clipboard = None  # type: Any
+        self.__old_excepthook = None  # type: Callable[[Type[BaseException], BaseException, types.TracebackType], None]
+        self.win = None  # type: EditorWindow
+        self.pipeline_perf_monitor = None  # type: pipeline_perf_monitor.PipelinePerfMonitor
+        self.stat_monitor = None  # type: stat_monitor.StatMonitor
+        self.default_style = None  # type: str
 
     @property
     def context(self) -> ui_base.CommonContext:
         return self.__context
 
     async def setup(self) -> None:
+        logger.info("Installing custom excepthook.")
+        self.__old_excepthook = sys.excepthook
+        sys.excepthook = ExceptHook(self)  # type: ignore
+
         await self.createNodeDB()
         await self.createInstrumentDB()
 
@@ -133,7 +153,7 @@ class BaseEditorApp(ui_base.AbstractEditorApp):  # pylint: disable=abstract-meth
         self.midi_hub.start()
 
         # TODO: 'self' is not a QObject in this context.
-        self.show_edit_areas_action = QtWidgets.QAction("Show Edit Areas", self)  # type: ignore
+        self.show_edit_areas_action = QtWidgets.QAction("Show Edit Areas", self.qt_app)
         self.show_edit_areas_action.setCheckable(True)
         self.show_edit_areas_action.triggered.connect(self.onShowEditAreasChanged)
         self.show_edit_areas_action.setChecked(
@@ -141,8 +161,51 @@ class BaseEditorApp(ui_base.AbstractEditorApp):  # pylint: disable=abstract-meth
 
         await self.createAudioProcProcess()
 
+        self.default_style = self.qt_app.style().objectName()
+
+        style_name = self.settings.value('appearance/qtStyle', '')
+        if style_name:
+            # TODO: something's wrong with the QtWidgets stubs...
+            self.qt_app.setStyle(QtWidgets.QStyleFactory.create(style_name))  # type: ignore
+
+        logger.info("Creating PipelinePerfMonitor.")
+        self.pipeline_perf_monitor = pipeline_perf_monitor.PipelinePerfMonitor(context=self.context)
+
+        logger.info("Creating StatMonitor.")
+        self.stat_monitor = stat_monitor.StatMonitor(context=self.context)
+
+        await self.createEditorWindow()
+
+        if self.paths:
+            logger.info("Starting with projects from cmdline.")
+            for path in self.paths:
+                if path.startswith('+'):
+                    await self.createProject(path[1:])
+                else:
+                    await self.openProject(path)
+        else:
+            reopen_projects = self.settings.value('opened_projects', [])
+            for path in reopen_projects or []:
+                await self.openProject(path)
+
     async def cleanup(self) -> None:
-        logger.info("Cleaning up.")
+        logger.info("Cleanup app...")
+
+        if self.stat_monitor is not None:
+            self.stat_monitor.storeState()
+            self.stat_monitor = None
+
+        if self.pipeline_perf_monitor is not None:
+            self.pipeline_perf_monitor.storeState()
+            self.pipeline_perf_monitor = None
+
+        if self.win is not None:
+            self.win.storeState()
+            await self.win.cleanup()
+            self.win = None
+
+        self.settings.sync()
+        self.dumpSettings()
 
         if self.project_registry is not None:
             await self.project_registry.close_all()
@@ -171,19 +234,42 @@ class BaseEditorApp(ui_base.AbstractEditorApp):  # pylint: disable=abstract-meth
             self.sequencer.close()
             self.sequencer = None
 
+        logger.info("Remove custom excepthook.")
+        sys.excepthook = self.__old_excepthook  # type: ignore
+
     def quit(self, exit_code: int = 0) -> None:
         # TODO: quit() is not a method of ProcessBase, only in UIProcess. Find some way to
         #   fix that without a cyclic import.
         self.process.quit(exit_code)  # type: ignore
 
     def createSequencer(self) -> devices.AlsaSequencer:
-        return None
+        # Do other clients handle non-ASCII names?
+        # 'aconnect' seems to work (or just spits out whatever bytes it gets
+        # and the console interprets it as UTF-8), 'aconnectgui' shows the
+        # encoded bytes.
+        return devices.AlsaSequencer('noisicaä')
 
     def createMidiHub(self) -> devices.MidiHub:
         return devices.MidiHub(self.sequencer)
 
     async def createAudioProcProcess(self) -> None:
-        pass
+        self.audioproc_process = await self.process.manager.call(
+            'CREATE_AUDIOPROC_PROCESS', 'main',
+            block_size=2 ** int(self.settings.value('audio/block_size', 10)),
+            sample_rate=int(self.settings.value('audio/sample_rate', 44100)),
+        )
+
+        self.audioproc_client = AudioProcClient(
+            self, self.process.event_loop, self.process.server)
+        await self.audioproc_client.setup()
+        await self.audioproc_client.connect(
+            self.audioproc_process, {'perf_data'})
+
+        await self.audioproc_client.create_realm(name='root')
+
+        await self.audioproc_client.set_backend(
+            self.settings.value('audio/backend', 'portaudio'),
+        )
 
     async def createNodeDB(self) -> None:
         node_db_address = await self.process.manager.call('CREATE_NODE_DB_PROCESS')
@@ -201,6 +287,12 @@ class BaseEditorApp(ui_base.AbstractEditorApp):  # pylint: disable=abstract-meth
         await self.instrument_db.setup()
         await self.instrument_db.connect(instrument_db_address)
 
+    async def createEditorWindow(self) -> None:
+        logger.info("Creating EditorWindow.")
+        self.win = EditorWindow(context=self.context)
+        await self.win.setup()
+        self.win.show()
+
     def dumpSettings(self) -> None:
         for key in self.settings.allKeys():
             value = self.settings.value(key)
@@ -218,7 +310,10 @@ class BaseEditorApp(ui_base.AbstractEditorApp):  # pylint: disable=abstract-meth
                 and self.show_edit_areas_action.isChecked())
 
     def onPipelineStatus(self, status: Dict[str, Any]) -> None:
-        pass
+        if 'perf_data' in status:
+            if self.pipeline_perf_monitor is not None:
+                self.pipeline_perf_monitor.addPerfData(
+                    status['perf_data'])
 
     def setClipboardContent(self, content: Any) -> None:
         logger.info(
@@ -228,116 +323,6 @@ class BaseEditorApp(ui_base.AbstractEditorApp):  # pylint: disable=abstract-meth
     def clipboardContent(self) -> Any:
         return self.__clipboard
 
-
-class EditorApp(BaseEditorApp, QtWidgets.QApplication):
-    def __init__(self, *, paths: Sequence[str], **kwargs: Any) -> None:
-        QtWidgets.QApplication.__init__(self, ['noisicaä'])
-        BaseEditorApp.__init__(self, **kwargs)
-
-        self.paths = paths
-
-        self._old_excepthook = None  # type: Callable[[Type[BaseException], BaseException, types.TracebackType], None]
-
-        self.win = None  # type: EditorWindow
-        self.pipeline_perf_monitor = None  # type: pipeline_perf_monitor.PipelinePerfMonitor
-        self.stat_monitor = None  # type: stat_monitor.StatMonitor
-        self.default_style = None  # type: str
-
-        self.setQuitOnLastWindowClosed(False)
-
-    async def setup(self) -> None:
-        logger.info("Installing custom excepthook.")
-        self._old_excepthook = sys.excepthook
-        sys.excepthook = ExceptHook(self)  # type: ignore
-
-        await super().setup()
-
-        self.default_style = self.style().objectName()
-
-        style_name = self.settings.value('appearance/qtStyle', '')
-        if style_name:
-            # TODO: something's wrong with the QtWidgets stubs...
-            self.setStyle(QtWidgets.QStyleFactory.create(style_name))  # type: ignore
-
-        logger.info("Creating PipelinePerfMonitor.")
-        self.pipeline_perf_monitor = pipeline_perf_monitor.PipelinePerfMonitor(context=self.context)
-
-        logger.info("Creating StatMonitor.")
-        self.stat_monitor = stat_monitor.StatMonitor(context=self.context)
-
-        logger.info("Creating EditorWindow.")
-        self.win = EditorWindow(context=self.context)
-        await self.win.setup()
-        self.win.show()
-
-        if self.paths:
-            logger.info("Starting with projects from cmdline.")
-            for path in self.paths:
-                if path.startswith('+'):
-                    await self.createProject(path[1:])
-                else:
-                    await self.openProject(path)
-        else:
-            reopen_projects = self.settings.value('opened_projects', [])
-            for path in reopen_projects or []:
-                await self.openProject(path)
-
-    async def cleanup(self) -> None:
-        logger.info("Cleanup app...")
-
-        if self.stat_monitor is not None:
-            self.stat_monitor.storeState()
-            self.stat_monitor = None
-
-        if self.pipeline_perf_monitor is not None:
-            self.pipeline_perf_monitor.storeState()
-            self.pipeline_perf_monitor = None
-
-        if self.win is not None:
-            self.win.storeState()
-            await self.win.cleanup()
-            self.win = None
-
-        self.settings.sync()
-        self.dumpSettings()
-
-        await super().cleanup()
-
-        logger.info("Remove custom excepthook.")
-        sys.excepthook = self._old_excepthook  # type: ignore
-
-    def createSequencer(self) -> devices.AlsaSequencer:
-        # Do other clients handle non-ASCII names?
-        # 'aconnect' seems to work (or just spits out whatever bytes it gets
-        # and the console interprets it as UTF-8), 'aconnectgui' shows the
-        # encoded bytes.
-        return devices.AlsaSequencer('noisicaä')
-
-    async def createAudioProcProcess(self) -> None:
-        self.audioproc_process = await self.process.manager.call(
-            'CREATE_AUDIOPROC_PROCESS', 'main',
-            block_size=2 ** int(self.settings.value('audio/block_size', 10)),
-            sample_rate=int(self.settings.value('audio/sample_rate', 44100)),
-        )
-
-        self.audioproc_client = AudioProcClient(
-            self, self.process.event_loop, self.process.server)
-        await self.audioproc_client.setup()
-        await self.audioproc_client.connect(
-            self.audioproc_process, {'perf_data'})
-
-        await self.audioproc_client.create_realm(name='root')
-
-        await self.audioproc_client.set_backend(
-            self.settings.value('audio/backend', 'portaudio'),
-        )
-
-    def onPipelineStatus(self, status: Dict[str, Any]) -> None:
-        if 'perf_data' in status:
-            if self.pipeline_perf_monitor is not None:
-                self.pipeline_perf_monitor.addPerfData(
-                    status['perf_data'])
-
     async def createProject(self, path: str) -> None:
         project_connection = self.project_registry.add_project(path)
         idx = self.win.addProjectSetupView(project_connection)

noisicaa/ui/ui_base.py

@@ -45,8 +45,7 @@ class CommonContext(object):
 
     @property
     def qt_app(self) -> QtWidgets.QApplication:
-        # TODO: this should be an attribute of EditorApp, not itself...
-        return self.__app  # type: ignore
+        return self.__app.qt_app
 
     @property
     def app(self) -> 'AbstractEditorApp':
@@ -248,6 +247,7 @@ class AbstractEditorApp(object):
     node_db = None  # type: node_db_lib.NodeDBClient
     instrument_db = None  # type: instrument_db_lib.InstrumentDBClient
     default_style = None  # type: str
+    qt_app = None  # type: QtWidgets.QApplication
 
     def quit(self, exit_code: int = 0) -> None:
         raise NotImplementedError

noisicaa/ui/ui_process.py

@@ -26,6 +26,7 @@ import logging
 import signal
 from typing import Any, Optional, Sequence  # pylint: disable=unused-import
 
+from PyQt5 import QtWidgets  # pylint: disable=unused-import
 import quamash
 
 from noisicaa import core
@@ -44,16 +45,17 @@ class UISubprocess(core.SubprocessMixin, core.ProcessBase):
     ) -> None:
         super().__init__(**kwargs)
 
+        self.runtime_settings = runtime_settings
+        self.paths = paths
+
         self._shutting_down = None  # type: asyncio.Event
         self.exit_code = None  # type: Optional[int]
-
-        self.app = editor_app.EditorApp(
-            process=self,
-            runtime_settings=runtime_settings,
-            paths=paths)
+        self.qt_app = None  # type: QtWidgets.QApplication
+        self.app = None  # type: editor_app.EditorApp
 
     def create_event_loop(self) -> asyncio.AbstractEventLoop:
-        return quamash.QEventLoop(self.app)
+        self.qt_app = editor_app.QApplication()
+        return quamash.QEventLoop(self.qt_app)
 
     async def setup(self) -> None:
         self._shutting_down = asyncio.Event(loop=self.event_loop)
@@ -61,10 +63,19 @@ class UISubprocess(core.SubprocessMixin, core.ProcessBase):
             self.event_loop.add_signal_handler(
                 sig, functools.partial(self.handle_signal, sig))
         await super().setup()
+
+        self.app = editor_app.EditorApp(
+            qt_app=self.qt_app,
+            process=self,
+            runtime_settings=self.runtime_settings,
+            paths=self.paths)
         await self.app.setup()
 
     async def cleanup(self) -> None:
-        await self.app.cleanup()
+        if self.app is not None:
+            await self.app.cleanup()
+            self.app = None
+
         await super().cleanup()
 
     async def run(self) -> int:

noisidev/qttest.py

@@ -46,19 +46,15 @@ class QtTestCase(unittest.AsyncTestCase):
             return
 
         if cls.qt_app is None:
-            cls.qt_app = cls.createQApplication()
+            cls.qt_app = QtWidgets.QApplication(['unittest'])
+            cls.qt_app.setQuitOnLastWindowClosed(False)
+
         asyncio.set_event_loop(quamash.QEventLoop(cls.qt_app))
 
     @classmethod
     def tearDownClass(cls):
         asyncio.set_event_loop(None)
 
-    @classmethod
-    def createQApplication(cls):
-        app = QtWidgets.QApplication(['unittest'])
-        app.setQuitOnLastWindowClosed(False)
-        return app
-
     def setup_testcase(self):
         if not constants.TEST_OPTS.ALLOW_UI:
             raise unittest.SkipTest("QT tests disabled")

noisidev/uitest.py

@@ -131,16 +131,33 @@ class MockSequencer(object):
 
 class MockSettings(object):
     def __init__(self):
-        self._data = {}  # type: Dict[str, Any]
+        self.__data = {}  # type: Dict[str, Any]
+        self.__grp = None  # type: str
 
-    def value(self, key, default):
-        return self._data.get(key, default)
+    def value(self, key, default=None):
+        if self.__grp:
+            key = self.__grp + '/' + key
+        return self.__data.get(key, default)
 
     def setValue(self, key, value):
-        self._data[key] = value
+        if self.__grp:
+            key = self.__grp + '/' + key
+        self.__data[key] = value
 
     def allKeys(self):
-        return list(self._data.keys())
+        assert self.__grp is None
+        return list(self.__data.keys())
+
+    def sync(self):
+        pass
+
+    def beginGroup(self, grp):
+        assert self.__grp is None
+        self.__grp = grp
+
+    def endGroup(self):
+        assert self.__grp is not None
+        self.__grp = None
 
 
 class MockProcess(core.ProcessBase):
@@ -149,19 +166,16 @@ class MockProcess(core.ProcessBase):
         self.project = None
 
 
-class MockApp(editor_app.BaseEditorApp, QtWidgets.QApplication):
-    def __init__(self):
-        QtWidgets.QApplication.__init__(self, ['noisicaä-test'])
-        editor_app.BaseEditorApp.__init__(  # type: ignore
-            self,
-            process=None,
-            runtime_settings=runtime_settings_lib.RuntimeSettings(),
-            settings=MockSettings()
-        )
-
+class MockApp(editor_app.EditorApp):
     def createSequencer(self):
         return MockSequencer()
 
+    async def createAudioProcProcess(self):
+        pass
+
+    async def createEditorWindow(self):
+        pass
+
 
 class UITestCase(unittest_mixins.ProcessManagerMixin, qttest.QtTestCase):
     def __init__(self, *args, **kwargs):
@@ -171,10 +185,6 @@ class UITestCase(unittest_mixins.ProcessManagerMixin, qttest.QtTestCase):
         self.app = None
         self.context = None
 
-    @classmethod
-    def createQApplication(cls):
-        return MockApp()
-
     async def setup_testcase(self):
         self.setup_node_db_process(inline=True)
         self.setup_instrument_db_process(inline=True)
@@ -186,7 +196,12 @@ class UITestCase(unittest_mixins.ProcessManagerMixin, qttest.QtTestCase):
             tmp_dir=TEST_OPTS.TMP_DIR)
         await self.process.setup()
 
-        self.app = self.qt_app
+        self.app = MockApp(
+            qt_app=self.qt_app,
+            process=self.process,
+            paths=[],
+            runtime_settings=runtime_settings_lib.RuntimeSettings(),
+            settings=MockSettings())
         self.app.process = self.process
         await self.app.setup()