Skip to content

Commit 218f8a3

Browse files
committed
Added keep_roi argument to delete_metadata method
1 parent cd3f6a1 commit 218f8a3

File tree

3 files changed

+22
-7
lines changed

3 files changed

+22
-7
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# DataLab Simple Client Releases #
22

3+
## Version 0.8.0 ##
4+
5+
DataLab Simple Client is fully compatible with **DataLab 0.11.0** and above.
6+
With older versions of the DataLab server, some features may not work.
7+
8+
💥 Changes:
9+
10+
* Added `keep_roi` argument to `SimpleRemoteProxy.delete_metadata` method
11+
312
## Version 0.7.0 ##
413

514
DataLab Simple Client is fully compatible with **DataLab 0.10.0** and above.

cdlclient/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
from cdlclient.baseproxy import SimpleBaseProxy # noqa: F401
1818
from cdlclient.remote import SimpleRemoteProxy # noqa: F401
1919

20-
__version__ = "0.7.0"
21-
__required_server_version__ = "0.10.0"
20+
__version__ = "0.8.0"
21+
__required_server_version__ = "0.11.0"
2222
__docurl__ = "https://cdlclient.readthedocs.io/en/latest/"
2323
__homeurl__ = "https://github.com/Codra-Ingenierie-Informatique/DataLabSimpleClient/"

cdlclient/baseproxy.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -275,11 +275,14 @@ def select_groups(
275275
"""
276276

277277
@abc.abstractmethod
278-
def delete_metadata(self, refresh_plot: bool = True) -> None:
278+
def delete_metadata(
279+
self, refresh_plot: bool = True, keep_roi: bool = False
280+
) -> None:
279281
"""Delete metadata of selected objects
280282
281283
Args:
282-
refresh_plot (bool | None): Refresh plot. Defaults to True.
284+
refresh_plot: Refresh plot. Defaults to True.
285+
keep_roi: Keep ROI. Defaults to False.
283286
"""
284287

285288
@abc.abstractmethod
@@ -607,13 +610,16 @@ def select_groups(
607610
"""
608611
self._cdl.select_groups(selection, panel)
609612

610-
def delete_metadata(self, refresh_plot: bool = True) -> None:
613+
def delete_metadata(
614+
self, refresh_plot: bool = True, keep_roi: bool = False
615+
) -> None:
611616
"""Delete metadata of selected objects
612617
613618
Args:
614-
refresh_plot (bool | None): Refresh plot. Defaults to True.
619+
refresh_plot: Refresh plot. Defaults to True.
620+
keep_roi: Keep ROI. Defaults to False.
615621
"""
616-
self._cdl.delete_metadata(refresh_plot)
622+
self._cdl.delete_metadata(refresh_plot, keep_roi)
617623

618624
def get_group_titles_with_object_infos(
619625
self,

0 commit comments

Comments
 (0)