ms-components 0.4.0__tar.gz → 0.4.2__tar.gz

{ms_components-0.4.0 → ms_components-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ms_components
-Version: 0.4.0
+Version: 0.4.2
 Summary: PySide6 UI components for MolSuite: smart table, project browser, job monitor, PyMOL dock, steppers.
 Author: Mario S. Valdés-Tresanco, Mario E. Valdés-Tresanco
 License-Expression: MIT

{ms_components-0.4.0 → ms_components-0.4.2}/src/ms_components/ms_dockwidget/widget.py

@@ -779,6 +779,7 @@ class DockManager:
         # Standalone action buttons (no dock): a click runs a callback instead of toggling a dock.
         # action_id -> {"region", "order", "button"}. Re-added on every _build_toolbars().
         self.action_buttons: Dict[str, dict] = {}
+        self.action_separators: Dict[str, dict] = {}  # same shape; "button" is a ToolbarSeparator
         self.region_states: Dict[Region, RegionState] = {
             region: RegionState(order=[], visible=[]) for region in Region
         }
@@ -885,6 +886,14 @@ class DockManager:
         self._build_toolbars()
         return button
 
+    def add_action_separator(self, separator_id: str, *, region: Region, order: int) -> None:
+        """A line in a toolbar region, placed by ``order`` like an action button, so it survives
+        the rebuilds a line inserted into the layout would not."""
+        if separator_id in self.action_separators:
+            raise ValueError(f"Duplicate action separator id: {separator_id}")
+        self.action_separators[separator_id] = {"region": region, "order": int(order), "button": ToolbarSeparator()}
+        self._build_toolbars()
+
     # ── Build ────────────────────────────────────────────────────
 
     def build(self):
@@ -1595,7 +1604,7 @@ class DockManager:
                 # dock buttons keep their (possibly drag-set) region order; standalone action
                 # buttons are woven in by their `order` relative to the dock entries' orders.
                 merged = [(entry.order, self.buttons[entry.id]) for entry in self._region_entries(region)]
-                for action in self.action_buttons.values():
+                for action in (*self.action_buttons.values(), *self.action_separators.values()):
                     if action["region"] != region:
                         continue
                     idx = next((i for i, (order, _) in enumerate(merged) if order > action["order"]), len(merged))

{ms_components-0.4.0 → ms_components-0.4.2}/src/ms_components/ms_tutorial/controller.py

@@ -56,12 +56,14 @@ class TutorialController(QObject):
                  events: Mapping[str, TutorialEvent] | None = None,
                  instruction_provider: Callable[[TutorialStep], str] | None = None,
                  dim_background: bool = True,
+                 close_only: bool = False,
                  parent: QObject | None = None):
         super().__init__(parent)
         self.targets = dict(targets)
         self.events = dict(events or {})
         self.instruction_provider = instruction_provider
         self.dim_background = dim_background
+        self.close_only = close_only
         self._tutorial: Tutorial | None = None
         self._index = -1
         self._completed: set[str] = set()
@@ -93,6 +95,8 @@ class TutorialController(QObject):
     def start(self, tutorial: Tutorial):
         """Validate bindings before replacing the active tour. Must run in the UI thread."""
         for step in tutorial.steps:
+            if self.close_only and step.advance_on is None:
+                raise ValueError("Close-only tutorials require an event for every step")
             if not isinstance(self.targets.get(step.target), TutorialTarget):
                 raise ValueError(f"Unregistered tutorial target: {step.target}")
             if step.advance_on is not None and not isinstance(self.events.get(step.advance_on), TutorialEvent):
@@ -217,7 +221,7 @@ class TutorialController(QObject):
                 if self.overlay is not None:
                     self.overlay.hide()
                     self.overlay.deleteLater()
-                self._overlay = TutorialOverlay(host, dim_background=self.dim_background)
+                self._overlay = TutorialOverlay(host, dim_background=self.dim_background, close_only=self.close_only)
                 self._overlay.next_requested.connect(self.next)
                 self._overlay.back_requested.connect(self.back)
                 self._overlay.exit_requested.connect(self.stop)

{ms_components-0.4.0 → ms_components-0.4.2}/src/ms_components/ms_tutorial/overlay.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 from math import ceil
 
 from PySide6.QtCore import QPoint, QRect, QRectF, Qt, Signal
-from PySide6.QtGui import QPainter, QPainterPath, QPalette, QPen
+from PySide6.QtGui import QColor, QPainter, QPainterPath, QPalette, QPen
 from PySide6.QtWidgets import (
     QFrame, QHBoxLayout, QLabel, QPushButton, QSizePolicy, QTextBrowser,
     QVBoxLayout, QWidget,
@@ -19,9 +19,10 @@ class TutorialOverlay(QWidget):
     back_requested = Signal()
     exit_requested = Signal()
 
-    def __init__(self, host: QWidget, *, dim_background: bool = True):
+    def __init__(self, host: QWidget, *, dim_background: bool = True, close_only: bool = False):
         super().__init__(host)
         self.dim_background = dim_background
+        self.close_only = close_only
         self.setAttribute(Qt.WidgetAttribute.WA_NoSystemBackground)
         self.hole = QRect()
         self.step: TutorialStep | None = None
@@ -48,17 +49,40 @@ class TutorialOverlay(QWidget):
         self.body.setFrameShape(QFrame.Shape.NoFrame)
         self.body.setOpenExternalLinks(False)
         self.body.setFocusPolicy(Qt.FocusPolicy.NoFocus)
-        for widget in (self.counter, self.title, self.body):
-            layout.addWidget(widget)
+        if close_only:
+            self.counter.setMinimumWidth(0)
+            self.counter.setSizePolicy(QSizePolicy.Policy.Ignored, QSizePolicy.Policy.Preferred)
+            header = QHBoxLayout()
+            header.setContentsMargins(0, 0, 0, 0)
+            header.addWidget(self.counter, 1)
+            layout.addLayout(header)
+        else:
+            layout.addWidget(self.counter)
+        layout.addWidget(self.title)
+        layout.addWidget(self.body)
         actions = QHBoxLayout()
         self.exit_button = QPushButton(self.tr("Exit · Esc"))
         self.back_button = QPushButton(self.tr("Back"))
         self.next_button = QPushButton(self.tr("Next"))
-        for button in (self.exit_button, self.back_button, self.next_button):
-            button.setMinimumWidth(0)
-            button.setSizePolicy(QSizePolicy.Policy.Ignored, QSizePolicy.Policy.Fixed)
-            actions.addWidget(button)
-        layout.addLayout(actions)
+        if close_only:
+            self.exit_button.setText("×")
+            self.exit_button.setAccessibleName(self.tr("Close tutorial"))
+            self.exit_button.setToolTip(self.tr("Close tutorial (Esc)"))
+            self.exit_button.setFlat(True)
+            self.exit_button.setSizePolicy(QSizePolicy.Policy.Fixed, QSizePolicy.Policy.Fixed)
+            self.exit_button.setFixedSize(28, 28)
+            self.exit_button.setStyleSheet("font-size: 20px; padding: 0;")
+            header.addWidget(self.exit_button, 0, Qt.AlignmentFlag.AlignTop)
+            self.back_button.setParent(self.panel)
+            self.next_button.setParent(self.panel)
+            self.back_button.hide()
+            self.next_button.hide()
+        else:
+            for button in (self.exit_button, self.back_button, self.next_button):
+                button.setMinimumWidth(0)
+                button.setSizePolicy(QSizePolicy.Policy.Ignored, QSizePolicy.Policy.Fixed)
+                actions.addWidget(button)
+            layout.addLayout(actions)
         self.exit_button.clicked.connect(self.exit_requested)
         self.back_button.clicked.connect(self.back_requested)
         self.next_button.clicked.connect(self.next_requested)
@@ -147,7 +171,7 @@ class TutorialOverlay(QWidget):
         self.update()
 
     def focus_guide(self):
-        (self.next_button if self.next_button.isEnabled() else self.exit_button).setFocus()
+        (self.next_button if not self.close_only and self.next_button.isEnabled() else self.exit_button).setFocus()
 
     def paintEvent(self, event):
         painter = QPainter(self)
@@ -160,5 +184,14 @@ class TutorialOverlay(QWidget):
             opening = QPainterPath()
             opening.addRect(QRectF(self.hole))
             painter.fillPath(path.subtracted(opening), shade)
-        painter.setPen(QPen(self.palette().color(QPalette.ColorRole.Highlight), 3))
-        painter.drawRoundedRect(QRectF(self.hole.adjusted(-3, -3, 3, 3)), 6, 6)
+        # A two-tone ring distinguishes the guide from the theme's selection and
+        # button colors. The contrasting outer stroke keeps it visible over mixed
+        # surfaces, including selected controls and application artwork.
+        dark = self.palette().color(QPalette.ColorRole.Window).lightness() < 128
+        halo = QColor("#141a22" if dark else "#ffffff")
+        guide = QColor("#ffd166" if dark else "#8c4b00")
+        rect = QRectF(self.hole.adjusted(-5, -5, 5, 5))
+        painter.setPen(QPen(halo, 7))
+        painter.drawRoundedRect(rect, 7, 7)
+        painter.setPen(QPen(guide, 3))
+        painter.drawRoundedRect(rect, 7, 7)

{ms_components-0.4.0 → ms_components-0.4.2}/src/ms_components.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ms_components
-Version: 0.4.0
+Version: 0.4.2
 Summary: PySide6 UI components for MolSuite: smart table, project browser, job monitor, PyMOL dock, steppers.
 Author: Mario S. Valdés-Tresanco, Mario E. Valdés-Tresanco
 License-Expression: MIT

ms_components-0.4.2/src/ms_components.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.4.2",
+  "distance": 0,
+  "node": "g154aef5200c38d657805e5c382f0c99b1c15be3d",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-28"
+}

{ms_components-0.4.0 → ms_components-0.4.2}/tests/test_dock_window.py

@@ -154,3 +154,23 @@ def test_a_window_stays_a_window_on_double_click_and_drop(app):
 
     window.close()
     app.processEvents()
+
+
+def test_action_separator_sits_by_order_and_survives_a_rebuild(app):
+    from ms_components.ms_dockwidget.widget import ToolbarSeparator
+
+    window = QMainWindow()
+    manager = DockManager(window)
+    manager.add_action_button("a", region=Region.BOTTOM_LEFT, order=1, on_click=lambda: None)
+    manager.add_action_button("b", region=Region.BOTTOM_LEFT, order=3, on_click=lambda: None)
+    manager.add_action_separator("line", region=Region.BOTTOM_LEFT, order=2)
+    manager.set_show_tool_names(True)  # restyles every button: the separator is not one
+    manager._build_toolbars()
+
+    layout = manager.left_toolbar.layout_for_region(Region.BOTTOM_LEFT)
+    widgets = [layout.itemAt(i).widget() for i in range(layout.count())]
+    assert widgets[1] is manager.action_separators["line"]["button"]
+    assert isinstance(widgets[1], ToolbarSeparator)
+    assert widgets[0] is manager.action_buttons["a"]["button"]
+    assert widgets[2] is manager.action_buttons["b"]["button"]
+    window.close()

{ms_components-0.4.0 → ms_components-0.4.2}/tests/test_tutorial.py

@@ -157,6 +157,22 @@ def test_outline_only_presentation_preserves_the_background(ui):
     assert QApplication.widgetAt(button.mapToGlobal(button.rect().center())) is button
 
 
+def test_guide_outline_changes_with_theme_and_keeps_target_clickable(ui):
+    app, window, button, other, controller = ui
+    controller.dim_background = False
+    controller.start(tour(interactive=True))
+    for theme, expected in (("github_light", "#8c4b00"), ("github_dark", "#ffd166")):
+        apply_theme(theme, app)
+        app.processEvents()
+        image = window.grab().toImage()
+        rect = controller.overlay.hole.adjusted(-9, -9, 9, 9).intersected(window.rect())
+        colors = {image.pixelColor(x, y).name()
+                  for x in range(rect.left(), rect.right() + 1)
+                  for y in range(rect.top(), rect.bottom() + 1)}
+        assert expected in colors
+        assert QApplication.widgetAt(button.mapToGlobal(button.rect().center())) is button
+
+
 def test_accepting_a_dialog_keeps_the_tutorial_active_but_closing_cancels(ui):
     app, window, button, other, controller = ui
     dialog = QDialog(window)
@@ -458,3 +474,55 @@ def test_a_still_tour_does_not_repaint_on_every_tracker_tick(ui):
     QTest.qWait(800)  # ten tracker ticks
     controller.overlay.removeEventFilter(counter)
     assert len(paints) <= 1
+
+
+def test_close_only_mode_has_accessible_close_control_and_escape(ui):
+    app, _window, button, _other, controller = ui
+    controller.close_only = True
+    tutorial = Tutorial("interactive", "Interactive", (
+        TutorialStep("action", "run", "Action", "Click the action.", "clicked"),
+    ))
+    controller.start(tutorial)
+    overlay = controller.overlay
+    assert overlay.exit_button.text() == "×"
+    assert overlay.exit_button.accessibleName() == "Close tutorial"
+    assert overlay.exit_button.isVisible()
+    assert not overlay.back_button.isVisible() and not overlay.next_button.isVisible()
+    assert overlay.exit_button.geometry().right() > overlay.counter.geometry().right()
+    assert overlay.panel.rect().contains(overlay.exit_button.geometry())
+    QTest.mouseClick(overlay.exit_button, Qt.LeftButton)
+    assert not controller.is_active
+    controller.start(tutorial)
+    QTest.keyClick(controller.overlay.exit_button, Qt.Key_Escape)
+    assert not controller.is_active
+
+
+def test_close_only_rejects_steps_that_need_next_button(ui):
+    _app, _window, _button, _other, controller = ui
+    controller.close_only = True
+    with pytest.raises(ValueError, match="require an event"):
+        controller.start(tour())
+    assert not controller.is_active
+
+
+def test_close_only_follows_target_into_another_window(ui):
+    app, window, button, _other, controller = ui
+    dialog = QDialog(window)
+    action = QPushButton("Finish", dialog)
+    button.clicked.connect(dialog.show)
+    controller.targets["dialog"] = TutorialTarget(action)
+    controller.events["finish"] = TutorialEvent(action.clicked)
+    controller.close_only = True
+    controller.start(Tutorial("dialog", "Dialog", (
+        TutorialStep("open", "run", "Open", "Open dialog.", "clicked"),
+        TutorialStep("finish", "dialog", "Finish", "Finish the task.", "finish"),
+    )))
+    QTest.mouseClick(button, Qt.LeftButton)
+    app.processEvents()
+    overlay = controller.overlay
+    assert overlay.parentWidget() is dialog
+    assert overlay.exit_button.isVisible() and overlay.exit_button.text() == "×"
+    assert overlay.panel.rect().contains(overlay.exit_button.geometry())
+    QTest.mouseClick(overlay.exit_button, Qt.LeftButton)
+    assert not controller.is_active
+    dialog.close()

ms_components-0.4.0/src/ms_components.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "0.4.0",
-  "distance": 0,
-  "node": "g67c7e3524755a092256bc5b14b52b34dba401932",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-10-27"
-}