Skip to content

Add ophyd_labels to device_info and summary #765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cappel89 wants to merge 3 commits into
base: main
Choose a base branch
from
+10 −1
Open

Add ophyd_labels to device_info and summary #765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6603931
feat(device): add ophyd_labels to device_info and summary
cappel89 Feb 11, 2026
71fdd9e
test(device-summary): fix tests for device.summary()
cappel89 Feb 12, 2026
a6a997a
refactor: cleanup use list[str] for labels instead of set
cappel89 Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion bec_lib/bec_lib/device.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1042,6 +1042,7 @@ def summary(self):
table.add_column("Kind")
table.add_column("Source")
table.add_column("Type")
table.add_column("Labels")
table.add_column("Description")
signals = self._info.get("signals", {})
signals_grouped = defaultdict(dict)
Expand Down Expand Up @@ -1072,13 +1073,14 @@ def summary(self):
signal_info.get("kind_str"),
signal_info.get("describe", {}).get("source"),
signal_info.get("describe", {}).get("dtype"),
", ".join(label for label in signal_info.get("labels", [])),
signal_info.get("doc"),
)
kind_added = True
if bec_signals:
table.add_row()
table.add_section()
table.add_row("BECMessageSignals", "", "", "", "", "", style="bold")
table.add_row("BECMessageSignals", "", "", "", "", "", "", style="bold")
table.add_section()
for signal_name, signal_info in bec_signals:
table.add_row(
Expand All @@ -1087,6 +1089,7 @@ def summary(self):
signal_info.get("kind_str"),
signal_info.get("describe", {}).get("source"),
signal_info.get("describe", {}).get("dtype"),
", ".join(label for label in signal_info.get("labels", [])),
signal_info.get("doc"),
)

Expand Down
4 changes: 4 additions & 0 deletions bec_lib/tests/test_devices.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -768,6 +768,7 @@ def test_device_summary(dev: Any):
"Kind",
"Source",
"Type",
"Labels",
"Description",
]

Expand All @@ -788,6 +789,7 @@ def test_device_summary_signal_grouping(dev: Any):
"hinted",
"SIM:samx",
"integer",
"",
"readback doc string",
)
assert mock_add_row.call_args_list[1][0] == tuple()
Expand All @@ -797,6 +799,7 @@ def test_device_summary_signal_grouping(dev: Any):
"normal",
"SIM:samx_setpoint",
"integer",
"",
"setpoint doc string",
)
devs = [row_call[0][0] for row_call in mock_add_row.call_args_list if row_call[0]]
Expand Down Expand Up @@ -841,6 +844,7 @@ def test_device_summary_bec_signals(dm_with_devices):
"BECMessageSignal:eiger_preview",
"DevicePreviewMessage",
"",
"",
)
]
)
Expand Down
2 changes: 2 additions & 0 deletions bec_server/bec_server/device_server/devices/device_serializer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ def get_device_info(
"describe": signal_obj.describe().get(signal_obj.name, {}),
# pylint: disable=protected-access
"metadata": signal_obj._metadata,
"labels": sorted(signal_obj._ophyd_labels_),
}
}
)
Expand All @@ -203,6 +204,7 @@ def get_device_info(
"describe": signal_obj.describe().get(signal_obj.name, {}),
# pylint: disable=protected-access
"metadata": signal_obj._metadata,
"labels": sorted(signal_obj._ophyd_labels_),
}
}
)
Expand Down
Loading