BasePlot: rewrote plotpy v1 auto scale exclude mgt

Using weak references to items excluded from auto-scale
Do not change a class attribute! (very bad)
New method to remove excluded items (weird to be able to add them
without being able to remove them)

Author: PierreRaybaut

plotpy/plot/base.py

@@ -18,6 +18,7 @@
 import pickle
 import sys
 import warnings
+import weakref
 from dataclasses import dataclass
 from math import fabs
 from typing import TYPE_CHECKING
@@ -146,7 +147,6 @@ class BasePlot(qwt.QwtPlot):
     DEFAULT_ACTIVE_YAXIS = Y_LEFT
 
     AUTOSCALE_TYPES = (CurveItem, BaseImageItem, PolygonMapItem)
-    AUTOSCALE_EXCLUDES: list[itf.IBasePlotItem] = []
 
     #: Signal emitted by plot when an IBasePlotItem object was moved
     #:
@@ -277,6 +277,7 @@ def __init__(
         super().__init__(parent)
         self.options = options = options if options is not None else BasePlotOptions()
 
+        self.__autoscale_excluded_items: list[itf.IBasePlotItem] = []
         self.lock_aspect_ratio = options.lock_aspect_ratio
         self.__autoLockAspectRatio = False
         if self.lock_aspect_ratio is None:
@@ -1872,6 +1873,52 @@ def edit_axis_parameters(self, axis_id: int) -> None:
                 param.update_axis(self, axis_id)
                 self.replot()
 
+    def add_autoscale_types(self, item_types: tuple[type]) -> None:
+        """
+        Add item types to autoscale list
+
+        Args:
+            item_types (tuple[type]): the item types
+        """
+        self.AUTOSCALE_TYPES += item_types
+
+    def add_autoscale_excludes(self, items: list[itf.IBasePlotItem]) -> None:
+        """Add items to autoscale excludes list
+
+        Args:
+            items (list[IBasePlotItem]): the items
+        """
+        current_list = self.get_auto_scale_excludes()
+        for item in items:
+            if item not in current_list:
+                self.__autoscale_excluded_items.append(weakref.ref(item))
+
+    def remove_autoscale_excludes(self, items: list[itf.IBasePlotItem]) -> None:
+        """Remove items from autoscale excludes list
+
+        Args:
+            items (list[IBasePlotItem]): the items
+        """
+        current_list = self.get_auto_scale_excludes()
+        for item in items:
+            if item in current_list:
+                self.__autoscale_excluded_items.remove(weakref.ref(item))
+
+    def get_auto_scale_excludes(self) -> list[itf.IBasePlotItem]:
+        """Return autoscale excludes
+
+        Returns:
+            list[IBasePlotItem]: the items
+        """
+        # Update the list of excluded items, removing the items that have been
+        # deleted since the last call to this method
+        self.__autoscale_excluded_items = [
+            item_ref
+            for item_ref in self.__autoscale_excluded_items
+            if item_ref() is not None
+        ]
+        return [item_ref() for item_ref in self.__autoscale_excluded_items]
+
     def do_autoscale(self, replot: bool = True, axis_id: int | None = None) -> None:
         """Do autoscale on all axes
 
@@ -1891,7 +1938,7 @@ def do_autoscale(self, replot: bool = True, axis_id: int | None = None) -> None:
                     isinstance(item, self.AUTOSCALE_TYPES)
                     and not item.is_empty()
                     and item.isVisible()
-                    and item not in self.AUTOSCALE_EXCLUDES
+                    and item not in self.get_auto_scale_excludes()
                 ):
                     bounds = item.boundingRect()
                     if axis_id == item.xAxis():
@@ -2106,25 +2153,6 @@ def get_plot_limits(
         y0, y1 = self.get_axis_limits(yaxis)
         return x0, x1, y0, y1
 
-    def add_autoscale_types(self, item_types: tuple[type]) -> None:
-        """
-        Add item types to autoscale list
-
-        Args:
-            item_types (tuple[type]): the item types
-        """
-        self.AUTOSCALE_TYPES += item_types
-
-    def add_autoscale_excludes(self, items: list[itf.IBasePlotItem]) -> None:
-        """Add items to autoscale excludes list
-
-        Args:
-            items (list[IBasePlotItem]): the items
-        """
-        for item in items:
-            if item not in self.AUTOSCALE_EXCLUDES:
-                self.AUTOSCALE_EXCLUDES.append(item)
-
     # ---- Image scale/aspect ratio -related API -------------------------------
     def get_current_aspect_ratio(self) -> float:
         """Return current aspect ratio
@@ -2247,6 +2275,13 @@ def update_colormap_axis(self, item: itf.IColormapImageItemType) -> None:
         )
         self.updateAxes()
 
+    # # Keep this around to debug too many replots
+    # def replot(self):
+    #     import traceback
+
+    #     traceback.print_stack()
+    #     qwt.QwtPlot.replot(self)
+
     @classmethod
     def register_autoscale_type(cls, type_):
         """Add *type_* to the list of types used to check if an item is
@@ -2262,22 +2297,13 @@ def register_autoscale_type(cls, type_):
         cls.AUTOSCALE_TYPES += (type_,)
 
 
-# Register PolygonShape and annotated shape.
+# Register PolygonShape and annotated shape classes.
 # It's not possible to simply register AnnotatedShape class
 # because their is no warranty that SHAPE_CLASS implements all methods.
-for shape in (
-    PolygonShape,
-    annotations.AnnotatedRectangle,
-    annotations.AnnotatedCircle,
-    annotations.AnnotatedEllipse,
-    annotations.AnnotatedObliqueRectangle,
-    annotations.AnnotatedSegment,
-    annotations.AnnotatedPoint,
-):
-    BasePlot.register_autoscale_type(shape)
-
-# Keep this around to debug too many replots
-#    def replot(self):
-#        import traceback
-#        traceback.print_stack()
-#        QwtPlot.replot(self)
+BasePlot.register_autoscale_type(PolygonShape)
+BasePlot.register_autoscale_type(annotations.AnnotatedRectangle)
+BasePlot.register_autoscale_type(annotations.AnnotatedCircle)
+BasePlot.register_autoscale_type(annotations.AnnotatedEllipse)
+BasePlot.register_autoscale_type(annotations.AnnotatedObliqueRectangle)
+BasePlot.register_autoscale_type(annotations.AnnotatedSegment)
+BasePlot.register_autoscale_type(annotations.AnnotatedPoint)

plotpy/tests/gui/test_autoscale_shapes.py

@@ -76,6 +76,8 @@ def test_autoscale_shapes():
         # Add an annotated rectangle
         rect = make.annotated_rectangle(2.5, 1, 4, 1.2, "Annotated rectangle")
         plot.add_item(rect)
+        plot.add_autoscale_excludes([rect])
+        plot.remove_autoscale_excludes([rect])  # Just to test the method
 
         # Add an annotated rectangle excluded
         rect = make.annotated_rectangle(