final pylint pass

Author: vld-codra

.vscode/tasks.json

@@ -127,6 +127,7 @@
                 "run_pylint.bat",
                 // "--disable=R0801,C0103,C0114,C0115,C0116,W0612,W0613",
                 "--disable=fixme,C,R,W",
+                "--ignore=external",
             ],
             "options": {
                 "cwd": "scripts",

plotpy/mathutils/colormaps.py

@@ -1,4 +1,8 @@
 # -*- coding: utf-8 -*-
+"""This module provides utilities to interact with colormap. It provides functions
+to load/save colormaps from/to json files and to build icons representing the
+colormaps.
+"""
 #
 # Licensed under the terms of the BSD 3-Clause
 # (see plotpy/LICENSE for details)
@@ -35,10 +39,10 @@ def load_raw_colormaps_from_json(
         Dictionnary of colormaps names -> raw colormap sequences
     """
     if isinstance(json_path, str) and os.path.isfile(json_path):
-        with open(json_path) as f:
+        with open(json_path, encoding="utf-8") as f:
             try:
                 return json.load(f)
-            except BaseException as e:
+            except json.JSONDecodeError as e:
                 print(e)
                 return {}
     return {}
@@ -71,7 +75,7 @@ def save_colormaps(json_filename: str, colormaps: dict[str, CustomQwtLinearColor
     """
     raw_colormaps = {name: cmap.to_tuples() for name, cmap in colormaps.items()}
     json_abs_path = CONF.get_path(json_filename)
-    with open(json_abs_path, "w") as f:
+    with open(json_abs_path, "w", encoding="utf-8") as f:
         json.dump(raw_colormaps, f, indent=4)
 
 
@@ -139,7 +143,7 @@ def get_cmap_path(config_path: str):
         )
         if os.path.isfile(data_config_path):
             return data_config_path
-    except BaseException as e:
+    except (FileNotFoundError, PermissionError, OSError) as e:
         print(e)
 
     user_config_path = CONF.get_path(config_path)
@@ -154,11 +158,17 @@ def get_cmap_path(config_path: str):
 
 # Load default colormaps path from the config file
 DEFAULT_COLORMAPS_PATH = get_cmap_path(
-    CONF.get("colormaps", "colormaps/default", default="colormaps_default.json")  # type: ignore
+    CONF.get(
+        "colormaps",
+        "colormaps/default",
+        default="colormaps_default.json",  # type: ignore
+    )
 )
 # Load custom colormaps path from the config file
 CUSTOM_COLORMAPS_PATH = get_cmap_path(
-    CONF.get("colormaps", "colormaps/custom", default="colormaps_custom.json")  # type: ignore
+    CONF.get(
+        "colormaps", "colormaps/custom", default="colormaps_custom.json"  # type: ignore
+    )
 )
 
 # Load default and custom colormaps from json files

plotpy/styles/curve.py

@@ -30,6 +30,8 @@
 
 
 class CurveParam(DataSet):
+    """Dataset defining the parameters of a CurveItem or PolygonMapItem"""
+
     _multiselection = False
     label = StringItem(_("Title"), default="").set_prop(
         "display", hide=GetAttrProp("_multiselection")
@@ -91,6 +93,8 @@ def update_item(self, curve: CurveItem | PolygonMapItem):
 
 
 class CurveParam_MS(CurveParam):
+    """Same as CurveParam but for multiselection"""
+
     _multiselection = True
 
 

plotpy/tests/features/test_colormap_editor.py

@@ -17,7 +17,6 @@
 import qtpy.QtCore as QC
 import qtpy.QtGui as QG
 import qtpy.QtWidgets as QW
-from guidata.env import execenv
 
 from plotpy.widgets.colormap_editor import ColorMapEditor
 from plotpy.widgets.colormap_widget import CustomQwtLinearColormap

plotpy/tests/features/test_colormap_manager.py

@@ -13,7 +13,6 @@
 
 import qtpy.QtCore as QC
 import qtpy.QtGui as QG
-import qtpy.QtWidgets as QW
 from guidata.qthelpers import qt_app_context
 
 from plotpy.mathutils.colormaps import ALL_COLORMAPS

plotpy/tests/tools/test_downsample_curve.py

@@ -20,6 +20,13 @@
 
 
 def callback_function(tool: EditPointTool):
+    """Callback that is called by the tool when the user stops clicking. Just prints
+    the new arrays and the changes.
+
+    Args:
+        tool: tool instance that can be used to retrieve the new arrays and the
+        changes
+    """
     print("New arrays:", tool.get_arrays())
     print("Indexed changes:", tool.get_changes())
 

plotpy/tools/curve.py

@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-
 """Curve tools"""
 
 from __future__ import annotations
@@ -425,7 +424,7 @@ def _init_current_marker(
         """
         plot = filter.plot
         if not isinstance(plot, BasePlot):
-            return None
+            return
         if force_new_marker or self.current_location_marker is None:
             title = title or f"<b>{self.TITLE} {len(self.markers)}</b><br>"
             constraint_cb = plot.on_active_curve if self.on_active_item else None
@@ -475,7 +474,7 @@ def move(self, filter: StatefulEventFilter, event: QG.QMouseEvent) -> None:
         """
         plot = filter.plot
         if not isinstance(plot, BasePlot):
-            return None
+            return
         if self.current_location_marker is None:
             return  # something is wrong ...
         self.current_location_marker.move_local_point_to(0, event.pos())
@@ -639,6 +638,11 @@ class InsertionDataSet(DataSet):
 
         @classmethod
         def set_max_index(cls, max_index: int):
+            """Sets the maximum index value for the index field
+
+            Args:
+                max_index: max index value
+            """
             cls.index.set_prop("data", max=max_index)
 
     def __init__(
@@ -1038,11 +1042,11 @@ def get_changes(self) -> dict[CurveItem, dict[int, tuple[float, float]]]:
         """Get changes"""
         return self._indexed_changes
 
-    def get_arrays(self) -> tuple[np.ndarray| None, np.ndarray | None]:
+    def get_arrays(self) -> tuple[np.ndarray | None, np.ndarray | None]:
         """Get arrays"""
         return self._x, self._y
 
-    def get_initial_arrays(self) -> tuple[np.ndarray| None, np.ndarray | None]:
+    def get_initial_arrays(self) -> tuple[np.ndarray | None, np.ndarray | None]:
         """Get initial arrays"""
         return self._x_bkp, self._y_bkp
 

plotpy/tools/image.py

@@ -1,3 +1,5 @@
+"""Image tools"""
+
 from __future__ import annotations
 
 import weakref
@@ -113,10 +115,10 @@ def get_infos(self) -> str | None:
             str: Formatted string with informations on current shape
         """
         if self.image_item is None:
-            return
+            return None
         plot = self.image_item.plot()
         if plot is None:
-            return
+            return None
         p0y = plot.transform(0, self.shape.get_points()[0][1])
         p0x = plot.transform(2, self.shape.get_points()[0][0])
         p1y = plot.transform(0, self.shape.get_points()[1][1])
@@ -198,6 +200,7 @@ def get_last_item(self) -> BaseImageItem | None:
         """
         if self._last_item is not None:
             return self._last_item()
+        return None
 
     def create_shape(self):
         """Returns a new ImageStatsRectangle instance with default x1, y1, x2, y2values
@@ -509,7 +512,7 @@ def get_selected_images(self, plot: BasePlot):
         Returns:
             list of currently selected images in the given plot
         """
-        items = [it for it in plot.get_selected_items(item_type=IColormapImageItemType)]
+        items = plot.get_selected_items(item_type=IColormapImageItemType)
         if not items:
             active_image = plot.get_last_active_item(IColormapImageItemType)
             if active_image:
@@ -758,10 +761,10 @@ def find_masked_image(
         item = plot.get_active_item()
         if isinstance(item, maskedtypes):
             return item
-        else:
-            items = [item for item in plot.get_items() if isinstance(item, maskedtypes)]
-            if items:
-                return items[-1]
+        items = [item for item in plot.get_items() if isinstance(item, maskedtypes)]
+        if items:
+            return items[-1]
+        return None
 
     def create_shapes_from_masked_areas(self):
         """Creates shapes from the masked areas of the masked image (rectangular or
@@ -1118,7 +1121,7 @@ def update_status(self, plot: BasePlot):
             plot: Plot instance
         """
         status = any(
-            [isinstance(item, TrImageItem) for item in plot.get_selected_items()]
+            isinstance(item, TrImageItem) for item in plot.get_selected_items()
         )
         self.action.setEnabled(status)
 

plotpy/widgets/_colormap_slider.py

@@ -1,14 +1,12 @@
+"""A custom QDoubleRangeSlider with some extra functionnalities for colormap sliders.
+"""
 from typing import Sequence
 
-import qtpy.QtCore as QC
-import qtpy.QtGui as QG
-import qtpy.QtWidgets as QW
-
 from plotpy.external.sliders import QDoubleRangeSlider
 
 
 class QColorMapSlider(QDoubleRangeSlider):
-    """supercharged QDoubleRangeSlider with a few extra features for colormap
+    """Supercharged QDoubleRangeSlider with a few extra features for colormap
     sliders."""
 
     @property
@@ -46,14 +44,14 @@ def filter_first_last_positions(self, value: Sequence[float]) -> Sequence[float]
             value[0], value[-1] = self._minimum, self._maximum
         return value
 
-    def _setPosition(self, value: Sequence[float]) -> None:
+    def _setPosition(self, val: Sequence[float]) -> None:
         """Overload of the original _setPosition method to prevent the application from
         crashing if the first and last handles are moved.
 
         Args:
             value: list of handle values
         """
-        return super()._setPosition(self.filter_first_last_positions(value))
+        return super()._setPosition(self.filter_first_last_positions(val))
 
     def setValue(self, value: Sequence[float]) -> None:
         """Overload of the original setValue method to prevent the application from

plotpy/widgets/colormap_editor.py

@@ -3,6 +3,11 @@
 # Licensed under the terms of the BSD 3-Clause
 # (see plotpy/LICENSE for details)
 
+"""This module provides a more complete colormap editor widget than the one provided
+by ColorMapWidget (plotpy/widgets/colormap_widget.py). It allows to edit a colormap
+by changing its color stops (add/delete/move/change color).
+"""
+
 import qtpy.QtCore as QC
 import qtpy.QtGui as QG
 import qtpy.QtWidgets as QW
@@ -267,7 +272,7 @@ def update_colormap_widget(self):
 
         new_slider_values = self.colormap_widget.get_handles_list()
 
-        if current_index > 0 and current_index < self.tabs.count() - 1:
+        if 0 < current_index < self.tabs.count() - 1:
             relative_pos = current_dataset.get_position()
         else:
             relative_pos = new_slider_values[current_index]