Skip to content

Commit 6c0f3da

Browse files
committed
Method get_object_uuids: add an optional group argument (group ID, title or number)
1 parent 789ab6c commit 6c0f3da

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

cdlclient/baseproxy.py

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -329,16 +329,20 @@ def get_object(
329329
"""
330330

331331
@abc.abstractmethod
332-
def get_object_uuids(self, panel: str | None = None) -> list[str]:
332+
def get_object_uuids(
333+
self, panel: str | None = None, group: int | str | None = None
334+
) -> list[str]:
333335
"""Get object (signal/image) uuid list for current panel.
334336
Objects are sorted by group number and object index in group.
335337
336338
Args:
337-
panel (str | None): panel name (valid values: "signal", "image").
338-
If None, current panel is used.
339+
panel: panel name (valid values: "signal", "image").
340+
If None, current panel is used.
341+
group: Group number, or group id, or group title.
342+
Defaults to None (all groups).
339343
340344
Returns:
341-
list[str]: list of object uuids
345+
List of object uuids
342346
343347
Raises:
344348
ValueError: if panel not found
@@ -669,21 +673,25 @@ def get_object_titles(self, panel: str | None = None) -> list[str]:
669673
"""
670674
return self._cdl.get_object_titles(panel)
671675

672-
def get_object_uuids(self, panel: str | None = None) -> list[str]:
676+
def get_object_uuids(
677+
self, panel: str | None = None, group: int | str | None = None
678+
) -> list[str]:
673679
"""Get object (signal/image) uuid list for current panel.
674680
Objects are sorted by group number and object index in group.
675681
676682
Args:
677-
panel (str | None): panel name (valid values: "signal", "image").
678-
If None, current panel is used.
683+
panel: panel name (valid values: "signal", "image").
684+
If None, current panel is used.
685+
group: Group number, or group id, or group title.
686+
Defaults to None (all groups).
679687
680688
Returns:
681-
list[str]: list of object uuids
689+
List of object uuids
682690
683691
Raises:
684692
ValueError: if panel not found
685693
"""
686-
return self._cdl.get_object_uuids(panel)
694+
return self._cdl.get_object_uuids(panel, group)
687695

688696
def add_label_with_title(
689697
self, title: str | None = None, panel: str | None = None

0 commit comments

Comments
 (0)