small pass on annotations

Author: vld-codra

plotpy/items/curve/base.py

@@ -360,12 +360,12 @@ def get_data(self) -> tuple[np.ndarray, np.ndarray]:
         assert isinstance(self._x, np.ndarray) and isinstance(self._y, np.ndarray)
         return self._x, self._y
 
-    def update_data(self):
+    def update_data(self) -> None:
         """Update curve data with current arrays."""
         if isinstance(self._x, np.ndarray) and isinstance(self._y, np.ndarray):
             self._setData(self._x, self._y)
 
-    def _setData(self, x: np.ndarray, y: np.ndarray):
+    def _setData(self, x: np.ndarray, y: np.ndarray) -> None:
         """Wrapper around QwtPlotCurve.setData() to handle downsampling"""
         if not self.param.use_downsampling or self.param.downsampling_factor == 1:
             return super().setData(x, y)

plotpy/styles/curve.py

@@ -49,7 +49,7 @@ class CurveParam(DataSet):
         "display", active=_downsampling_prop
     )
 
-    def update_param(self, curve: CurveItem | PolygonMapItem):
+    def update_param(self, curve: CurveItem | PolygonMapItem) -> None:
         """Updates the parameters using values from a given CurveItem/PolygonMapItem
 
         Args:
@@ -61,7 +61,7 @@ def update_param(self, curve: CurveItem | PolygonMapItem):
         self.curvestyle = CURVESTYLE_NAME[curve.style()]
         self.baseline = curve.baseline()
 
-    def update_item(self, curve: CurveItem | PolygonMapItem):
+    def update_item(self, curve: CurveItem | PolygonMapItem) -> None:
         """Updates a given CurveItem/PolygonMapItem using the current parameters
 
         Args:

plotpy/styles/image.py

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+from typing import Callable
+
 import numpy as np
 from guidata.dataset import (
     BeginGroup,
@@ -23,9 +25,9 @@
 from plotpy.styles.base import ItemParameters
 
 
-def _create_choices():
-    choices = []
-    for cmap_name in ALL_COLORMAPS.keys():
+def _create_choices() -> list[tuple[str, str, Callable[[str], QG.QIcon]]]:
+    choices: list[tuple[str, str, Callable[[str], QG.QIcon]]] = []
+    for cmap_name in ALL_COLORMAPS:
         choices.append((cmap_name, cmap_name, build_icon_from_cmap_name))
     return choices
 

plotpy/tests/features/test_colormap_editor.py

@@ -23,7 +23,10 @@
 from plotpy.widgets.colormap_widget import CustomQwtLinearColormap
 
 
-def test_colormap_manager():
+def test_colormap_manager() -> None:
+    """Test the colormap editor widget and the CustomQwtLinearColormap class
+    by using multiple methods to initialize and export the colormap.
+    """
     with qt_app_context(exec_loop=True):
         print("Initialization of a default colormap editor widget")
         editor = ColorMapEditor(None)

plotpy/tests/features/test_colormap_manager.py

@@ -20,9 +20,9 @@
 from plotpy.widgets.colormap_widget import CustomQwtLinearColormap
 
 
-def test_colormap_manager():
+def test_colormap_manager() -> None:
+    """Test the colormap manager widget."""
     with qt_app_context(exec_loop=True):
-        # app = QW.QApplication([])
         red = QG.QColor(QC.Qt.GlobalColor.red)
         blue = QG.QColor(QC.Qt.GlobalColor.blue)
         yellow = QG.QColor(QC.Qt.GlobalColor.yellow)

plotpy/tests/tools/test_downsample_curve.py

@@ -11,6 +11,8 @@
 
 # guitest: show
 
+from typing import Any
+
 from guidata.qthelpers import exec_dialog, qt_app_context
 from numpy import linspace, sin
 
@@ -19,7 +21,7 @@
 from plotpy.tools import DownSampleCurveTool, EditPointTool
 
 
-def callback_function(tool: EditPointTool):
+def callback_function(tool: EditPointTool) -> None:
     """Callback that is called by the tool when the user stops clicking. Just prints
     the new arrays and the changes.
 
@@ -31,9 +33,17 @@ def callback_function(tool: EditPointTool):
     print("Indexed changes:", tool.get_changes())
 
 
-def edit_downsampled_curve(downsampling_factor: int, *args):
+def edit_downsampled_curve(downsampling_factor: int, *args) -> tuple[Any, ...]:
     """
     Plot curves and return selected point(s) coordinates
+
+    Args:
+        downsampling_factor: downsampling factor (>=1)
+        *args: arguments to be passed to the plotpy builder make.mcurve function
+
+    Returns:
+        Modified *args input that can be used in another call to this function to check
+        the interaction between edit tool and the donwsampling tool.
     """
     win = make.dialog(
         wintitle=_("Select one point then press OK to accept"),
@@ -65,8 +75,8 @@ def edit_downsampled_curve(downsampling_factor: int, *args):
     return args
 
 
-def test_edit_curve():
-    """Test"""
+def test_downsample_curve() -> None:
+    """Test the downsample curve tool."""
     with qt_app_context(exec_loop=False):
         nlines = 1000
         x = linspace(-10, 10, num=nlines)
@@ -78,4 +88,4 @@ def test_edit_curve():
 
 
 if __name__ == "__main__":
-    test_edit_curve()
+    test_downsample_curve()

plotpy/tools/base.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from __future__ import annotations
 
 import weakref
 from typing import Any, TypeVar

plotpy/tools/curve.py

@@ -53,7 +53,7 @@ class CurveStatsTool(BaseCursorTool):
 
     def __init__(
         self, manager, toolbar_id=DefaultToolbarID, title=None, icon=None, tip=None
-    ):
+    ) -> None:
         super().__init__(manager, toolbar_id, title=title, icon=icon, tip=tip)
         self._last_item = None
         self.label = None
@@ -340,7 +340,7 @@ def __init__(
         marker_style=None,
         switch_to_default_tool=None,
         max_select: int | None = None,
-    ):
+    ) -> None:
         super().__init__(
             manager,
             toolbar_id,
@@ -637,7 +637,7 @@ class InsertionDataSet(DataSet):
         index_offset = ChoiceItem(_("Location"), choices=["Before", "After"], default=0)
 
         @classmethod
-        def set_max_index(cls, max_index: int):
+        def set_max_index(cls, max_index: int) -> None:
             """Sets the maximum index value for the index field
 
             Args:

plotpy/tools/image.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """Image tools"""
 
 from __future__ import annotations

plotpy/widgets/_colormap_slider.py

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 """A custom QDoubleRangeSlider with some extra functionnalities for colormap sliders.
 """
 from typing import Sequence
@@ -10,7 +12,7 @@ class QColorMapSlider(QDoubleRangeSlider):
     sliders."""
 
     @property
-    def pressed_index(self):
+    def pressed_index(self) -> int:
         """Simple getter for the index of the handle pressed by the user
         (mouse clicked).