Generalize log-once signal logging utility

log_plot_option_usage_once only supported the plot sidebar message
format, so it could not be reused elsewhere. Replace it with
log_once_on_signal in ert.gui.utils, which takes the message and log
level from the caller, and let the plot controls pass their own
message.

Author: MagnusSletten

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

@@ -15,7 +15,7 @@
     QWidget,
 )
 
-from ert.gui.plotting.utils.logging_utils import log_plot_option_usage_once
+from ert.gui.utils import log_once
 
 
 def create_side_panel(title: str, widget: QWidget) -> QWidget:
@@ -61,7 +61,7 @@ def create_checkbox_with_tooltip(
     checkbox.setToolTip(tooltip)
     checkbox.setChecked(initial_checked)
     checkbox.stateChanged.connect(connection_point)
-    log_plot_option_usage_once(checkbox.clicked, logger, name)
+    log_once(checkbox.clicked, logger, f"Plot sidebar option used: '{name}'")
     return checkbox
 
 
@@ -81,7 +81,7 @@ def create_spinbox_with_tooltip(
     spinbox.setRange(minimum, maximum)
     spinbox.setValue(initial_value)
     spinbox.valueChanged.connect(connection_point)
-    log_plot_option_usage_once(spinbox.valueChanged, logger, name)
+    log_once(spinbox.valueChanged, logger, f"Plot sidebar option used: '{name}'")
     return spinbox
 
 

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

@@ -10,9 +10,9 @@
     QWidget,
 )
 
-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
 from ert.gui.plotting.widgets.plot_controls.color_chooser import ColorBox
+from ert.gui.utils import log_once
 
 logger = logging.getLogger(__name__)
 
@@ -49,7 +49,9 @@ 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")
+        log_once(
+            self.accepted, logger, "Plot sidebar option used: '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/custom_palette_dialog.py

@@ -7,11 +7,11 @@
 )
 
 from ert.gui.plotting.utils import PlotContext
-from ert.gui.plotting.utils.logging_utils import log_plot_option_usage_once
 from ert.gui.plotting.utils.qt_creator import (
     create_group_layout,
 )
 from ert.gui.plotting.widgets.collapsible_section import CollapsibleSection
+from ert.gui.utils import log_once
 
 logger = logging.getLogger(__name__)
 
@@ -28,10 +28,10 @@ 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(
+        log_once(
             self._display_over_button_group.buttonClicked,
             logger,
-            "X-axis display option",
+            "Plot sidebar option used: 'X-axis display option'",
         )
         self._display_over_group = CollapsibleSection(
             "X-axis:",

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

@@ -3,9 +3,9 @@
 
 from PyQt6.QtWidgets import QCheckBox, QHBoxLayout, QLabel, QWidget
 
-from ert.gui.plotting.utils.logging_utils import log_plot_option_usage_once
 from ert.gui.plotting.utils.plot_config import PlotConfig
 from ert.gui.plotting.widgets.plot_controls.color_chooser import ColorBox
+from ert.gui.utils import log_once
 
 logger = logging.getLogger(__name__)
 
@@ -23,8 +23,10 @@ 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"
+        log_once(
+            self._observations_color_box.colorChanged,
+            logger,
+            "Plot sidebar option used: 'Observation color'",
         )
 
         layout = QHBoxLayout(self)

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

@@ -5,9 +5,9 @@
 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
+from ert.gui.utils import log_once
 
 logger = logging.getLogger(__name__)
 
@@ -35,7 +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")
+        log_once(self.activated, logger, "Plot sidebar option used: 'Color palette'")
         self.custom_palette_button = QPushButton(
             load_icon("add_circle_outlined.svg"), "Create custom palette"
         )
@@ -44,8 +44,10 @@ 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"
+        log_once(
+            self.custom_palette_button.clicked,
+            logger,
+            "Plot sidebar option used: 'Create custom palette'",
         )
 
     def _open_custom_palette_dialog(self) -> None:

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

@@ -1,3 +1,6 @@
+import logging
+
+from PyQt6.QtCore import pyqtBoundSignal
 from PyQt6.QtWidgets import QApplication
 
 LEGEND_THRESHOLD = 5
@@ -29,3 +32,18 @@ def truncate_dropdown_item(text: str) -> str:
 
 def truncate_experiment_name(name: str) -> str:
     return truncate_string(name, LONGEST_DEFAULT_EXPERIMENT_NAME)
+
+
+def log_once(
+    signal: pyqtBoundSignal,
+    logger: logging.Logger,
+    message: str,
+    level: int = logging.INFO,
+) -> None:
+    """Log a message the first time a signal is emitted, then disconnect."""
+
+    def log_and_disconnect(*_signal_args: object) -> None:
+        logger.log(level, message)
+        signal.disconnect(log_and_disconnect)
+
+    signal.connect(log_and_disconnect)