SelectPointsTool: review/ok

Author: PierreRaybaut

plotpy/tests/tools/test_get_point.py

@@ -11,6 +11,8 @@
 
 # guitest: show
 
+from __future__ import annotations
+
 from guidata.qthelpers import exec_dialog, qt_app_context
 from numpy import linspace, sin
 
@@ -19,13 +21,16 @@
 from plotpy.tools import SelectPointTool
 
 
-def callback_function(tool):
+def callback_function(tool: SelectPointTool) -> None:
     print("Current coordinates:", tool.get_coordinates())
 
 
-def get_point(*args):
+def get_point(curves: tuple[tuple[float, float], ...]) -> None:
     """
     Plot curves and return selected point(s) coordinates
+
+    Args:
+        curves: A tuple of curves to plot
     """
     win = make.dialog(
         wintitle=_("Select one point then press OK to accept"),
@@ -41,10 +46,10 @@ def get_point(*args):
     )
     default.activate()
     plot = win.manager.get_plot()
-    for cx, cy in args[:-1]:
+    for cx, cy in curves[:-1]:
         item = make.mcurve(cx, cy)
         plot.add_item(item)
-    item = make.mcurve(*args[-1], "r-+")
+    item = make.mcurve(*curves[-1], "r-+")
     plot.add_item(item)
     plot.set_active_item(item)
     plot.unselect_item(item)
@@ -58,7 +63,7 @@ def test_get_point():
         y = 0.25 * sin(sin(sin(x * 0.5)))
         x2 = linspace(-10, 10, 200)
         y2 = sin(sin(sin(x2)))
-        get_point((x, y), (x2, y2), (x, sin(2 * y)))
+        get_point(((x, y), (x2, y2), (x, sin(2 * y))))
 
 
 if __name__ == "__main__":

plotpy/tests/tools/test_get_points.py

@@ -19,17 +19,29 @@
 from plotpy.tools import SelectPointsTool
 
 
-def callback_function(tool: SelectPointsTool):
+def callback_function(tool: SelectPointsTool) -> None:
+    """Callback function to be called by the tool after selection
+
+    Args:
+        tool: The tool instance that called the callback
+    """
     points = tool.get_coordinates()
     print("Points : ", points)
 
 
-def get_points(*args):
+def get_points(curves: tuple[tuple[float, float], ...], max_select: int) -> None:
     """
     Plot curves and return selected point(s) coordinates
+
+    Args:
+        curves: A tuple of curves to plot
     """
     win = make.dialog(
-        wintitle=_("Select one point then press OK to accept"),
+        wintitle=_(
+            "Select up to %s points then press OK to accept "
+            "(hold Ctrl to select multiple points)"
+        )
+        % max_select,
         edit=True,
         type="curve",
         curve_antialiasing=True,
@@ -40,15 +52,15 @@ def get_points(*args):
         on_active_item=True,
         mode="reuse",
         end_callback=callback_function,
-        max_select=5,
+        max_select=max_select,
     )
     default.activate()
     plot = win.manager.get_plot()
-    for cx, cy in args[:-1]:
+    for cx, cy in curves[:-1]:
         item = make.mcurve(cx, cy)
         plot.add_item(item)
     # the last curve will be actibe and needs to have a different style for explictness
-    item = make.mcurve(*args[-1], "r-+")
+    item = make.mcurve(*curves[-1], "r-+")
     plot.add_item(item)
     plot.set_active_item(item)
     plot.unselect_item(item)
@@ -62,7 +74,7 @@ def test_get_point():
         y = 0.25 * sin(sin(sin(x * 0.5)))
         x2 = linspace(-10, 10, 200)
         y2 = sin(sin(sin(x2)))
-        get_points((x, y), (x2, y2), (x, sin(2 * y)))
+        get_points(((x, y), (x2, y2), (x, sin(2 * y))), max_select=5)
 
 
 if __name__ == "__main__":

plotpy/tools/curve.py

@@ -429,7 +429,7 @@ def _init_current_marker(
             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
 
-            label_cb = self._new_label_cb(filter, title)
+            label_cb = self.__new_label_cb(filter, title)
             self.current_location_marker = Marker(
                 label_cb=label_cb, constraint_cb=constraint_cb
             )
@@ -461,7 +461,7 @@ def start_multi_selection(
         """
         self._init_current_marker(filter, event, force_new_marker=True)
         assert self.current_location_marker
-        self.current_location_marker.label_cb = self._new_label_cb(
+        self.current_location_marker.label_cb = self.__new_label_cb(
             filter, index=len(self.markers) + 1
         )
 
@@ -574,9 +574,9 @@ def update_labels(self, filter: StatefulEventFilter) -> None:
             filter: StatefulEventFilter instance
         """
         for i, marker in enumerate(self.markers.values()):
-            marker.label_cb = self._new_label_cb(filter, index=i + 1)
+            marker.label_cb = self.__new_label_cb(filter, index=i + 1)
 
-    def _new_label_cb(
+    def __new_label_cb(
         self, filter: StatefulEventFilter, title: str = "", index: int = 1
     ) -> Callable[[float, float], str]:
         """Create new label callback