merged both paramaters into delete_source

Author: andrewelamb

synapseclient/models/curation.py

@@ -215,19 +215,16 @@ def get(self, *, synapse_client: Optional[Synapse] = None) -> "CurationTask":
 
     def delete(
         self,
-        delete_file_view: bool = False,
-        delete_record_set: bool = False,
+        delete_source: bool = False,
         *,
         synapse_client: Optional[Synapse] = None,
     ) -> None:
         """
         Deletes a CurationTask from Synapse.
 
         Arguments:
-            delete_file_view: If True, the associated EntityView will also be deleted
-                if the task is a FileBasedMetadataTask. Defaults to False.
-            delete_record_set: If True, the associated RecordSet will also be deleted
-                if the task is a RecordBasedMetadataTask. Defaults to False.
+            delete_source: If True, the associated source data (EntityView or RecordSet) will also be deleted
+                if the task is a FileBasedMetadataTask or RecordBasedMetadataTask respectively. Defaults to False.
             synapse_client: If not passed in and caching was not disabled by
                 `Synapse.allow_client_caching(False)` this will use the last created
                 instance from the Synapse class constructor.
@@ -249,7 +246,7 @@ def delete(
             task.delete()
             ```
 
-        Example: Delete a curation task and its associated file view
+        Example: Delete a curation task and its associated data source
              
 
             ```python
@@ -260,21 +257,7 @@ def delete(
             syn.login()
 
             task = CurationTask(task_id=123)
-            task.delete(delete_file_view=True)
-            ```
-
-        Example: Delete a curation task and its associated record set
-             
-
-            ```python
-            from synapseclient import Synapse
-            from synapseclient.models import CurationTask
-
-            syn = Synapse()
-            syn.login()
-
-            task = CurationTask(task_id=123)
-            task.delete(delete_record_set=True)
+            task.delete(delete_source=True)
             ```
         """
         return None
@@ -642,29 +625,22 @@ async def main():
 
     async def delete_async(
         self,
-        delete_file_view: bool = False,
-        delete_record_set: bool = False,
+        delete_source: bool = False,
         *,
         synapse_client: Optional[Synapse] = None,
     ) -> None:
         """
         Deletes a CurationTask from Synapse.
 
         Arguments:
-            delete_file_view: If True, the associated EntityView will also be deleted
-                if the task is a FileBasedMetadataTask. Defaults to False.
-            delete_record_set: If True, the associated RecordSet will also be deleted
-                if the task is a RecordBasedMetadataTask. Defaults to False.
+            delete_source: If True, the associated source data (EntityView or RecordSet) will also be deleted
+                if the task is a FileBasedMetadataTask or RecordBasedMetadataTask respectively. Defaults to False.
             synapse_client: If not passed in and caching was not disabled by
                 `Synapse.allow_client_caching(False)` this will use the last created
                 instance from the Synapse class constructor.
 
         Raises:
             ValueError: If the CurationTask object does not have a task_id.
-            ValueError: If delete_file_view=True but the task is not a FileBasedMetadataTask or does not have a
-                file_view_id.
-            ValueError: If delete_record_set=True but the task is not a RecordBasedMetadataTask or does not have a
-                record_set_id.
 
 
         Example: Delete a curation task asynchronously
@@ -686,26 +662,7 @@ async def main():
             asyncio.run(main())
             ```
 
-        Example: Delete a curation task and its associated file view asynchronously
-             
-
-            ```python
-            import asyncio
-            from synapseclient import Synapse
-            from synapseclient.models import CurationTask
-
-            syn = Synapse()
-            syn.login()
-
-            async def main():
-                task = CurationTask(task_id=123)
-                await task.delete_async(delete_file_view=True)
-                print("Task and file view deleted successfully")
-
-            asyncio.run(main())
-            ```
-
-        Example: Delete a curation task and its associated record set asynchronously
+        Example: Delete a curation task and its associated data source asynchronously
              
 
             ```python
@@ -718,7 +675,7 @@ async def main():
 
             async def main():
                 task = CurationTask(task_id=123)
-                await task.delete_async(delete_record_set=True)
+                await task.delete_async(delete_source=True)
                 print("Task and record set deleted successfully")
 
             asyncio.run(main())
@@ -733,62 +690,32 @@ async def main():
             }
         )
 
-        if delete_file_view or delete_record_set:
+        if delete_source:
             if not self.task_properties:
                 await self.get_async(synapse_client=synapse_client)
-
-        if delete_file_view:
-            if (
-                isinstance(self.task_properties, FileBasedMetadataTaskProperties)
-                and self.task_properties.file_view_id
-            ):
-                from synapseclient.models.entityview import EntityView
+            if isinstance(self.task_properties, FileBasedMetadataTaskProperties):
+                if not self.task_properties.file_view_id:
+                    raise ValueError(
+                        "file_view_id is required to delete the associated file view"
+                    )
+                from synapseclient.models import EntityView
 
                 await EntityView(id=self.task_properties.file_view_id).delete_async(
                     synapse_client=synapse_client
                 )
-
-            elif not isinstance(self.task_properties, FileBasedMetadataTaskProperties):
-                raise ValueError(
-                    (
-                        "The `delete_file_view` parameter was set to True, "
-                        "but the task is not configured as a FileBasedMetadataTask."
+            elif isinstance(self.task_properties, RecordBasedMetadataTaskProperties):
+                if not self.task_properties.record_set_id:
+                    raise ValueError(
+                        "record_set_id is required to delete the associated record set"
                     )
-                )
-            else:
-                raise ValueError(
-                    (
-                        "The `delete_file_view` parameter was set to True, "
-                        "but the task does not have an associated file view ID."
-                    )
-                )
-
-        if delete_record_set:
-            if (
-                isinstance(self.task_properties, RecordBasedMetadataTaskProperties)
-                and self.task_properties.record_set_id
-            ):
-                from synapseclient.models.recordset import RecordSet
+                from synapseclient.models import RecordSet
 
                 await RecordSet(id=self.task_properties.record_set_id).delete_async(
                     synapse_client=synapse_client
                 )
-
-            elif not isinstance(
-                self.task_properties, RecordBasedMetadataTaskProperties
-            ):
-                raise ValueError(
-                    (
-                        "The `delete_record_set` parameter was set to True, "
-                        "but the task is not configured as a RecordBasedMetadataTask."
-                    )
-                )
             else:
                 raise ValueError(
-                    (
-                        "The `delete_record_set` parameter was set to True, "
-                        "but the task does not have an associated record set ID."
-                    )
+                    "Failed to retrieve task properties for deletion. Cannot delete source."
                 )
 
         await delete_curation_task(task_id=self.task_id, synapse_client=synapse_client)

tests/integration/synapseclient/models/async/test_curation_async.py

@@ -464,9 +464,7 @@ async def test_delete_file_based_curation_task_async(
         assert task_id is not None
 
         # WHEN I delete the task asynchronously, without deleting the file view
-        await curation_task.delete_async(
-            synapse_client=self.syn, delete_file_view=False
-        )
+        await curation_task.delete_async(synapse_client=self.syn, delete_source=False)
 
         # THEN the task should be deleted and no longer retrievable
         with pytest.raises(SynapseHTTPError):
@@ -498,12 +496,15 @@ async def test_delete_file_based_curation_task_and_fileview_async(
         assert task_id is not None
 
         # WHEN I delete the task and fileview asynchronously
-        await curation_task.delete_async(synapse_client=self.syn, delete_file_view=True)
+        await curation_task.delete_async(synapse_client=self.syn, delete_source=True)
 
         # THEN the task should be deleted and no longer retrievable
         with pytest.raises(SynapseHTTPError):
             await CurationTask(task_id=task_id).get_async(synapse_client=self.syn)
 
+        print("##########")
+        print(entity_view.id)
+        print("##########")
         # AND the file view should be deleted and no longer retrievable
         with pytest.raises(SynapseHTTPError):
             await EntityView(entity_view.id).get_async(synapse_client=self.syn)
@@ -530,9 +531,7 @@ async def test_delete_record_based_curation_task_async(
         assert task_id is not None
 
         # WHEN I delete the task asynchronously, without deleting the record set
-        await curation_task.delete_async(
-            synapse_client=self.syn, delete_record_set=False
-        )
+        await curation_task.delete_async(synapse_client=self.syn, delete_source=False)
 
         # THEN the task should be deleted and no longer retrievable
         with pytest.raises(SynapseHTTPError):
@@ -563,9 +562,7 @@ async def test_delete_record_based_curation_task_and_record_set_async(
         assert task_id is not None
 
         # WHEN I delete the task asynchronously, without deleting the record set
-        await curation_task.delete_async(
-            synapse_client=self.syn, delete_record_set=True
-        )
+        await curation_task.delete_async(synapse_client=self.syn, delete_source=True)
 
         # THEN the task should be deleted and no longer retrievable
         with pytest.raises(SynapseHTTPError):