FIX: fixed viewer being inusable in a script run via PyCharm "run with console" (closes #253)

Author: gdementen

doc/source/changes/version_0_34_1.rst.inc

@@ -1,41 +1,6 @@
 .. py:currentmodule:: larray_editor
 
-Syntax changes
-^^^^^^^^^^^^^^
-
-* renamed ``MappingEditor.old_method_name()`` to :py:obj:`MappingEditor.new_method_name()` (closes :editor_issue:`1`).
-
-* renamed ``old_argument_name`` argument of :py:obj:`MappingEditor.method_name()` to ``new_argument_name``.
-
-
-Backward incompatible changes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* other backward incompatible changes
-
-
-New features
-^^^^^^^^^^^^
-
-* added a feature (see the :ref:`miscellaneous section <misc_editor>` for details).
-
-* added another feature in the editor (closes :editor_issue:`1`).
-
-  .. note::
-
-     - It works for foo bar !
-     - It does not work for foo baz !
-
-
-.. _misc_editor:
-
-Miscellaneous improvements
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* improved something.
-
-
 Fixes
 ^^^^^
 
-* fixed something (closes :editor_issue:`1`).
+* fixed viewer being inusable in a script run via PyCharm "run with console" (closes :editor_issue:`253`).

larray_editor/api.py

@@ -26,14 +26,19 @@ def _show_dialog(app_name, create_dialog_func, *args, **kwargs):
         The function which creates the dialog.
     """
     qt_app = QApplication.instance()
-    new_app = qt_app is None
-    if new_app:
+    if qt_app is None:
         qt_app = QApplication(sys.argv)
         qt_app.setOrganizationName("LArray")
         qt_app.setApplicationName(app_name)
         parent = None
     else:
+        # activeWindow is defined only if the Window has keyboard focus,
+        # so it could be None even if the app has a window open
         parent = qt_app.activeWindow()
+        if parent is None:
+            app_windows = qt_app.topLevelWindows()
+            if len(app_windows) > 0:
+                parent = app_windows[0]
 
     if 'depth' in kwargs:
         kwargs['depth'] += 1
@@ -43,7 +48,16 @@ def _show_dialog(app_name, create_dialog_func, *args, **kwargs):
         raise RuntimeError('Could not create dialog')
 
     dlg.show()
-    if new_app:
+
+    # We used to test whether qt_app was None, but it failed when an instance existed with no
+    # event loop started such as when running code via PyCharm's "Run File in Python Console"
+    # feature. See https://github.com/larray-project/larray-editor/issues/253.
+
+    # We use whether any Qt window exists in the application as a proxy to test whether
+    # Qt main event loop runs. This is probably wrong for an application which uses Qt event
+    # system but not its GUI (i.e. using QtCoreApplication) but I haven't found any way
+    # to check explicitly whether the main event loop is already running.
+    if parent is None:
         # We do not use install_except_hook/restore_except_hook so that we can restore the hook actually used when
         # this function is called instead of the one which was used when the module was loaded.
 

larray_editor/tests/run_with_console.py

@@ -0,0 +1,11 @@
+from larray import view, ndtest
+
+
+# run via right-click -> Run File in Python Console
+def test_view():
+    arr = ndtest(3)
+    view(arr)
+
+
+if __name__ == '__main__':
+    test_view()

setup.cfg

@@ -3,6 +3,8 @@ test=pytest
 
 [tool:pytest]
 testpaths = larray_editor
-addopts = -v --doctest-modules --ignore=larray_editor/tests/test_api_larray.py
+addopts = -v --doctest-modules
+          --ignore=larray_editor/tests/test_api_larray.py
+          --ignore=larray_editor/tests/run_with_console.py
 #--maxfail=1 --cov (requires pytest-cov) --pep8 (requires pytest-pep8)
 #pep8maxlinelength = 119