Changelog: remove deprecated update methods and enhance API clarity

Author: PierreRaybaut

CHANGELOG.md

@@ -15,6 +15,17 @@
   * Added support for item title in parameters data set (`RangeShapeParam`)
   * This concerns the `XRangeSelection` and `YRangeSelection` items
 
+🧹 API cleanup: removed deprecated update methods (use `update_item` instead)
+
+* Removed `AnnotationParam.update_annotation` method
+* Removed `AxesShapeParam.update_axes` method
+* Removed `AxesParam.update_axes` method
+* Removed `ImageAxesParam.update_axes` method
+* Removed `LabelParam.update_label` method
+* Removed `MarkerParam.update_marker` method
+* Removed `RangeShapeParam.update_range` method
+* Removed `ShapeParam.update_shape` method
+
 🛠️ Bug fixes:
 
 * [Issue #46](https://github.com/PlotPyStack/PlotPy/issues/46) - Contrast adjustment with 'Eliminate outliers' failed for float images with high dynamic range

plotpy/styles/axes.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import warnings
 from typing import TYPE_CHECKING
 
 from guidata.dataset import (
@@ -139,21 +138,6 @@ def update_item(self, item: QwtPlotItem) -> None:
         item.setYAxis(self.yaxis_id)
         self.yaxis.update_axis(plot, self.yaxis_id)
 
-    # TODO: remove this method in a future release
-    def update_axes(self, obj: QwtPlotItem) -> None:
-        """Update object from parameters. Deprecated, use update_item instead.
-
-        Args:
-            item: The plot item to update.
-        """
-        warnings.warn(
-            "`AxesParam.update_axes` method is deprecated and will be removed "
-            "in a future release. Please use `update_item` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_item(obj)
-
 
 class ImageAxesParam(DataSet):
     """Parameters for the axes of an image plot."""
@@ -200,18 +184,3 @@ def update_item(self, item: BaseImageItem) -> None:
         plot.update_colormap_axis(item)
         for axis_id in (X_BOTTOM, Y_LEFT, Y_RIGHT):
             plot.SIG_AXIS_PARAMETERS_CHANGED.emit(axis_id)
-
-    # TODO: remove this method in a future release
-    def update_axes(self, obj: BaseImageItem) -> None:
-        """Update object from parameters. Deprecated, use update_item instead.
-
-        Args:
-            obj: The image item to update.
-        """
-        warnings.warn(
-            "`ImageAxesParam.update_axes` method is deprecated and will be removed "
-            "in a future release. Please use `update_item` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_item(obj)

plotpy/styles/label.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import warnings
 from typing import TYPE_CHECKING
 
 from guidata.dataset import (
@@ -201,21 +200,6 @@ def update_item(self, item: LabelItem) -> None:
         color.setAlphaF(self.bgalpha)
         item.bg_brush = QG.QBrush(color)
 
-    # TODO: remove this method in a future release
-    def update_label(self, obj: LabelItem) -> None:
-        """Update the label item with the parameters. This method is deprecated.
-
-        Args:
-            obj: The label item to update.
-        """
-        warnings.warn(
-            "`LabelParam.update_label` method is deprecated and will be removed "
-            "in a future release. Please use `update_item` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_item(obj)
-
 
 class LabelParam_MS(LabelParam):
     """Parameters for a label item in multiselection mode."""

plotpy/styles/shape.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import warnings
 from typing import TYPE_CHECKING
 
 import numpy as np
@@ -111,21 +110,6 @@ def update_item(self, item: Marker) -> None:
         item.setSpacing(self.spacing)
         item.update_label()
 
-    # TODO: remove this method in a future release
-    def update_marker(self, obj: Marker) -> None:
-        """Update object from parameters. Deprecated, use update_item instead.
-
-        Args:
-            obj: Marker object
-        """
-        warnings.warn(
-            "`MarkerParam.update_marker` method is deprecated and will be removed "
-            "in a future release. Please use `update_item` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_item(obj)
-
     def set_markerstyle(self, style: None | str | int) -> None:
         """Set marker line style
 
@@ -216,21 +200,6 @@ def update_item(self, item: PolygonShape) -> None:
         if plot is not None:
             plot.blockSignals(False)
 
-    # TODO: remove this method in a future release
-    def update_shape(self, obj: PolygonShape) -> None:
-        """Update object from parameters. Deprecated, use update_item instead.
-
-        Args:
-            obj: Shape object
-        """
-        warnings.warn(
-            "`ShapeParam.update_shape` method is deprecated and will be removed "
-            "in a future release. Please use `update_item` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_item(obj)
-
 
 class AxesShapeParam(DataSet):
     """Parameters for an axes item"""
@@ -283,21 +252,6 @@ def update_item(self, item: Axes) -> None:
         item.y_pen = self.yarrow_pen.build_pen()
         item.y_brush = self.yarrow_brush.build_brush()
 
-    # TODO: remove this method in a future release
-    def update_axes(self, obj: Axes) -> None:
-        """Update object from parameters. Deprecated, use update_item instead.
-
-        Args:
-            obj: Axes object
-        """
-        warnings.warn(
-            "`AxesShapeParam.update_axes` method is deprecated and will be removed "
-            "in a future release. Please use `update_item` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_item(obj)
-
 
 class AnnotationParam(DataSet):
     """Parameters for annotations"""
@@ -369,21 +323,6 @@ def update_item(self, item: AnnotatedShape) -> None:
         if plot is not None:
             plot.blockSignals(False)
 
-    # TODO: remove this method in a future release
-    def update_annotation(self, obj: AnnotatedShape) -> None:
-        """Update object from parameters. Deprecated, use update_item instead.
-
-        Args:
-            obj: AnnotatedShape object
-        """
-        warnings.warn(
-            "`AnnotationParam.update_annotation` method is deprecated and "
-            "will be removed in a future release. Please use `update_item` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_item(obj)
-
 
 class AnnotationParam_MS(AnnotationParam):
     """Parameters for annotations with multi-selection enabled"""
@@ -449,18 +388,3 @@ def update_item(self, item: XRangeSelection) -> None:
         item.brush = QG.QBrush(col)
         item.symbol = self.symbol.build_symbol()
         item.sel_symbol = self.sel_symbol.build_symbol()
-
-    # TODO: remove this method in a future release
-    def update_range(self, obj: XRangeSelection) -> None:
-        """Update object from parameters. Deprecated, use update_item instead.
-
-        Args:
-            obj: XRangeSelection object
-        """
-        warnings.warn(
-            "`RangeShapeParam.update_range` method is deprecated and "
-            "will be removed in a future release. Please use `update_item` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_item(obj)