Merge branch 'master' into develop

Author: PierreRaybaut

CHANGELOG.md

@@ -32,6 +32,43 @@ In this release, test coverage is 79%.
   * This is now fixed by introducing new constants for axis IDs in the
     `plotpy.constants` module, and using them everywhere in the code, thus avoiding
     to import the `plotpy.plot` module just to get the axis IDs
+* Fix empty label in X/Y cross section plots:
+  * This is a regression introduced in V2.1.0
+  * When showing the X/Y cross section plots (using the plot context menu), an empty
+    label was displayed at the center of each of those plots
+  * The label now shows "Enable a marker" as previously
+* Fix historic unexpected behavior of interactive tools:
+  * When triggering an interactive tool (e.g. by clicking on the corresponding toolbar
+    button), the tool `activate` method was called twice, which was not expected, but
+    was not causing any issue given the current implementation
+  * However, when defining custom interactive tools, this behavior could lead to
+    unexpected results (i.e. really executing activation actions twice)
+  * This is now fixed: the `activate` method is called only once when triggering an
+    interactive tool
+
+💥 New features / Enhancements:
+
+* Alternative dictionary argument for plot options:
+  * This new feature was introduced in the context of the cyclic import bug fix,
+    to avoid importing the `plotpy.plot` module just to get the `PlotOptions` or
+    `BasePlotOptions` classes
+  * All classes (and a few functions) that used to take an `options` argument as
+    a `BasePlotOptions` or `PlotOptions` instance now also accept a dictionary
+    argument with the same keys as the `BasePlotOptions` or `PlotOptions` class
+    attributes, and the same values as the corresponding attributes
+  * This concerns the following classes and functions:
+    * `plotpy.plot.BasePlot`
+    * `plotpy.plot.PlotWidget`
+    * `plotpy.plot.PlotDialog`
+    * `plotpy.plot.PlotWindow`
+    * `plotpy.plot.SubPlotWidget`
+    * `plotpy.plot.SyncPlotWindow`
+    * `plotpy.tools.RotateCropTool`
+    * `plotpy.widgets.fit.FitDialog`
+    * `plotpy.widgets.fliprotate.FlipRotateDialog`
+    * `plotpy.widgets.rotatecrop.RotateCropDialog`
+    * `plotpy.widgets.selectdialog.SelectDialog`
+    * `plotpy.widgets.selectdialog.select_with_shape_tool`
 
 ## Version 2.4.2 ##
 

plotpy/panels/csection/csplot.py

@@ -17,6 +17,7 @@
     XCrossSectionItem,
     YCrossSectionItem,
 )
+from plotpy.plot.base import BasePlot
 from plotpy.styles.curve import CurveParam
 
 LUT_AXIS_TITLE = _("LUT scale") + (" (0-%d)" % LUT_MAX)
@@ -27,7 +28,6 @@
 
     from plotpy.items import BaseImageItem
     from plotpy.panels.csection.csitem import CrossSectionItem
-    from plotpy.plot.base import BasePlot
 
 
 class BaseCrossSectionPlot(BasePlot):
@@ -364,6 +364,7 @@ def lut_changed(self, plot: BasePlot) -> None:
 
 
 class HorizontalCrossSectionPlot(BaseCrossSectionPlot):
+    LABEL_TEXT = _("Enable a marker")
     CS_AXIS = X_BOTTOM
     Z_AXIS = Y_LEFT
 
@@ -391,6 +392,7 @@ def axis_dir_changed(self, plot: BasePlot, axis_id: str) -> None:
 
 
 class VerticalCrossSectionPlot(BaseCrossSectionPlot):
+    LABEL_TEXT = _("Enable a marker")
     CS_AXIS = Y_LEFT
     Z_AXIS = X_BOTTOM
     Z_MAX_MAJOR = 3
@@ -419,8 +421,6 @@ def axis_dir_changed(self, plot: BasePlot, axis_id: str) -> None:
 
 
 class XYCrossSectionMixin:
-    LABEL_TEXT = _("Enable a marker")
-
     def connect_plot(self, plot: BasePlot) -> None:
         """Connect plot to cross section plot
 

plotpy/plot/base.py

@@ -298,9 +298,11 @@ class BasePlot(qwt.QwtPlot):
     def __init__(
         self,
         parent: QW.QWidget | None = None,
-        options: BasePlotOptions | None = None,
+        options: BasePlotOptions | dict[str, Any] | None = None,
     ) -> None:
         super().__init__(parent)
+        if isinstance(options, dict):
+            options = BasePlotOptions(**options)
         self.options = options = options if options is not None else BasePlotOptions()
 
         self.__autoscale_excluded_items: list[itf.IBasePlotItem] = []

plotpy/plot/plotwidget.py

@@ -5,7 +5,7 @@
 import abc
 import warnings
 from dataclasses import dataclass
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from guidata.configtools import get_icon
 from guidata.qthelpers import win32_fix_title_bar_background
@@ -115,10 +115,12 @@ class BasePlotWidget(QW.QSplitter):
     def __init__(
         self,
         parent: QWidget = None,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
     ) -> None:
         super().__init__(parent)
         self.manager: PlotManager | None = None
+        if isinstance(options, dict):
+            options = PlotOptions(**options)
         self.options = options = options if options is not None else PlotOptions()
         self.setSizePolicy(QW.QSizePolicy.Expanding, QW.QSizePolicy.Expanding)
         self.plot = self.create_plot()
@@ -304,7 +306,7 @@ def __init__(
         self,
         parent: QWidget | None = None,
         toolbar: bool = False,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         panels: tuple[PanelWidget] | None = None,
         auto_tools: bool = True,
     ) -> None:
@@ -456,7 +458,7 @@ def get_manager(self) -> PlotManager:
     def setup_widget(
         self,
         toolbar: bool = False,
-        options: dict | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         panels: list[PanelWidget] | None = None,
         auto_tools: bool = False,
     ) -> None:
@@ -539,7 +541,7 @@ def __init__(
         self,
         parent: QWidget | None = None,
         toolbar: bool = False,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         panels: list[PanelWidget] | None = None,
         auto_tools: bool = True,
         title: str = "PlotPy",
@@ -590,7 +592,7 @@ def get_manager(self) -> PlotManager:
     def setup_widget(
         self,
         toolbar: bool = False,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         panels: list[PanelWidget] | None = None,
         auto_tools: bool = False,
     ) -> None:
@@ -696,7 +698,7 @@ def __init__(
         self,
         parent: QWidget | None = None,
         toolbar: bool = False,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         panels: list[PanelWidget] | None = None,
         auto_tools: bool = True,
         title: str = "PlotPy",
@@ -742,7 +744,7 @@ def get_manager(self) -> PlotManager:
     def setup_widget(
         self,
         toolbar: bool = False,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         panels: list[PanelWidget] | None = None,
         auto_tools: bool = False,
     ) -> None:
@@ -843,7 +845,7 @@ def __init__(
         self,
         manager: PlotManager,
         parent: QWidget | None = None,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
     ) -> None:
         self.plotlayout: QW.QGridLayout | None = None
         super().__init__(parent, options=options)
@@ -914,7 +916,7 @@ def __init__(
         self,
         parent: QWidget | None = None,
         toolbar: bool = True,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         auto_tools: bool = True,
         title: str = "PlotPy",
         icon: str = "plotpy.svg",

plotpy/tools/base.py

@@ -236,14 +236,16 @@ def register_plot(self, baseplot: BasePlot) -> None:
             filter.set_cursor(curs, start_state)
 
     def interactive_triggered(self, action: QW.QAction) -> None:
-        """Slot called when the tool action is triggered
+        """Slot called when the interactive tool action group is triggered.
+        The purpose is to deactivate all other tools in the group.
+
+        Note that the tool itself has already been activated because the action
+        triggered the `activate` method.
 
         Args:
             action: tool action
         """
-        if action is self.action:
-            self.activate()
-        else:
+        if action is not self.action:
             self.deactivate()
 
     def activate(self) -> None:

plotpy/tools/image.py

@@ -1321,7 +1321,7 @@ def __init__(
         self,
         manager: PlotManager,
         toolbar_id=DefaultToolbarID,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
     ) -> None:
         super().__init__(
             manager,

plotpy/widgets/basetransform.py

@@ -14,7 +14,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Union
+from typing import TYPE_CHECKING, Any, Union
 
 from guidata.configtools import get_icon
 from guidata.qthelpers import create_toolbutton
@@ -166,9 +166,11 @@ def __init__(
         self,
         parent: QW.QWidget,
         toolbar: bool = False,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
     ) -> None:
         super().__init__(parent)
+        if isinstance(options, dict):
+            options = PlotOptions(**options)
         options = options if options is not None else PlotOptions()
         options.type = "image"
         self.plot_widget = PlotWidget(self, options=options, toolbar=toolbar)

plotpy/widgets/fit.py

@@ -47,7 +47,7 @@
 from __future__ import annotations
 
 from collections.abc import Callable
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 import guidata
 import numpy as np
@@ -857,7 +857,7 @@ def __init__(
         edit: bool = True,
         toolbar: bool = False,
         auto_tools: bool = True,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         parent: QWidget | None = None,
         panels: list[PanelWidget] | None = None,
         param_cols: int = 1,

plotpy/widgets/fliprotate.py

@@ -24,7 +24,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 import numpy as np
 from guidata.configtools import get_icon
@@ -99,7 +99,7 @@ def __init__(
         self,
         parent: QWidget,
         title: str | None = None,
-        options: dict | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         resize_to: tuple[int, int] | None = None,
         edit: bool = True,
         toolbar: bool = False,
@@ -169,7 +169,7 @@ def __init__(
         self,
         parent: QWidget,
         toolbar: bool = False,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
     ):
         self.angle_combo = None
         self.hflip_btn = None

plotpy/widgets/rotatecrop.py

@@ -24,7 +24,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from guidata.qthelpers import win32_fix_title_bar_background
 from qtpy import QtCore as QC
@@ -138,7 +138,7 @@ def __init__(
         self,
         parent: QWidget,
         title: str | None = None,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         resize_to: tuple[int, int] | None = None,
         edit: bool = True,
         toolbar: bool = False,
@@ -204,7 +204,7 @@ def __init__(
         self,
         parent: QWidget,
         toolbar: bool = False,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
     ) -> None:
         super().__init__(parent, toolbar=toolbar, options=options)
         self.transform = RotateCropTransform(self, self.plot_widget.manager)

plotpy/widgets/selectdialog.py

@@ -39,7 +39,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from guidata.configtools import get_icon
 from guidata.qthelpers import exec_dialog
@@ -75,7 +75,7 @@ def __init__(
         self,
         parent: QWidget | None = None,
         toolbar: bool = False,
-        options: PlotOptions | None = None,
+        options: PlotOptions | dict[str, Any] | None = None,
         panels: list[PanelWidget] | None = None,
         auto_tools: bool = True,
         title: str = "PlotPy",
@@ -142,7 +142,7 @@ def select_with_shape_tool(
     other_items: list[QwtPlotItem] = [],
     tooldialogclass: SelectDialog = SelectDialog,
     toolbar: bool = False,
-    options: PlotOptions | None = None,
+    options: PlotOptions | dict[str, Any] | None = None,
     icon=None,
     **kwargs,
 ) -> AbstractShape: