refactor(queue): separate RPC method names from arguments

This commit is contained in:
wakonig_k authored and Jan Wyzula committed 2026-11-09 13:55:29 +01:00
1 parent 63bb68dbce
commit c410f13468
4 files changed
+63 -7

No files matched your search

@@ -74,14 +74,16 @@ class ListRow(AnimatedRow):
self.lead.setFont(mono_font(-1))
self.lead.setFixedWidth(20)
self.lead.setAlignment(Qt.AlignmentFlag.AlignRight | Qt.AlignmentFlag.AlignVCenter)
self.name_label = QLabel(self)
is_rpc = bool(entry.rpc_command)
self.name_label = ElidedLabel(parent=self) if is_rpc else QLabel(self)
self.name_label.setTextFormat(Qt.TextFormat.PlainText)
self.name_label.setFont(mono_font(0, bold=not finished))
self.meta_label = ElidedLabel(parent=self)
self.tail_label = QLabel(self)
self.tail_label.setFont(mono_font(-1))
self.tail_label.setAlignment(Qt.AlignmentFlag.AlignRight | Qt.AlignmentFlag.AlignVCenter)
line.addWidget(self.lead)
line.addWidget(self.name_label)
line.addWidget(self.name_label, int(is_rpc))
line.addWidget(self.meta_label, 1)
line.addWidget(self.tail_label)
self.buttons: list[IconButton] = []
@@ -154,11 +156,16 @@ class ListRow(AnimatedRow):
set_style(self.tail_label, f"color: {tail_color};")
self.tail_label.setVisible(bool(self.tail_label.text()))
self.name_label.setText(entry.title)
if isinstance(self.name_label, ElidedLabel):
self.name_label.setMaximumWidth(
self.name_label.fontMetrics().horizontalAdvance(entry.title) + 2
)
# a scan with its own name keeps its type visible, muted, before the metadata
scan_type = [entry.scan_type] if entry.scan_type and entry.scan_type != entry.name else []
parts = scan_type + [value for _, value in entry.metadata]
if self.owner.show_details and entry.args:
parts.append(entry.args)
arguments = entry.rpc_arguments if entry.rpc_command else entry.args
if self.owner.show_details and arguments:
parts.append(arguments)
self.meta_label.setText(" · ".join(parts))
set_style(self.meta_label, f"color: {muted};")
if self.toolTip() != entry.args: # also restores it after a failure note
@@ -231,6 +238,7 @@ class DetailDrawer(QFrame):
layout.addLayout(head)
self.name_label = QLabel(self)
self.name_label.setFont(mono_font(1.5, bold=True))
self.name_label.setTextFormat(Qt.TextFormat.PlainText)
self.name_label.setTextInteractionFlags(Qt.TextInteractionFlag.TextSelectableByMouse)
layout.addWidget(self.name_label)
self.details = QWidget(self)
@@ -421,7 +429,10 @@ class DetailDrawer(QFrame):
if not has:
return
self.name_label.setText(entry.title)
self.name_label.setWordWrap(bool(entry.rpc_command))
arguments, metadata = entry_detail_columns(entry)
self.details.setVisible(bool(arguments or metadata))
self.args_box.setVisible(bool(arguments) or not entry.rpc_command)
self.args_grid.set_items(arguments)
self.meta_grid.set_items(metadata)
self.meta_box.setVisible(bool(metadata))
@@ -23,6 +23,7 @@ from bec_widgets.utils.error_popups import SafeSlot
from bec_widgets.widgets.progress.scan_progressbar.scan_ui import (
args_summary,
metadata_items,
rpc_call,
scan_bundle_names,
scan_display_name,
)
@@ -95,9 +96,24 @@ class QueueEntry:
"""Stable identity of the entry across queue updates."""
return self.queue_id
@property
def rpc_command(self) -> str:
"""Formatted command for a device RPC with a known target."""
if self.scan_type != "device_rpc":
return ""
parameter = getattr(self.request, "parameter", None) or {}
return rpc_call(parameter.get("kwargs"))
@property
def rpc_arguments(self) -> str:
"""Formatted arguments without the command name or outer parentheses."""
return self.rpc_command.partition("(")[2][:-1]
@property
def title(self) -> str:
"""Display title, such as "#12 line_scan" or "line_scan +2"."""
if command := self.rpc_command:
return command.partition("(")[0]
number = f"#{self.scan_number} " if self.scan_number is not None else ""
more = f" +{self.blocks - 1}" if self.blocks > 1 else ""
return f"{number}{self.name}{more}"
@@ -317,9 +317,12 @@ def entry_detail_columns(entry: QueueEntry) -> tuple[list[tuple[str, str]], list
The details of an entry split in two: (scan arguments and request info, user metadata).
Every argument is its own row.
"""
arguments = args_items(getattr(entry.request, "parameter", None), entry.bundle_names)
if not arguments and entry.args:
arguments = [("args", entry.args)]
if entry.rpc_command:
arguments = [("args", entry.rpc_arguments)] if entry.rpc_arguments else []
else:
arguments = args_items(getattr(entry.request, "parameter", None), entry.bundle_names)
if not arguments and entry.args:
arguments = [("args", entry.args)]
if entry.scan_type and entry.scan_type != entry.name:
arguments.append(("scan", entry.scan_type))
if entry.blocks > 1:
+26
View File
@@ -461,6 +461,32 @@ def test_a_device_rpc_is_shown_as_a_call():
assert args_items(parameter) == [("call", "samx.set(5, wait=True)")]
def test_device_rpc_title_keeps_arguments_separate(qtbot, mocked_client):
request = {
"scan_type": "device_rpc",
"args": [],
"kwargs": {
"device": "bpm4i",
"func": "sim.select_model",
"func_kwargs": {"model": "ConstantModel"},
},
}
push_state(mocked_client, [], history=[history_msg("rpc", **request)])
widget = create_queue(qtbot, mocked_client)
row = widget.finished_rows.rows["rpc"]
title = "bpm4i.sim.select_model"
arguments = "model='ConstantModel'"
assert row.name_label.full_text() == title
assert row.meta_label.full_text() == arguments
assert row.toolTip() == f"{title}({arguments})"
widget.show_details = False
assert row.name_label.full_text() == title
assert row.meta_label.full_text() == ""
widget.select("rpc")
assert widget.drawer.name_label.text() == title
assert entry_detail_columns(widget.model.finished[0])[0] == [("args", arguments)]
def test_show_details_off_hides_the_arguments_in_the_rows_only(qtbot, mocked_client, queue_infos):
push_state(mocked_client, queue_infos, history=[history_msg("h-1", scan_number=11)])
widget = create_queue(qtbot, mocked_client)