Increase logging for plot options

Author: eilskra

src/ert/gui/plotting/utils/logging_utils.py

@@ -0,0 +1,13 @@
+import logging
+
+from PyQt6.QtCore import pyqtBoundSignal
+
+
+def log_plot_option_usage_once(
+    signal: pyqtBoundSignal, logger: logging.Logger, option_name: str
+) -> None:
+    def log_usage(*_args: object) -> None:
+        logger.info("Plot sidebar option used: '%s'", option_name)
+        signal.disconnect(log_usage)
+
+    signal.connect(log_usage)

src/ert/gui/plotting/widgets/plot_controls/custom_palette_dialog.py

@@ -1,3 +1,4 @@
+import logging
 from collections.abc import Sequence
 
 from PyQt6.QtWidgets import (
@@ -10,8 +11,11 @@
 )
 
 from ert.gui.plotting.customization_dialog.color_chooser import ColorBox
+from ert.gui.plotting.utils.logging_utils import log_plot_option_usage_once
 from ert.gui.plotting.utils.plot_color_palettes import MINIMUM_COLOR_CYCLE_LENGTH
 
+logger = logging.getLogger(__name__)
+
 
 class CustomPaletteDialog(QDialog):
     def __init__(
@@ -45,6 +49,7 @@ def __init__(
         buttons.accepted.connect(self.accept)
         buttons.rejected.connect(self.reject)
         layout.addWidget(buttons)
+        log_plot_option_usage_once(self.accepted, logger, "Custom palette colors")
 
     def get_color_cycle(self) -> list[tuple[str, float]]:
         return [(box.color.name(), box.color.alphaF()) for box in self._color_boxes]

src/ert/gui/plotting/widgets/plot_controls/everest_controls_plot_options.py

@@ -1,3 +1,4 @@
+import logging
 from collections.abc import Callable
 
 from PyQt6.QtWidgets import (
@@ -6,8 +7,11 @@
     QRadioButton,
 )
 
+from ert.gui.plotting.utils.logging_utils import log_plot_option_usage_once
 from ert.gui.plotting.utils.qt_creator import create_group_box, create_group_layout
 
+logger = logging.getLogger(__name__)
+
 
 class EverestControlsPlotOptions:
     def __init__(self, connection_point: Callable[..., object]) -> None:
@@ -21,7 +25,11 @@ def __init__(self, connection_point: Callable[..., object]) -> None:
         self._display_over_button_group.addButton(self._display_over_batches_radio)
         self._display_over_button_group.addButton(self._display_over_controls_radio)
         self._display_over_button_group.buttonClicked.connect(connection_point)
-
+        log_plot_option_usage_once(
+            self._display_over_button_group.buttonClicked,
+            logger,
+            "X-axis display option",
+        )
         self._display_over_group = create_group_box(
             "X-axis:",
             create_group_layout(

src/ert/gui/plotting/widgets/plot_controls/general_options.py

@@ -9,6 +9,7 @@
     QWidget,
 )
 
+from ert.gui.plotting.utils.logging_utils import log_plot_option_usage_once
 from ert.gui.plotting.utils.qt_creator import create_group_box, create_group_layout
 
 from .observation_color import ObservationColorEdit
@@ -121,14 +122,6 @@ def get_observations_color(self) -> tuple[str, float]:
         return self._observations_color_edit.get_observations_color()
 
 
-def log_option_usage(checkbox: QCheckBox, option_name: str) -> None:
-    def log_usage(_checked: bool) -> None:
-        logger.info("Plot sidebar option used: '%s'", option_name)
-        checkbox.clicked.disconnect(log_usage)
-
-    checkbox.clicked.connect(log_usage)
-
-
 def create_checkbox_with_tooltip(
     name: str,
     tooltip: str,
@@ -141,5 +134,5 @@ def create_checkbox_with_tooltip(
     checkbox.setToolTip(tooltip)
     checkbox.setChecked(initial_checked)
     checkbox.stateChanged.connect(connection_point)
-    log_option_usage(checkbox, name)
+    log_plot_option_usage_once(checkbox.clicked, logger, name)
     return checkbox

src/ert/gui/plotting/widgets/plot_controls/misfits_options.py

@@ -1,12 +1,16 @@
+import logging
 from collections.abc import Callable
 
 from PyQt6.QtWidgets import (
     QCheckBox,
     QGroupBox,
 )
 
+from ert.gui.plotting.utils.logging_utils import log_plot_option_usage_once
 from ert.gui.plotting.utils.qt_creator import create_group_box, create_group_layout
 
+logger = logging.getLogger(__name__)
+
 
 class MisfitsOptions:
     def __init__(self, connection_point: Callable[..., object]) -> None:
@@ -35,6 +39,16 @@ def __init__(self, connection_point: Callable[..., object]) -> None:
                 ]
             ),
         )
+        log_plot_option_usage_once(self._toggle_mean.stateChanged, logger, "Show mean")
+        log_plot_option_usage_once(
+            self._toggle_outliers.stateChanged, logger, "Show outliers"
+        )
+        log_plot_option_usage_once(
+            self._toggle_scatter_plot.stateChanged, logger, "Show scatter"
+        )
+        log_plot_option_usage_once(
+            self._toggle_box.stateChanged, logger, "Show box plot"
+        )
 
     @property
     def mean_checkbox_state(self) -> bool:

src/ert/gui/plotting/widgets/plot_controls/observation_color.py

@@ -1,10 +1,14 @@
+import logging
 from collections.abc import Callable
 
 from PyQt6.QtWidgets import QCheckBox, QHBoxLayout, QLabel, QWidget
 
 from ert.gui.plotting.customization_dialog.color_chooser import ColorBox
+from ert.gui.plotting.utils.logging_utils import log_plot_option_usage_once
 from ert.gui.plotting.utils.plot_config import PlotConfig
 
+logger = logging.getLogger(__name__)
+
 
 class ObservationColorEdit(QWidget):
     def __init__(
@@ -19,6 +23,9 @@ def __init__(
         self._observations_color_box.colorChanged.connect(
             lambda _color: connection_point()
         )
+        log_plot_option_usage_once(
+            self._observations_color_box.colorChanged, logger, "Observation color"
+        )
 
         layout = QHBoxLayout(self)
         layout.setContentsMargins(20, 0, 0, 0)

src/ert/gui/plotting/widgets/plot_controls/plot_color_palette_selector.py

@@ -1,12 +1,16 @@
+import logging
 from collections.abc import Callable
 
 from PyQt6.QtCore import Qt
 from PyQt6.QtWidgets import QComboBox, QPushButton
 
 from ert.gui.icon_utils import load_icon
+from ert.gui.plotting.utils.logging_utils import log_plot_option_usage_once
 from ert.gui.plotting.utils.plot_color_palettes import PALETTES_WITH_DESCRIPTIONS
 from ert.gui.plotting.widgets.plot_controls import CustomPaletteDialog
 
+logger = logging.getLogger(__name__)
+
 
 class PlotColorPaletteSelector(QComboBox):
     CUSTOM_PALETTE_NAME = "Custom"
@@ -31,6 +35,7 @@ def __init__(self, connection_point: Callable[..., object]) -> None:
                 Qt.ItemDataRole.ToolTipRole,
             )
         self.activated.connect(connection_point)
+        log_plot_option_usage_once(self.activated, logger, "Color palette")
         self.custom_palette_button = QPushButton(
             load_icon("add_circle_outlined.svg"), "Create custom palette"
         )
@@ -39,6 +44,9 @@ def __init__(self, connection_point: Callable[..., object]) -> None:
             "The selected palette will be applied to all plots."
         )
         self.custom_palette_button.clicked.connect(self._open_custom_palette_dialog)
+        log_plot_option_usage_once(
+            self.custom_palette_button.clicked, logger, "Create custom palette"
+        )
 
     def _open_custom_palette_dialog(self) -> None:
         if self.CUSTOM_PALETTE_NAME in PALETTES_WITH_DESCRIPTIONS:

tests/ert/unit_tests/gui/plotting/widgets/test_custom_palette_dialog.py

@@ -1,3 +1,5 @@
+import logging
+
 from ert.gui.plotting.utils.plot_color_palettes import MINIMUM_COLOR_CYCLE_LENGTH
 from ert.gui.plotting.widgets.plot_controls.custom_palette_dialog import (
     CustomPaletteDialog,
@@ -19,3 +21,17 @@ def test_that_dialog_exposes_default_amount_of_color_boxes(qtbot):
     qtbot.addWidget(dialog)
 
     assert len(dialog.get_color_cycle()) == MINIMUM_COLOR_CYCLE_LENGTH
+
+
+def test_that_accepting_the_dialog_logs_sidebar_usage_once(qtbot, caplog):
+    dialog = CustomPaletteDialog([])
+    qtbot.addWidget(dialog)
+
+    expected_message = "Plot sidebar option used: 'Custom palette colors'"
+
+    with caplog.at_level(logging.INFO):
+        dialog.accept()
+        assert [r.getMessage() for r in caplog.records].count(expected_message) == 1
+
+        dialog.accept()
+        assert [r.getMessage() for r in caplog.records].count(expected_message) == 1

tests/ert/unit_tests/gui/plotting/widgets/test_everest_controls_plot_options.py

@@ -1,3 +1,4 @@
+import logging
 from unittest.mock import Mock
 
 from PyQt6.QtCore import Qt
@@ -31,3 +32,23 @@ def test_that_toggling_everest_controls_plot_options_invokes_the_connection_poin
     qtbot.mouseClick(controls_radio, Qt.MouseButton.LeftButton)
 
     connection_point.assert_called()
+
+
+def test_that_selecting_x_axis_display_option_logs_sidebar_usage_once(qtbot, caplog):
+    options = EverestControlsPlotOptions(Mock())
+    widget = options.get_widget()
+    qtbot.addWidget(widget)
+    widget.show()
+
+    controls_radio = widget.findChild(QRadioButton, "display_over_controls_radio")
+    batches_radio = widget.findChild(QRadioButton, "display_over_batches_radio")
+    assert controls_radio is not None
+    assert batches_radio is not None
+    expected_message = "Plot sidebar option used: 'X-axis display option'"
+
+    with caplog.at_level(logging.INFO):
+        qtbot.mouseClick(controls_radio, Qt.MouseButton.LeftButton)
+        assert [r.getMessage() for r in caplog.records].count(expected_message) == 1
+
+        qtbot.mouseClick(batches_radio, Qt.MouseButton.LeftButton)
+        assert [r.getMessage() for r in caplog.records].count(expected_message) == 1

tests/ert/unit_tests/gui/plotting/widgets/test_misfits_options.py

@@ -1,5 +1,8 @@
+import logging
 from unittest.mock import Mock
 
+import pytest
+
 from ert.gui.plotting.widgets.plot_controls.misfits_options import MisfitsOptions
 
 
@@ -36,3 +39,29 @@ def test_that_toggling_a_misfits_checkbox_invokes_the_connection_point(qtbot):
     options.scatter_checkbox_state = not options.scatter_checkbox_state
 
     connection_point.assert_called()
+
+
+@pytest.mark.parametrize(
+    ("checkbox_attribute", "option_name"),
+    [
+        ("_toggle_mean", "Show mean"),
+        ("_toggle_outliers", "Show outliers"),
+        ("_toggle_scatter_plot", "Show scatter"),
+        ("_toggle_box", "Show box plot"),
+    ],
+)
+def test_that_toggling_a_misfits_option_logs_sidebar_usage_once(
+    qtbot, caplog, checkbox_attribute, option_name
+):
+    options = MisfitsOptions(Mock())
+    qtbot.addWidget(options.get_widget())
+
+    checkbox = getattr(options, checkbox_attribute)
+    expected_message = f"Plot sidebar option used: '{option_name}'"
+
+    with caplog.at_level(logging.INFO):
+        checkbox.toggle()
+        assert [r.getMessage() for r in caplog.records].count(expected_message) == 1
+
+        checkbox.toggle()
+        assert [r.getMessage() for r in caplog.records].count(expected_message) == 1