test: Add more tests for common GUI elements (#622)

* add tests

* small fixes

* 'Refactored by Sourcery' (#623)

Co-authored-by: Sourcery AI <>

* base main window tests

* silence obsolete warnings

* add more tests

* fix tests

* skip part of tests on windows

* add waitng steeps

* try fix pyside tests

* add drop test

* add test for MultipleFilesTreeWidget

* fix test for pyside

* enable ImageView QMenu tests for pyside

* add load_data_exception_hook test

* update algorithm description tests

* BaseAlgorithmSettingsWidget use name from algorithm

* add test for AlgorithmChoose

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Author: Czaki

package/PartSeg/_roi_mask/main_window.py

@@ -40,7 +40,7 @@
 from .._roi_mask.segmentation_info_dialog import SegmentationInfoDialog
 from ..common_backend.base_settings import IO_SAVE_DIRECTORY, ROI_NOT_FIT
 from ..common_gui.advanced_tabs import AdvancedWindow
-from ..common_gui.algorithms_description import AlgorithmChoose, AlgorithmSettingsWidget
+from ..common_gui.algorithms_description import AlgorithmChoose, InteractiveAlgorithmSettingsWidget
 from ..common_gui.channel_control import ChannelProperty
 from ..common_gui.custom_load_dialog import PLoadDialog
 from ..common_gui.custom_save_dialog import PSaveDialog
@@ -720,7 +720,7 @@ def execute_action(self):
             # TODO Fix This
             blank = blank[0]
         self.progress_bar.setHidden(False)
-        widget: AlgorithmSettingsWidget = self.algorithm_choose_widget.current_widget()
+        widget: InteractiveAlgorithmSettingsWidget = self.algorithm_choose_widget.current_widget()
         widget.set_mask(blank)
         self.progress_bar.setRange(0, widget.algorithm.get_steps_num())
         widget.execute()

package/PartSeg/common_gui/algorithms_description.py

@@ -48,11 +48,11 @@
 from .universal_gui_part import ChannelComboBox, CustomDoubleSpinBox, CustomSpinBox
 
 
-def update(d, u):
+def recursive_update(d, u):
     if not isinstance(d, typing.MutableMapping):
         d = {}
     for k, v in u.items():
-        d[k] = update(d.get(k, {}), v) if isinstance(v, collections.abc.Mapping) else v
+        d[k] = recursive_update(d.get(k, {}), v) if isinstance(v, collections.abc.Mapping) else v
     return d
 
 
@@ -70,13 +70,20 @@ def __init__(self):
         super().__init__()
         self._settings = None
 
-    def add_settings(self, settings: BaseSettings):
+    def _update_choices(self):
+        if hasattr(self._settings, "roi_profiles"):
+            self.clear()
+            self.addItems(list(self._settings.roi_profiles.keys()))
+
+    def set_settings(self, settings: BaseSettings):
         self._settings = settings
-        if hasattr(settings, "roi_profiles"):
-            self.addItems(list(settings.roi_profiles.keys()))
+        if hasattr(self._settings, "roi_profiles"):
+            self._settings.roi_profiles.setted.connect(self._update_choices)
+            self._settings.roi_profiles.deleted.connect(self._update_choices)
+        self._update_choices()
 
     def get_value(self):
-        if self._settings is not None and hasattr(self._settings, "roi_profiles"):
+        if self._settings is not None and hasattr(self._settings, "roi_profiles") and self.currentText() != "":
             return self._settings.roi_profiles[self.currentText()]
         return None
 
@@ -386,6 +393,7 @@ def _add_to_layout(
             if ap.name in start_values:
                 ap.get_field().set_starting(start_values[ap.name])
             ap.change_fun.connect(_any_arguments(self.value_changed.emit))
+            self.channels_chose.append(ap.get_field())
             return
         if isinstance(ap.get_field(), Widget):
             layout.addRow(label, ap.get_field().native)
@@ -402,7 +410,7 @@ def _add_to_layout(
             self.channels_chose.append(ap.get_field())
         if issubclass(ap.value_type, ROIExtractionProfile):
             # noinspection PyTypeChecker
-            ap.get_field().add_settings(settings)
+            ap.get_field().set_settings(settings)
         if ap.name in start_values:
             with suppress(KeyError, ValueError, TypeError):
                 ap.set_value(start_values[ap.name])
@@ -562,20 +570,20 @@ class BaseAlgorithmSettingsWidget(QScrollArea):
     values_changed = Signal()
     algorithm_thread: SegmentationThread
 
-    def __init__(self, settings: BaseSettings, name, algorithm: typing.Type[ROIExtractionAlgorithm]):
+    def __init__(self, settings: BaseSettings, algorithm: typing.Type[ROIExtractionAlgorithm]):
         """
         For algorithm which works on one channel
         """
         super().__init__()
         self.settings = settings
         self.widget_list = []
-        self.name = name
         self.algorithm = algorithm
         main_layout = QVBoxLayout()
         self.info_label = QLabel()
         self.info_label.setHidden(True)
+        # FIXME verify inflo_label usage
         main_layout.addWidget(self.info_label)
-        start_values = settings.get(f"algorithm_widget_state.{name}", {})
+        start_values = settings.get(f"algorithm_widget_state.{self.name}", {})
         self.form_widget = self._form_widget(algorithm, start_values=start_values)
         self.form_widget.value_changed.connect(self.values_changed.emit)
         self.setWidget(self.form_widget)
@@ -585,6 +593,10 @@ def __init__(self, settings: BaseSettings, name, algorithm: typing.Type[ROIExtra
         self.algorithm_thread.info_signal.connect(self.show_info)
         self.algorithm_thread.exception_occurred.connect(self.exception_occurred)
 
+    @property
+    def name(self):
+        return self.algorithm.get_name()
+
     @staticmethod
     def _form_widget(algorithm, start_values) -> FormWidget:
         return FormWidget(
@@ -615,7 +627,7 @@ def exception_occurred(exc: Exception):
 
     def show_info(self, text):
         self.info_label.setText(text)
-        self.info_label.setVisible(True)
+        self.info_label.setVisible(text != "")
 
     def image_changed(self, image: Image):
         self.form_widget.image_changed(image)
@@ -633,9 +645,6 @@ def set_values(self, values_dict):
     def get_values(self):
         return self.form_widget.get_values()
 
-    def channel_num(self):
-        return self.channels_chose.currentIndex()
-
     def execute(self, exclude_mask=None):
         values = self.get_values()
         self.settings.set(f"algorithms.{self.name}", deepcopy(values))
@@ -659,29 +668,18 @@ def recursive_get_values(self):
         return self.form_widget.recursive_get_values()
 
 
-class AlgorithmSettingsWidget(BaseAlgorithmSettingsWidget):
-    def execute(self, exclude_mask=None):
-        self.algorithm_thread.algorithm.set_image(self.settings.image)
-        super().execute(exclude_mask)
-
-
 class InteractiveAlgorithmSettingsWidget(BaseAlgorithmSettingsWidget):
     algorithm_thread: SegmentationThread
 
-    def __init__(self, settings, name, algorithm: typing.Type[ROIExtractionAlgorithm], selector: typing.List[QWidget]):
-        super().__init__(settings, name, algorithm)
-        self.selector = selector
+    def __init__(self, settings, algorithm: typing.Type[ROIExtractionAlgorithm], selector: typing.List[QWidget]):
+        super().__init__(settings, algorithm)
+        self.selector = selector[:]
         self.algorithm_thread.finished.connect(self.enable_selector)
         self.algorithm_thread.started.connect(self.disable_selector)
         # noinspection PyUnresolvedReferences
         if hasattr(settings, "mask_changed"):
             settings.mask_changed.connect(self.change_mask)
 
-    def value_updated(self):
-        if not self.parent().interactive:
-            return
-        self.execute()
-
     def change_mask(self):
         if not self.isVisible():
             return
@@ -726,15 +724,15 @@ def __init__(self, settings: BaseSettings, algorithms: typing.Type[AlgorithmSele
         self.setLayout(layout)
 
     @staticmethod
-    def _algorithm_widget(settings, name, val) -> InteractiveAlgorithmSettingsWidget:
-        return InteractiveAlgorithmSettingsWidget(settings, name, val, [])
+    def _algorithm_widget(settings, val) -> InteractiveAlgorithmSettingsWidget:
+        return InteractiveAlgorithmSettingsWidget(settings, val, [])
 
     def add_widgets_to_algorithm(self):
         self.algorithm_choose.blockSignals(True)
         self.algorithm_choose.clear()
         for name, val in self.algorithms.__register__.items():
             self.algorithm_choose.addItem(name)
-            widget = self._algorithm_widget(self.settings, name, val)
+            widget = self._algorithm_widget(self.settings, val)
             self.algorithm_dict[name] = widget
             widget.algorithm_thread.execution_done.connect(self.result.emit)
             widget.algorithm_thread.finished.connect(self.finished.emit)
@@ -770,7 +768,9 @@ def updated_algorithm(self):
     def recursive_get_values(self):
         result = {key: widget.recursive_get_values() for key, widget in self.algorithm_dict.items()}
 
-        self.settings.set("algorithm_widget_state", update(self.settings.get("algorithm_widget_state", {}), result))
+        self.settings.set(
+            "algorithm_widget_state", recursive_update(self.settings.get("algorithm_widget_state", {}), result)
+        )
         return result
 
     def change_algorithm(self, name, values: dict = None):

package/PartSeg/common_gui/exception_hooks.py

@@ -1,12 +1,14 @@
 import logging
 
 from PartSeg.common_backend.except_hook import show_warning
+from PartSegImage.image_reader import INCOMPATIBLE_IMAGE_MASK
 
 OPEN_ERROR = "Open error"
 
 
 def load_data_exception_hook(exception):
-    if isinstance(exception, ValueError) and exception.args[0] == "Incompatible shape of mask and image":
+    if isinstance(exception, ValueError) and exception.args[0] == INCOMPATIBLE_IMAGE_MASK:
+        # TODO think about incompatibilible axes (image_reader:417)
         show_warning(OPEN_ERROR, "Most probably you try to load mask from other image. Check selected files.")
     elif isinstance(exception, MemoryError):
         show_warning(OPEN_ERROR, f"Not enough memory to read this image: {exception}")

package/PartSeg/common_gui/main_window.py

@@ -30,58 +30,69 @@
 OPEN_DIRECTORY = "io.open_directory"
 OPEN_FILE_FILTER = "io.open_filter"
 
+_EXIT = object()
+
 
 class BaseMainMenu(QWidget):
     def __init__(self, settings: BaseSettings, main_window):
         super().__init__()
         self.settings = settings
         self.main_window = main_window
 
+    def _set_data_list(self, data_list):
+        if len(data_list) == 0:
+            QMessageBox.warning(self, "Empty list", "List of files to load is empty")
+            return _EXIT
+        if hasattr(self.main_window, "multiple_files"):
+            self.main_window.multiple_files.add_states(data_list)
+            self.main_window.multiple_files.setVisible(True)
+            self.settings.set("multiple_files", True)
+        return data_list[0]
+
+    def _set_project_info_base(self, project_info_base: ProjectInfoBase):
+        if project_info_base.errors != "":  # pragma: no cover
+            resp = QMessageBox.question(
+                self,
+                "Load problem",
+                f"During load data "
+                f"some problems occur: {project_info_base.errors}."
+                "Do you would like to try load it anyway?",
+                QMessageBox.Yes | QMessageBox.No,
+            )
+            if resp == QMessageBox.No:
+                return _EXIT
+        try:
+            image = self.settings.verify_image(project_info_base.image, False)
+        except SwapTimeStackException:
+            res = QMessageBox.question(
+                self,
+                "Not supported",
+                "Time data are currently not supported. Maybe You would like to treat time as z-stack",
+                QMessageBox.Yes | QMessageBox.No,
+                QMessageBox.No,
+            )
+
+            if res == QMessageBox.Yes:
+                image = project_info_base.image.swap_time_and_stack()
+            else:
+                return _EXIT
+        except TimeAndStackException:
+            QMessageBox.warning(self, "image error", "Do not support time and stack image")
+            return _EXIT
+        if not image:
+            return _EXIT
+        if isinstance(image, Image):
+            # noinspection PyProtectedMember
+            project_info_base = dataclasses.replace(project_info_base, image=image)
+        return project_info_base
+
     def set_data(self, data):
         if isinstance(data, list):
-            if len(data) == 0:
-                QMessageBox.warning(self, "Empty list", "List of files to load is empty")
-                return
-            if hasattr(self.main_window, "multiple_files"):
-                self.main_window.multiple_files.add_states(data)
-                self.main_window.multiple_files.setVisible(True)
-                self.settings.set("multiple_files", True)
-            data = data[0]
+            data = self._set_data_list(data)
         if isinstance(data, ProjectInfoBase):
-            if data.errors != "":
-                resp = QMessageBox.question(
-                    self,
-                    "Load problem",
-                    f"During load data "
-                    f"some problems occur: {data.errors}."
-                    "Do you would like to try load it anyway?",
-                    QMessageBox.Yes | QMessageBox.No,
-                )
-                if resp == QMessageBox.No:
-                    return
-            try:
-                image = self.settings.verify_image(data.image, False)
-            except SwapTimeStackException:
-                res = QMessageBox.question(
-                    self,
-                    "Not supported",
-                    "Time data are currently not supported. Maybe You would like to treat time as z-stack",
-                    QMessageBox.Yes | QMessageBox.No,
-                    QMessageBox.No,
-                )
-
-                if res == QMessageBox.Yes:
-                    image = data.image.swap_time_and_stack()
-                else:
-                    return
-            except TimeAndStackException:
-                QMessageBox.warning(self, "image error", "Do not support time and stack image")
-                return
-            if not image:
-                return
-            if isinstance(image, Image):
-                # noinspection PyProtectedMember
-                data = dataclasses.replace(data, image=image)
+            data = self._set_project_info_base(data)
+        if data is _EXIT:
+            return
         if data is None:
             QMessageBox().warning(self, "Data loading failure", "Error during data loading", QMessageBox.Ok)
             return
@@ -148,7 +159,7 @@ def __init__(
         self.setWindowTitle(title)
         self.title_base = title
         app = QApplication.instance()
-        if app is not None and "PYTEST_CURRENT_TEST" not in os.environ:
+        if app is not None and "PYTEST_CURRENT_TEST" not in os.environ:  # pragma: no cover
             # FIXME the PYTEST_CURRENT_TEST is used to prevent pytest session fail on CI.
             app.setStyleSheet(settings.get_style_sheet())
         self.settings.theme_changed.connect(self.change_theme)
@@ -193,11 +204,11 @@ def _load_recent(self):
                 self.settings.set(OPEN_DIRECTORY, os.path.dirname(data[0][0]))
                 self.settings.set(OPEN_FILE, data[0][0])
                 self.settings.set(OPEN_FILE_FILTER, data[1])
-        except KeyError:
+        except KeyError:  # pragma: no cover
             self.read_drop(data[0])
 
     def toggle_multiple_files(self):
-        self.settings.set("multiple_files_widget", not self.settings.get("multiple_files_widget"))
+        self.settings.set("multiple_files_widget", not self.settings.get("multiple_files_widget", False))
 
     def get_colormaps(self) -> List[Optional[colormap.Colormap]]:
         channel_num = self.settings.image.channels
@@ -233,7 +244,7 @@ def close_viewer(self, obj):
     def change_theme(self, event):
         style_sheet = self.settings.style_sheet
         app = QApplication.instance()
-        if app is not None:
+        if app is not None and "PYTEST_CURRENT_TEST" not in os.environ:  # pragma: no cover
             app.setStyleSheet(style_sheet)
         self.setStyleSheet(style_sheet)
 

package/PartSeg/common_gui/multiple_file_widget.py

@@ -35,7 +35,7 @@
 from .waiting_dialog import ExecuteFunctionDialog
 
 
-class CustomTreeWidget(QTreeWidget):
+class MultipleFilesTreeWidget(QTreeWidget):
     context_load = Signal(QTreeWidgetItem)
     context_compare = Signal(QTreeWidgetItem)
     context_forget = Signal(QTreeWidgetItem)
@@ -123,7 +123,7 @@ def __init__(self, settings: BaseSettings, load_dict: Dict[str, LoadBase], compa
         self.state_dict_count = Counter()
         self.file_list = []
         self.load_register = load_dict
-        self.file_view = CustomTreeWidget(compare_in_context_menu)
+        self.file_view = MultipleFilesTreeWidget(compare_in_context_menu)
         self.file_view.header().close()
         self.save_state_btn = QPushButton("Save state")
         self.save_state_btn.setStyleSheet("QPushButton{font-weight: bold;}")
@@ -222,7 +222,7 @@ def load_files(self):
                 errors_message.setText("There are errors during load files")
                 errors_message.setInformativeText("During load files cannot found some of files on disc")
                 errors_message.setStandardButtons(QMessageBox.Ok)
-                text = "\n".join("File: " + x[0] + "\n" + str(x[1]) for x in self.error_list)
+                text = "\n".join(f"File: {x[0]}" + "\n" + str(x[1]) for x in self.error_list)
                 errors_message.setDetailedText(text)
                 errors_message.exec_()