typing fix in het_colormap and added activable editor

Author: vld-codra

plotpy/mathutils/colormaps.py

@@ -10,7 +10,7 @@
 
 import json
 import os
-from typing import Sequence
+from typing import Dict, Sequence
 
 import numpy as np
 import qtpy.QtGui as QG
@@ -24,6 +24,8 @@
 FULLRANGE = QwtInterval(0.0, 1.0)
 DEFAULT = EditableColormap(name="jet")
 
+CmapDictType = Dict[str, EditableColormap]
+
 
 def load_raw_colormaps_from_json(
     json_path: str,
@@ -48,7 +50,7 @@ def load_raw_colormaps_from_json(
     return {}
 
 
-def load_qwt_colormaps_from_json(json_path: str) -> dict[str, EditableColormap]:
+def load_qwt_colormaps_from_json(json_path: str) -> CmapDictType:
     """Same as function load_raw_colormaps_from_json but transforms the raw colormaps
     into CustomQwtLinearColormap objects that are used by plotpy.
 
@@ -65,7 +67,7 @@ def load_qwt_colormaps_from_json(json_path: str) -> dict[str, EditableColormap]:
     }
 
 
-def save_colormaps(json_filename: str, colormaps: dict[str, EditableColormap]):
+def save_colormaps(json_filename: str, colormaps: CmapDictType):
     """Saves colormaps into the given json file. Refer ton function get_cmap_path to
     know what json_filename can be used.
 
@@ -126,6 +128,24 @@ def get_cmap(cmap_name: str) -> EditableColormap:
     return ALL_COLORMAPS.get(cmap_name.lower(), DEFAULT)
 
 
+def cmap_exists(cmap_name: str, cmap_dict: CmapDictType | None = None) -> bool:
+    """Returns True if the colormap with the given name exists in the given colormap
+    dictionary, False otherwise. If no dictionary is given, the ALL_COLORMAPS global
+    variable is used.
+
+    Args:
+        cmap_name: colormap name to search in given colormap dictionnary. All keys in
+        the dictionary are lower case, so the given name is also lowered.
+        cmap_dict: colormap dictionnary to search in. If None, ALL_COLORMAPS is used.
+
+    Returns:
+        True if the colormap exists, False otherwise.
+    """
+    if cmap_dict is None:
+        cmap_dict = ALL_COLORMAPS
+    return cmap_name.lower() in cmap_dict
+
+
 def add_cmap(cmap: EditableColormap) -> None:
     """Adds the given colormap to both ALL_COLORMAPS and CUSTOM_COLORMAPS global
     variables.
@@ -186,8 +206,8 @@ def get_cmap_path(config_path: str):
 )
 
 # Load default and custom colormaps from json files
-DEFAULT_COLORMAPS = load_qwt_colormaps_from_json(DEFAULT_COLORMAPS_PATH)
-CUSTOM_COLORMAPS = load_qwt_colormaps_from_json(CUSTOM_COLORMAPS_PATH)
+DEFAULT_COLORMAPS: CmapDictType = load_qwt_colormaps_from_json(DEFAULT_COLORMAPS_PATH)
+CUSTOM_COLORMAPS: CmapDictType = load_qwt_colormaps_from_json(CUSTOM_COLORMAPS_PATH)
 
 # Merge default and custom colormaps into a single dictionnary to simplify access
-ALL_COLORMAPS = {**DEFAULT_COLORMAPS, **CUSTOM_COLORMAPS}
+ALL_COLORMAPS: CmapDictType = {**DEFAULT_COLORMAPS, **CUSTOM_COLORMAPS}

plotpy/tests/features/test_colormap_manager.py

@@ -37,7 +37,7 @@ def test_colormap_manager() -> None:
         result = dlg.exec()
         execenv.print("Dialog result:", result)
         cmap = dlg.get_colormap()
-        execenv.print("Selected colormap:", cmap.name)
+        execenv.print("Selected colormap:", None if cmap is None else cmap.name)
 
 
 if __name__ == "__main__":

plotpy/tools/image.py

@@ -473,8 +473,8 @@ def activate_command(self, plot: BasePlot, checked: bool) -> None:
         manager = ColorMapManager(
             plot.parent(), active_colormap=self._active_colormap.name
         )
-        if exec_dialog(manager):
-            self.activate_cmap(manager.get_colormap())
+        if exec_dialog(manager) and (cmap := manager.get_colormap()) is not None:
+            self.activate_cmap(cmap)
 
     def get_selected_images(self, plot: BasePlot) -> list[IBasePlotItem]:
         """Returns the currently selected images in the given plot.

plotpy/widgets/colormap/manager.py

@@ -25,6 +25,8 @@
     DEFAULT_COLORMAPS,
     add_cmap,
     build_icon_from_cmap,
+    cmap_exists,
+    get_cmap,
 )
 from plotpy.widgets.colormap.editor import ColorMapEditor
 from plotpy.widgets.colormap.widget import EditableColormap
@@ -110,11 +112,12 @@ def __init__(
 
         self.__returned_colormap: EditableColormap | None = None
 
-        if active_colormap is None or active_colormap.lower() not in ALL_COLORMAPS:
+        if active_colormap is None or not cmap_exists(active_colormap, ALL_COLORMAPS):
             active_colormap = next(iter(ALL_COLORMAPS))
 
         # Select the active colormap
         self._cmap_choice = QW.QComboBox()
+        self._cmap_choice.setMaxVisibleItems(15)
         for cmap in ALL_COLORMAPS.values():
             icon = build_icon_from_cmap(cmap)
             self._cmap_choice.addItem(icon, cmap.name, cmap)
@@ -140,6 +143,9 @@ def __init__(
         edit_gbox_layout.setContentsMargins(0, 0, 0, 0)
         edit_gbox_layout.addWidget(self.colormap_editor)
         edit_gbox.setLayout(edit_gbox_layout)
+        edit_gbox.setCheckable(True)
+        edit_gbox.setChecked(False)
+        new_btn.clicked.connect(lambda: edit_gbox.setChecked(True))
         self.colormap_editor.colormap_widget.COLORMAP_CHANGED.connect(
             self._changes_not_saved
         )
@@ -153,7 +159,7 @@ def __init__(
         )
         self._changes_saved = True
         self._save_btn = self.bbox.button(QW.QDialogButtonBox.Save)
-        self._save_btn.setEnabled(False)
+        self._save_btn.setEnabled(False)  # type: ignore
         self.bbox.clicked.connect(self.button_clicked)
 
         dialog_layout = QW.QVBoxLayout()
@@ -181,7 +187,7 @@ def button_clicked(self, button: QW.QAbstractButton) -> None:
     def _changes_not_saved(self) -> None:
         """Callback function to be called when the colormap is modified. Enables the
         save button and sets the current_changes_saved attribute to False."""
-        self._save_btn.setEnabled(True)
+        self._save_btn.setEnabled(True)  # type: ignore
         self._changes_saved = False
 
     @property
@@ -203,11 +209,11 @@ def set_colormap(self, index: int) -> None:
         """
         cmap_copy: EditableColormap = deepcopy(self._cmap_choice.itemData(index))
         self.colormap_editor.set_colormap(cmap_copy)
-        is_new_colormap = cmap_copy.name.lower() not in ALL_COLORMAPS
+        is_new_colormap = not cmap_exists(cmap_copy.name, CUSTOM_COLORMAPS)
         self._changes_saved = True
-        self._save_btn.setEnabled(is_new_colormap)
+        self._save_btn.setEnabled(is_new_colormap)  # type: ignore
 
-    def get_colormap(self) -> EditableColormap:
+    def get_colormap(self) -> EditableColormap | None:
         """Return the selected colormap object.
 
         Returns:
@@ -231,7 +237,7 @@ def __get_new_colormap_name(self, title: str, name: str) -> str | None:
             new_name = ColorMapNameEdit.edit(self, new_name)
             if new_name is None:
                 return None
-            if new_name.lower() in DEFAULT_COLORMAPS:
+            if cmap_exists(new_name, DEFAULT_COLORMAPS):
                 QW.QMessageBox.warning(
                     self,
                     title,
@@ -243,22 +249,21 @@ def __get_new_colormap_name(self, title: str, name: str) -> str | None:
                     % new_name,
                 )
                 continue
-            if new_name.lower() in CUSTOM_COLORMAPS:
-                if (
-                    QW.QMessageBox.question(
-                        self,
-                        title,
-                        _(
-                            "Name <b>%s</b> is already used by a custom colormap.<br><br>"
-                            "Do you want to overwrite it?"
-                        )
-                        % new_name,
-                        QW.QMessageBox.Yes | QW.QMessageBox.No,
-                        QW.QMessageBox.No,
+            if cmap_exists(new_name, CUSTOM_COLORMAPS) and (
+                QW.QMessageBox.question(
+                    self,
+                    title,
+                    _(
+                        "Name <b>%s</b> is already used by a custom colormap.<br><br>"
+                        "Do you want to overwrite it?"
                     )
-                    == QW.QMessageBox.No
-                ):
-                    continue
+                    % new_name,
+                    QW.QMessageBox.Yes | QW.QMessageBox.No,
+                    QW.QMessageBox.No,
+                )
+                == QW.QMessageBox.No
+            ):
+                continue
             break
         return new_name
 
@@ -287,13 +292,13 @@ def save_colormap(self, cmap: EditableColormap | None = None) -> bool:
             return False
 
         # Before modifying CUSTOM_COLORMAPS, save this boolean expression:
-        is_existing_custom_cmap = new_name.lower() in CUSTOM_COLORMAPS
+        is_existing_custom_cmap = cmap_exists(new_name, CUSTOM_COLORMAPS)
 
         # Take into account the case where the color map exists in custom colormaps
         # but not with the same case (e.g. "viridis" vs "Viridis"). So we need to
         # get the original name of the colormap:
         if is_existing_custom_cmap:
-            new_name = CUSTOM_COLORMAPS[new_name.lower()].name
+            new_name = get_cmap(new_name).name
 
         cmap.name = new_name
         add_cmap(cmap)
@@ -308,7 +313,7 @@ def save_colormap(self, cmap: EditableColormap | None = None) -> bool:
             self._cmap_choice.addItem(icon, new_name, cmap)
             self._cmap_choice.setCurrentText(new_name)
 
-        self._save_btn.setEnabled(False)
+        self._save_btn.setEnabled(False)  # type: ignore
         self._changes_saved = True
         return True
 

plotpy/widgets/colormap/widget.py

@@ -36,16 +36,15 @@ class EditableColormap(QwtLinearColorMap):
     Args:
         *args: QwtLinearColorMap arguments
         name: Optional str name given to the colormap. Useful for the interactions
-        with the rest of PlotPy, notably with the gobal colormaps dictionnary
-        such as colormaps.ALL_COLORMAPS. Defaults to "None".
+        with the rest of PlotPy, notably with the gobal colormaps dictionaries
+        such as colormaps.ALL_COLORMAPS. If None, the colormap name will be set to
+        "temporary". Defaults to None.
     """
 
     def __init__(self, *args, name: str | None = None) -> None:
         super().__init__(*args)
         # TODO: Add this feature in a release of QwtPython
-        self.stops: list[
-            ColorStop
-        ] = (
+        self.stops: list[ColorStop] = (
             self._QwtLinearColorMap__data.colorStops._ColorStops__stops  # pylint: disable=no-member # type: ignore
         )
         self.name = name or "temporary"