API cleanup for DataSet style parameters: generalize update_item instead of update_{obj}

Author: PierreRaybaut

CHANGELOG.md

@@ -24,6 +24,17 @@ In this release, test coverage is 79%.
   * The `stats_func` parameter is a function that takes the image item and selected
     rectangle coordinates, and returns a string with the statistics to display
 
+🧹 API cleanup:
+
+* Deprecated `AnnotationParam.update_annotation` method: use `update_item` instead
+* Deprecated `AxesShapeParam.update_axes` method: use `update_item` instead
+* Deprecated `AxesParam.update_axes` method: use `update_item` instead
+* Deprecated `ImageAxesParam.update_axes` method: use `update_item` instead
+* Deprecated `LabelParam.update_label` method: use `update_item` instead
+* Deprecated `MarkerParam.update_marker` method: use `update_item` instead
+* Deprecated `RangeShapeParam.update_range` method: use `update_item` instead
+* Deprecated `ShapeParam.update_shape` method: use `update_item` instead
+
 ## Version 2.3.5 ##
 
 This release is mainly intended to fix the Windows binary distribution, which was not
@@ -107,7 +118,6 @@ in version 2.3.1. The latter is a fugitive release that was not announced.
 * Fixed issue with oblique averaged cross section computation (`AttributeError` when
   clicking on the empty cross section plot)
 
-
 ## Version 2.3.0 ##
 
 In this release, test coverage is 75%.

plotpy/items/annotation.py

@@ -75,7 +75,7 @@ def __init__(self, annotationparam: AnnotationParam | None = None) -> None:
             )
         else:
             self.annotationparam = annotationparam
-            self.annotationparam.update_annotation(self)
+            self.annotationparam.update_item(self)
         self.setIcon(get_icon("annotation.png"))
 
     def types(self) -> tuple[type[IItemType], ...]:
@@ -98,8 +98,8 @@ def __setstate__(self, state: tuple) -> None:
         shape, label, param = state
         self.shape = shape
         self.label = label
-        self.annotationparam = param
-        self.annotationparam.update_annotation(self)
+        self.annotationparam: AnnotationParam = param
+        self.annotationparam.update_item(self)
 
     def serialize(
         self,
@@ -125,7 +125,7 @@ def deserialize(
         """
         self.annotationparam = AnnotationParam(_("Annotation"), icon="annotation.png")
         reader.read("annotationparam", instance=self.annotationparam)
-        self.annotationparam.update_annotation(self)
+        self.annotationparam.update_item(self)
         self.shape.deserialize(reader)
         self.label.deserialize(reader)
 
@@ -434,7 +434,7 @@ def set_item_parameters(self, itemparams: ItemParameters) -> None:
         update_dataset(
             self.annotationparam, itemparams.get("AnnotationParam"), visible_only=True
         )
-        self.annotationparam.update_annotation(self)
+        self.annotationparam.update_item(self)
         self.plot().SIG_ANNOTATION_CHANGED.emit(self)
 
     # Autoscalable types API
@@ -471,6 +471,7 @@ class AnnotatedPoint(AnnotatedShape):
 
     def __init__(self, x=0, y=0, annotationparam=None):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: PointShape
         self.set_pos(x, y)
         self.setIcon(get_icon("point_shape.png"))
 
@@ -526,6 +527,7 @@ class AnnotatedSegment(AnnotatedShape):
 
     def __init__(self, x1=0, y1=0, x2=0, y2=0, annotationparam=None):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: SegmentShape
         self.set_rect(x1, y1, x2, y2)
         self.setIcon(get_icon("segment.png"))
 
@@ -585,6 +587,7 @@ class AnnotatedRectangle(AnnotatedShape):
 
     def __init__(self, x1=0, y1=0, x2=0, y2=0, annotationparam=None):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: RectangleShape
         self.set_rect(x1, y1, x2, y2)
         self.setIcon(get_icon("rectangle.png"))
 
@@ -645,6 +648,7 @@ def __init__(
         self, x0=0, y0=0, x1=0, y1=0, x2=0, y2=0, x3=0, y3=0, annotationparam=None
     ):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: ObliqueRectangleShape
         self.set_rect(x0, y0, x1, y1, x2, y2, x3, y3)
         self.setIcon(get_icon("oblique_rectangle.png"))
 
@@ -740,6 +744,7 @@ class AnnotatedEllipse(AnnotatedShape):
 
     def __init__(self, x1=0, y1=0, x2=0, y2=0, annotationparam=None):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: EllipseShape
         self.set_xdiameter(x1, y1, x2, y2)
         self.setIcon(get_icon("ellipse_shape.png"))
         self.switch_to_ellipse()

plotpy/items/grid.py

@@ -248,7 +248,7 @@ def set_item_parameters(self, itemparams: ItemParameters) -> None:
         Args:
             itemparams: Item parameters
         """
-        self.gridparam = itemparams.get("GridParam")
+        self.gridparam: GridParam = itemparams.get("GridParam")
         self.gridparam.update_grid(self)
 
 

plotpy/items/label.py

@@ -83,7 +83,7 @@ def __init__(self, labelparam: LabelParam = None) -> None:
             self.labelparam = LabelParam(_("Label"), icon="label.png")
         else:
             self.labelparam = labelparam
-            self.labelparam.update_label(self)
+            self.labelparam.update_item(self)
         self._can_select = True
         self._can_resize = False
         self._can_move = True
@@ -97,7 +97,7 @@ def set_style(self, section: str, option: str) -> None:
             option: Option
         """
         self.labelparam.read_config(CONF, section, option)
-        self.labelparam.update_label(self)
+        self.labelparam.update_item(self)
 
     def __reduce__(self) -> tuple[type, tuple]:
         """Return a tuple containing the constructor and its arguments"""
@@ -126,7 +126,7 @@ def deserialize(
         """
         self.labelparam = LabelParam(_("Label"), icon="label.png")
         reader.read("labelparam", instance=self.labelparam)
-        self.labelparam.update_label(self)
+        self.labelparam.update_item(self)
         if isinstance(self.G, np.ndarray):
             self.G = tuple(self.G)
 
@@ -333,7 +333,7 @@ def unselect(self) -> None:
         highlight the fact that it's not selected anymore
         """
         self.selected = False
-        self.labelparam.update_label(self)
+        self.labelparam.update_item(self)
         self.invalidate_plot()
 
     def hit_test(self, pos: QPointF) -> tuple[float, float, bool, None]:
@@ -407,7 +407,7 @@ def set_item_parameters(self, itemparams: ItemParameters) -> None:
             itemparams: Item parameters
         """
         update_dataset(self.labelparam, itemparams.get("LabelParam"), visible_only=True)
-        self.labelparam.update_label(self)
+        self.labelparam.update_item(self)
         if self.selected:
             self.select()
 
@@ -837,7 +837,7 @@ def set_item_parameters(self, itemparams: ItemParameters) -> None:
         update_dataset(
             self.labelparam, itemparams.get("LegendParam"), visible_only=True
         )
-        self.labelparam.update_label(self)
+        self.labelparam.update_item(self)
         if self.selected:
             self.select()
 

plotpy/items/shape/axis.py

@@ -73,10 +73,10 @@ def __setstate__(self, state: tuple) -> None:
         shapeparam, axesparam, points, z = state
         self.points = points
         self.setZ(z)
-        self.shapeparam = shapeparam
-        self.shapeparam.update_shape(self)
-        self.axesparam = axesparam
-        self.axesparam.update_axes(self)
+        self.shapeparam: ShapeParam = shapeparam
+        self.shapeparam.update_item(self)
+        self.axesparam: AxesShapeParam = axesparam
+        self.axesparam.update_item(self)
 
     def serialize(
         self,
@@ -103,7 +103,7 @@ def deserialize(
         super().deserialize(reader)
         self.axesparam = AxesShapeParam(_("Axes"), icon="gtaxes.png")
         reader.read("axesparam", instance=self.axesparam)
-        self.axesparam.update_axes(self)
+        self.axesparam.update_item(self)
 
     def get_transform_matrix(self, dx: float = 1.0, dy: float = 1.0) -> np.ndarray:
         """Return the transformation matrix
@@ -143,7 +143,7 @@ def set_style(self, section: str, option: str) -> None:
         """
         PolygonShape.set_style(self, section, option + "/border")
         self.axesparam.read_config(CONF, section, option)
-        self.axesparam.update_axes(self)
+        self.axesparam.update_item(self)
 
     def move_point_to(
         self, handle: int, pos: tuple[float, float], ctrl: bool = False
@@ -304,7 +304,7 @@ def set_item_parameters(self, itemparams: ItemParameters) -> None:
         update_dataset(
             self.axesparam, itemparams.get("AxesShapeParam"), visible_only=True
         )
-        self.axesparam.update_axes(self)
+        self.axesparam.update_item(self)
 
 
 assert_interfaces_valid(Axes)

plotpy/items/shape/ellipse.py

@@ -339,7 +339,7 @@ def __setstate__(self, state: tuple) -> None:
         """Set the state of the object from a tuple"""
         self.shapeparam, self.points, z = state
         self.setZ(z)
-        self.shapeparam.update_shape(self)
+        self.shapeparam.update_item(self)
 
 
 assert_interfaces_valid(EllipseShape)

plotpy/items/shape/marker.py

@@ -70,7 +70,7 @@ def __init__(
             self.markerparam.read_config(CONF, "plot", "marker/cursor")
         else:
             self.markerparam = markerparam
-        self.markerparam.update_marker(self)
+        self.markerparam.update_item(self)
         self.setIcon(get_icon("marker.png"))
 
     def __reduce__(self) -> tuple[type, tuple, tuple]:
@@ -85,7 +85,7 @@ def __setstate__(self, state: tuple) -> None:
         self.setXValue(xvalue)
         self.setYValue(yvalue)
         self.setZ(z)
-        self.markerparam.update_marker(self)
+        self.markerparam.update_item(self)
 
     def serialize(
         self,
@@ -113,7 +113,7 @@ def deserialize(
         """
         self.markerparam = MarkerParam(_("Marker"), icon="marker.png")
         reader.read("markerparam", instance=self.markerparam)
-        self.markerparam.update_marker(self)
+        self.markerparam.update_item(self)
         self.setXValue(reader.read("x"))
         self.setYValue(reader.read("y"))
         self.setZ(reader.read("z"))
@@ -260,7 +260,7 @@ def select(self) -> None:
             # Already selected
             return
         self.selected = True
-        self.markerparam.update_marker(self)
+        self.markerparam.update_item(self)
         self.invalidate_plot()
 
     def unselect(self) -> None:
@@ -269,7 +269,7 @@ def unselect(self) -> None:
         highlight the fact that it's not selected anymore
         """
         self.selected = False
-        self.markerparam.update_marker(self)
+        self.markerparam.update_item(self)
         self.invalidate_plot()
 
     def hit_test(self, pos: QPointF) -> tuple[float, float, bool, None]:
@@ -335,7 +335,7 @@ def set_item_parameters(self, itemparams):
         update_dataset(
             self.markerparam, itemparams.get("MarkerParam"), visible_only=True
         )
-        self.markerparam.update_marker(self)
+        self.markerparam.update_item(self)
         if self.selected:
             self.select()
 
@@ -377,7 +377,7 @@ def set_style(self, section: str, option: str) -> None:
             option: Option
         """
         self.markerparam.read_config(CONF, section, option)
-        self.markerparam.update_marker(self)
+        self.markerparam.update_item(self)
 
     def set_pos(self, x: float | None = None, y: float | None = None) -> None:
         """Set marker position
@@ -412,7 +412,7 @@ def set_markerstyle(self, style: str | int | None) -> None:
         """
         param = self.markerparam
         param.set_markerstyle(style)
-        param.update_marker(self)
+        param.update_item(self)
 
     def is_vertical(self) -> bool:
         """Is it a vertical cursor?

plotpy/items/shape/point.py

@@ -72,7 +72,7 @@ def __setstate__(self, state: tuple) -> None:
         """Set object state from pickled state"""
         self.shapeparam, self.points, z = state
         self.setZ(z)
-        self.shapeparam.update_shape(self)
+        self.shapeparam.update_item(self)
 
     def boundingRect(self) -> QC.QRectF:
         """Return the bounding rectangle of the shape

plotpy/items/shape/polygon.py

@@ -60,7 +60,7 @@ def __init__(
             self.shapeparam = ShapeParam(_("Shape"), icon="rectangle.png")
         else:
             self.shapeparam = shapeparam
-            self.shapeparam.update_shape(self)
+            self.shapeparam.update_item(self)
 
         self.pen = QG.QPen()
         self.brush = QG.QBrush()
@@ -92,7 +92,7 @@ def __setstate__(self, state: tuple) -> None:
         """Set state information for unpickling"""
         self.shapeparam, self.points, self.closed, z = state
         self.setZ(z)
-        self.shapeparam.update_shape(self)
+        self.shapeparam.update_item(self)
 
     def serialize(
         self,
@@ -121,7 +121,7 @@ def deserialize(
         self.closed = reader.read("closed")
         self.shapeparam = ShapeParam(_("Shape"), icon="rectangle.png")
         reader.read("shapeparam", instance=self.shapeparam)
-        self.shapeparam.update_shape(self)
+        self.shapeparam.update_item(self)
         self.points = reader.read(group_name="points", func=reader.read_array)
         self.setZ(reader.read("z"))
 
@@ -135,7 +135,7 @@ def set_style(self, section: str, option: str) -> None:
             option: Option
         """
         self.shapeparam.read_config(CONF, section, option)
-        self.shapeparam.update_shape(self)
+        self.shapeparam.update_item(self)
 
     def set_points(self, points: list[tuple[float, float]]) -> None:
         """Set polygon points
@@ -435,7 +435,7 @@ def set_item_parameters(self, itemparams: ItemParameters) -> None:
             itemparams: Item parameters
         """
         update_dataset(self.shapeparam, itemparams.get("ShapeParam"), visible_only=True)
-        self.shapeparam.update_shape(self)
+        self.shapeparam.update_item(self)
 
 
 assert_interfaces_valid(PolygonShape)

plotpy/items/shape/range.py

@@ -56,7 +56,7 @@ def __init__(
         self.symbol = None
         self.sel_symbol = None
         if self._min is not None and self._max is not None:
-            self.shapeparam.update_range(self)  # creates all the above QObjects
+            self.shapeparam.update_item(self)  # creates all the above QObjects
         self.setIcon(get_icon("xrange.png"))
 
     def __reduce__(self) -> tuple[type, tuple, tuple]:
@@ -97,7 +97,7 @@ def deserialize(
         self._max = reader.read("max")
         self.shapeparam = RangeShapeParam(_("Range"), icon="xrange.png")
         reader.read("shapeparam", instance=self.shapeparam)
-        self.shapeparam.update_range(self)
+        self.shapeparam.update_item(self)
 
     def get_handles_pos(self) -> tuple[float, float, float]:
         """Return the handles position
@@ -285,7 +285,7 @@ def set_item_parameters(self, itemparams: ItemParameters) -> None:
             itemparams: Item parameters
         """
         update_dataset(self.shapeparam, itemparams.get("ShapeParam"), visible_only=True)
-        self.shapeparam.update_range(self)
+        self.shapeparam.update_item(self)
         self.sel_brush = QG.QBrush(self.brush)
 
     def boundingRect(self) -> QC.QRectF: