FIX: problem when closing settings fig

README.md

@@ -101,7 +101,12 @@ You can run a benchmark locally with:
 pytest -m benchmark mne_qt_browser
 ```
 
-To run tests, clone mne-python, and then run the PyQtGraph tests with e.g.:
+To run the PyQtGraph tests you have to run:
+```
+pytest mne_qt_browser/tests/test_pg_specific.py
+```
+
+Additionally, clone mne-python, and then run:
 
 ```console
 pytest -m pgtest ../mne-python/mne/viz/tests

mne_qt_browser/_pg_figure.py

@@ -1600,10 +1600,10 @@ def __init__(self, main, title='Settings', **kwargs):
         self.setLayout(layout)
         self.show()
 
-    def closeEvent(self):
+    def closeEvent(self, event):
         _disconnect(self.ds_method_cmbx.currentTextChanged)
         _disconnect(self.scroll_sensitivity_slider.valueChanged)
-        super.closeEvent()
+        super().closeEvent(event)
 
     def _value_changed(self, new_value, value_name):
         if value_name == 'downsampling' and new_value == 0:
@@ -4101,6 +4101,7 @@ def _toggle_proj_fig(self):
             ProjDialog(self, name='fig_proj')
         else:
             self.mne.fig_proj.close()
+            self.mne.fig_proj = None
 
     def _toggle_all_projs(self):
         if self.mne.fig_proj is None:
@@ -4118,8 +4119,8 @@ def _toggle_settings_fig(self):
         if self.mne.fig_settings is None:
             SettingsDialog(self, name='fig_settings')
         else:
-            self.mne.fig_help.close()
-            self.mne.fig_help = None
+            self.mne.fig_settings.close()
+            self.mne.fig_settings = None
 
     def _toggle_help_fig(self):
         if self.mne.fig_help is None:
@@ -4562,6 +4563,14 @@ def closeEvent(self, event):
         # Make sure it gets deleted after it was closed.
         self.deleteLater()
 
+    def _fake_click_on_toolbar_action(self, action_name, wait_after=500):
+        """Trigger event associated with action 'action_name' in toolbar."""
+        for action in self.mne.toolbar.actions():
+            if not action.isSeparator():
+                if action.iconText() == action_name:
+                    action.trigger()
+        QTest.qWait(wait_after)
+
 
 def _get_n_figs():
     # Wait for a short time to let the Qt-loop clean up
@@ -4646,7 +4655,7 @@ def _init_browser(**kwargs):
         app_kwargs['splash'] = 'Initializing mne-qt-browser...'
     out = _init_mne_qtapp(pg_app=True, **app_kwargs)
     if 'splash' in app_kwargs:
-        kwargs['splash'] = out[1]  # returned as secord element
+        kwargs['splash'] = out[1]  # returned as second element
     browser = MNEQtBrowser(**kwargs)
 
     return browser

mne_qt_browser/tests/test_pg_specific.py

@@ -4,6 +4,7 @@
 # License: BSD-3-Clause
 
 import numpy as np
+from PyQt5.QtTest import QTest
 
 
 def test_annotations_interactions(raw_orig, pg_backend):
@@ -81,3 +82,282 @@ def test_annotations_interactions(raw_orig, pg_backend):
     assert fig.msg_box.informativeText() == 'Start can\'t be bigger or ' \
                                             'equal to Stop!'
     fig.msg_box.close()
+
+
+def test_pg_settings_dialog(raw_orig, pg_backend):
+    """Test Settings Dialog toggle on/off for pyqtgraph-backend."""
+    fig = raw_orig.plot()
+    fig.test_mode = True
+    QTest.qWaitForWindowExposed(fig)
+    QTest.qWait(50)
+    assert fig.mne.fig_settings is None
+    fig._fake_click_on_toolbar_action('Settings', wait_after=500)
+    assert fig.mne.fig_settings is not None
+    assert pg_backend._get_n_figs() == 2
+    fig._fake_click_on_toolbar_action('Settings', wait_after=500)
+    assert pg_backend._get_n_figs() == 1
+    assert fig.mne.fig_settings is None
+    fig._fake_click_on_toolbar_action('Settings', wait_after=500)
+    assert pg_backend._get_n_figs() == 2
+    assert fig.mne.fig_settings is not None
+    fig._fake_click_on_toolbar_action('Settings', wait_after=500)
+    assert pg_backend._get_n_figs() == 1
+    assert fig.mne.fig_settings is None
+
+    fig._fake_click_on_toolbar_action('Settings', wait_after=500)
+    assert fig.mne.fig_settings is not None
+    downsampling_control = fig.mne.fig_settings.downsampling_box
+    assert downsampling_control.value() == fig.mne.downsampling
+
+    downsampling_control.setValue(2)
+    QTest.qWait(100)
+    assert downsampling_control.value() == 2
+    assert downsampling_control.value() == fig.mne.downsampling
+
+    downsampling_control.setValue(3)
+    QTest.qWait(100)
+    assert downsampling_control.value() == 3
+    assert downsampling_control.value() == fig.mne.downsampling
+
+    QTest.qWait(100)
+    downsampling_method_control = fig.mne.fig_settings.ds_method_cmbx
+    assert fig.mne.ds_method == downsampling_method_control.currentText()
+
+    downsampling_method_control.setCurrentText('mean')
+    QTest.qWait(100)
+    assert downsampling_method_control.currentText() == 'mean'
+    assert fig.mne.ds_method == 'mean'
+
+    downsampling_method_control.setCurrentText('subsample')
+    QTest.qWait(100)
+    assert downsampling_method_control.currentText() == 'subsample'
+    assert fig.mne.ds_method == 'subsample'
+
+    downsampling_method_control.setCurrentText('peak')
+    QTest.qWait(100)
+    assert downsampling_method_control.currentText() == 'peak'
+    assert fig.mne.ds_method == 'peak'
+
+    downsampling_method_control.setCurrentText('invalid_method_name')
+    QTest.qWait(100)
+    assert downsampling_method_control.currentText() != 'invalid_method_name'
+
+    sensitivity_control = fig.mne.fig_settings.scroll_sensitivity_slider
+    assert fig.mne.scroll_sensitivity == sensitivity_control.value()
+
+    sensitivity_control.setValue(100)
+    QTest.qWait(100)
+    assert sensitivity_control.value() == 100
+    assert fig.mne.scroll_sensitivity == 100
+
+    QTest.qWait(100)
+    sensitivity_values = list(range(sensitivity_control.minimum(),
+                                    sensitivity_control.maximum() + 1, 40))
+    if sensitivity_values[-1] != sensitivity_control.maximum():
+        sensitivity_values.append(sensitivity_control.maximum())
+
+    sensitivities_mne = list()
+    sensitivities_control = list()
+    for val in sensitivity_values:
+        sensitivity_control.setValue(val)
+        QTest.qWait(50)
+        sensitivities_mne.append(fig.mne.scroll_sensitivity)
+        sensitivities_control.append(sensitivity_control.value())
+    assert sensitivities_mne == sensitivity_values
+    assert sensitivities_control == sensitivity_values
+
+    sensitivity_values = sensitivity_values[::-1]
+    sensitivities_mne = list()
+    sensitivities_control = list()
+    for val in sensitivity_values:
+        sensitivity_control.setValue(val)
+        QTest.qWait(50)
+        sensitivities_mne.append(fig.mne.scroll_sensitivity)
+        sensitivities_control.append(sensitivity_control.value())
+    assert sensitivities_mne == sensitivity_values
+    assert sensitivities_control == sensitivity_values
+
+
+def test_pg_help_dialog(raw_orig, pg_backend):
+    """Test Settings Dialog toggle on/off for pyqtgraph-backend."""
+    fig = raw_orig.plot()
+    fig.test_mode = True
+    QTest.qWaitForWindowExposed(fig)
+    QTest.qWait(50)
+    assert fig.mne.fig_help is None
+    fig._fake_click_on_toolbar_action('Help', wait_after=500)
+    assert fig.mne.fig_help is not None
+    assert pg_backend._get_n_figs() == 2
+    fig._fake_click_on_toolbar_action('Help', wait_after=500)
+    assert fig.mne.fig_help is None
+    assert pg_backend._get_n_figs() == 1
+    fig._fake_click_on_toolbar_action('Help', wait_after=500)
+    assert fig.mne.fig_help is not None
+    assert pg_backend._get_n_figs() == 2
+    fig._fake_click_on_toolbar_action('Help', wait_after=500)
+    assert fig.mne.fig_help is None
+    assert pg_backend._get_n_figs() == 1
+
+
+def test_pg_toolbar_time_plus_minus(raw_orig, pg_backend):
+    fig = raw_orig.plot()
+    fig.test_mode = True
+    QTest.qWaitForWindowExposed(fig)
+    assert pg_backend._get_n_figs() == 1
+
+    min_duration = 3 * np.diff(fig.mne.inst.times[:2])[0]  # hard code.
+    xmin, xmax = fig.mne.viewbox.viewRange()[0]
+    while xmax - xmin > min_duration:
+        fig._fake_click_on_toolbar_action('- Time', wait_after=20)
+        xmin, xmax = fig.mne.viewbox.viewRange()[0]
+    assert xmax - xmin == min_duration
+
+    eps = 0.01
+    step = 0.25
+    fig._fake_click_on_toolbar_action('+ Time', wait_after=100)
+    xmin_new, xmax_new = fig.mne.viewbox.viewRange()[0]
+    assert xmax_new - (xmax + (xmax - xmin * step)) < eps
+
+    xmin, xmax = fig.mne.viewbox.viewRange()[0]
+    while xmax + fig.mne.duration * step < fig.mne.xmax:
+        fig._fake_click_on_toolbar_action('+ Time', wait_after=20)
+        xmin, xmax = fig.mne.viewbox.viewRange()[0]
+
+    fig._fake_click_on_toolbar_action('+ Time', wait_after=200)
+    fig._fake_click_on_toolbar_action('+ Time', wait_after=200)
+
+    xmin, xmax = fig.mne.viewbox.viewRange()[0]
+    fig._fake_click_on_toolbar_action('+ Time', wait_after=200)
+    xmin_new, xmax_new = fig.mne.viewbox.viewRange()[0]
+    assert xmax_new == xmax  # no effect after span maxed
+
+    step = -0.2
+    xmin, xmax = fig.mne.viewbox.viewRange()[0]
+    fig._fake_click_on_toolbar_action('- Time', wait_after=200)
+    xmin_new, xmax_new = fig.mne.viewbox.viewRange()[0]
+    assert xmax_new == xmax + ((xmax - xmin) * step)
+
+    xmin, xmax = fig.mne.viewbox.viewRange()[0]
+    fig._fake_click_on_toolbar_action('- Time', wait_after=200)
+    xmin_new, xmax_new = fig.mne.viewbox.viewRange()[0]
+    assert xmax_new == xmax + ((xmax - xmin) * step)
+
+    for _ in range(7):
+        fig._fake_click_on_toolbar_action('- Time', wait_after=20)
+
+    assert pg_backend._get_n_figs() == 1  # still alive
+
+
+def test_pg_toolbar_channels_plus_minus(raw_orig, pg_backend):
+    fig = raw_orig.plot()
+    fig.test_mode = True
+    QTest.qWaitForWindowExposed(fig)
+    assert pg_backend._get_n_figs() == 1
+
+    if fig.mne.butterfly is not True:
+        fig._fake_keypress('b')  # toggle butterfly mode
+    fig._fake_click_on_toolbar_action('- Channels', wait_after=100)
+    ymin, ymax = fig.mne.viewbox.viewRange()[1]
+    fig._fake_click_on_toolbar_action('- Channels', wait_after=100)
+    assert [ymin, ymax] == fig.mne.viewbox.viewRange()[1]
+    fig._fake_click_on_toolbar_action('+ Channels', wait_after=100)
+    assert [ymin, ymax] == fig.mne.viewbox.viewRange()[1]
+
+    if fig.mne.butterfly is True:
+        fig._fake_keypress('b')  # toggle butterfly off
+
+    while ymax - ymin > 2:
+        fig._fake_click_on_toolbar_action('- Channels', wait_after=40)
+        ymin, ymax = fig.mne.viewbox.viewRange()[1]
+    assert ymax - ymin == 2
+    fig._fake_click_on_toolbar_action('- Channels', wait_after=40)
+    ymin, ymax = fig.mne.viewbox.viewRange()[1]
+    assert ymax - ymin == 2
+
+    step = 10
+    fig._fake_click_on_toolbar_action('+ Channels', wait_after=100)
+    ymin_new, ymax_new = fig.mne.viewbox.viewRange()[1]
+    assert ymax_new == ymax + step
+
+    ymin, ymax = fig.mne.viewbox.viewRange()[1]
+    fig._fake_click_on_toolbar_action('+ Channels', wait_after=100)
+    ymin_new, ymax_new = fig.mne.viewbox.viewRange()[1]
+    assert ymax_new == ymax + step
+
+    ymin, ymax = fig.mne.viewbox.viewRange()[1]
+    fig._fake_click_on_toolbar_action('+ Channels', wait_after=100)
+    ymin_new, ymax_new = fig.mne.viewbox.viewRange()[1]
+    assert ymax_new == ymax + step
+
+    assert pg_backend._get_n_figs() == 1    # still alive
+
+
+def test_pg_toolbar_zoom(raw_orig, pg_backend):
+    fig = raw_orig.plot()
+    fig.test_mode = True
+    QTest.qWaitForWindowExposed(fig)
+    assert pg_backend._get_n_figs() == 1
+
+    step = 4 / 5
+    scale_factor = fig.mne.scale_factor
+    fig._fake_click_on_toolbar_action('Zoom out', wait_after=100)
+    scale_factor_new = fig.mne.scale_factor
+    assert scale_factor_new == scale_factor * step
+
+    for _ in range(6):
+        fig._fake_click_on_toolbar_action('Zoom out', wait_after=100)
+
+    step = 5 / 4
+    scale_factor = fig.mne.scale_factor
+    fig._fake_click_on_toolbar_action('Zoom in', wait_after=100)
+    scale_factor_new = fig.mne.scale_factor
+    assert scale_factor_new == scale_factor * step
+
+    for _ in range(6):
+        fig._fake_click_on_toolbar_action('Zoom in', wait_after=100)
+
+    assert pg_backend._get_n_figs() == 1  # still alive
+
+
+def test_pg_toolbar_annotations(raw_orig, pg_backend):
+    fig = raw_orig.plot()
+    fig.test_mode = True
+    QTest.qWaitForWindowExposed(fig)
+    assert pg_backend._get_n_figs() == 1
+
+    state_annotation_widget = fig.mne.annotation_mode
+    fig._fake_click_on_toolbar_action('Annotations', wait_after=100)
+    assert fig.mne.annotation_mode != state_annotation_widget
+
+    fig._fake_click_on_toolbar_action('Annotations', wait_after=300)
+    fig._fake_click_on_toolbar_action('Annotations', wait_after=300)
+    fig._fake_click_on_toolbar_action('Annotations', wait_after=300)
+
+    assert pg_backend._get_n_figs() == 1    # still alive
+
+
+def test_pg_toolbar_actions(raw_orig, pg_backend):
+    """ Test toolbar all actions combined.
+        Toolbar actions here create a separate QDialog window.
+        We test the state machine for each window toggle button. """
+    fig = raw_orig.plot()
+    fig.test_mode = True
+    QTest.qWaitForWindowExposed(fig)
+    assert pg_backend._get_n_figs() == 1
+
+    fig._fake_click_on_toolbar_action('SSP', wait_after=200)
+    assert pg_backend._get_n_figs() == 2
+    fig._fake_click_on_toolbar_action('Settings', wait_after=200)
+    assert pg_backend._get_n_figs() == 3
+    fig._fake_click_on_toolbar_action('Settings', wait_after=100)
+    assert pg_backend._get_n_figs() == 2
+    fig._fake_click_on_toolbar_action('Help', wait_after=200)
+    assert pg_backend._get_n_figs() == 3
+    fig._fake_click_on_toolbar_action('Settings', wait_after=200)
+    assert pg_backend._get_n_figs() == 4
+    fig._fake_click_on_toolbar_action('SSP', wait_after=200)
+    assert pg_backend._get_n_figs() == 3
+    fig._fake_click_on_toolbar_action('Settings', wait_after=100)
+    assert pg_backend._get_n_figs() == 2
+    fig._fake_click_on_toolbar_action('Help', wait_after=100)
+    assert pg_backend._get_n_figs() == 1