ENH: add 'delete_node' API

Author: dmgav

src/save_and_restore_api/_api_async.py

@@ -53,6 +53,10 @@ async def add_node(self, parentNodeId, *, name, nodeType, **kwargs):
         )
         return await self.send_request(method, url, params=params)
 
+    async def delete_node(self, nodeId):
+        method, url = self._prepare_delete_node(nodeId=nodeId)
+        return await self.send_request(method, url)
+
     async def delete_nodes(self, uniqueIds):
         method, url, params = self._prepare_delete_nodes(uniqueIds=uniqueIds)
         return await self.send_request(method, url, params=params)

src/save_and_restore_api/_api_base.py

@@ -156,6 +156,10 @@ def _prepare_add_node(self, *, parentNodeId, name, nodeType, **kwargs):
         params.update({"name": name, "nodeType": nodeType})
         return method, url, params
 
+    def _prepare_delete_node(self, *, nodeId):
+        method, url = "DELETE", f"/node/{nodeId}"
+        return method, url
+
     def _prepare_delete_nodes(self, *, uniqueIds):
         method, url = "DELETE", "/node"
         params = uniqueIds

src/save_and_restore_api/_api_threads.py

@@ -56,6 +56,11 @@ def add_node(self, parentNodeId, *, name, nodeType, **kwargs):
         )
         return self.send_request(method, url, params=params)
 
+    def delete_node(self, nodeId):
+        method, url = self._prepare_delete_node(nodeId=nodeId)
+        print(f"================= method={method}, url={url} =================")  ##
+        return self.send_request(method, url)
+
     def delete_nodes(self, uniqueIds):
         method, url, params = self._prepare_delete_nodes(uniqueIds=uniqueIds)
         return self.send_request(method, url, params=params)

tests/test_package.py

@@ -189,6 +189,120 @@ async def testing():
         asyncio.run(testing())
 
 
+# fmt: off
+@pytest.mark.parametrize("library", ["THREADS", "ASYNC"])
+# fmt: on
+def test_delete_node_01(clear_sar, library):  # noqa: F811
+    """
+    Tests for the 'add_node' API.
+    """
+    if not _is_async(library):
+        with SaveRestoreAPI_Threads(base_url=base_url, timeout=2) as SR:
+            SR.set_auth(username=user_username, password=user_password)
+
+            response = SR.add_node(SR.ROOT_NODE_UID, name="Test Folder", nodeType="FOLDER")
+            assert response["name"] == "Test Folder"
+            assert response["nodeType"] == "FOLDER"
+            folder_uid = response["uniqueId"]
+
+            response = SR.add_node(folder_uid, name="Test Config 1", nodeType="CONFIGURATION")
+            assert response["name"] == "Test Config 1"
+            assert response["nodeType"] == "CONFIGURATION"
+            node_uid_1 = response["uniqueId"]
+
+            response = SR.add_node(folder_uid, name="Test Config 2", nodeType="CONFIGURATION")
+            assert response["name"] == "Test Config 2"
+            assert response["nodeType"] == "CONFIGURATION"
+            node_uid_2 = response["uniqueId"]
+
+            SR.delete_node(node_uid_1)
+            SR.delete_node(node_uid_2)
+            SR.delete_node(folder_uid)
+
+    else:
+        async def testing():
+            async with SaveRestoreAPI_Async(base_url=base_url, timeout=2) as SR:
+                SR.set_auth(username=user_username, password=user_password)
+
+                response = await SR.add_node(SR.ROOT_NODE_UID, name="Test Folder", nodeType="FOLDER")
+                assert response["name"] == "Test Folder"
+                assert response["nodeType"] == "FOLDER"
+                folder_uid = response["uniqueId"]
+
+                response = await SR.add_node(folder_uid, name="Test Config 1", nodeType="CONFIGURATION")
+                assert response["name"] == "Test Config 1"
+                assert response["nodeType"] == "CONFIGURATION"
+                node_uid_1 = response["uniqueId"]
+
+                response = await SR.add_node(folder_uid, name="Test Config 2", nodeType="CONFIGURATION")
+                assert response["name"] == "Test Config 2"
+                assert response["nodeType"] == "CONFIGURATION"
+                node_uid_2 = response["uniqueId"]
+
+                await SR.delete_node(node_uid_1)
+                await SR.delete_node(node_uid_2)
+                await SR.delete_node(folder_uid)
+
+        asyncio.run(testing())
+
+
+# fmt: off
+@pytest.mark.parametrize("library", ["THREADS", "ASYNC"])
+# fmt: on
+def test_delete_nodes_01(clear_sar, library):  # noqa: F811
+    """
+    Tests for the 'add_node' API.
+    """
+    if not _is_async(library):
+        with SaveRestoreAPI_Threads(base_url=base_url, timeout=2) as SR:
+            SR.set_auth(username=user_username, password=user_password)
+
+            response = SR.add_node(SR.ROOT_NODE_UID, name="Test Folder", nodeType="FOLDER")
+            assert response["name"] == "Test Folder"
+            assert response["nodeType"] == "FOLDER"
+            folder_uid = response["uniqueId"]
+
+            response = SR.add_node(folder_uid, name="Test Config 1", nodeType="CONFIGURATION")
+            assert response["name"] == "Test Config 1"
+            assert response["nodeType"] == "CONFIGURATION"
+            node_uid_1 = response["uniqueId"]
+
+            response = SR.add_node(folder_uid, name="Test Config 2", nodeType="CONFIGURATION")
+            assert response["name"] == "Test Config 2"
+            assert response["nodeType"] == "CONFIGURATION"
+            node_uid_2 = response["uniqueId"]
+
+            SR.delete_nodes([node_uid_1, node_uid_2])
+            SR.delete_nodes([folder_uid])
+
+    else:
+        async def testing():
+            async with SaveRestoreAPI_Async(base_url=base_url, timeout=2) as SR:
+                SR.set_auth(username=user_username, password=user_password)
+
+                response = await SR.add_node(SR.ROOT_NODE_UID, name="Test Folder", nodeType="FOLDER")
+                assert response["name"] == "Test Folder"
+                assert response["nodeType"] == "FOLDER"
+                folder_uid = response["uniqueId"]
+
+                response = await SR.add_node(folder_uid, name="Test Config 1", nodeType="CONFIGURATION")
+                assert response["name"] == "Test Config 1"
+                assert response["nodeType"] == "CONFIGURATION"
+                node_uid_1 = response["uniqueId"]
+
+                response = await SR.add_node(folder_uid, name="Test Config 2", nodeType="CONFIGURATION")
+                assert response["name"] == "Test Config 2"
+                assert response["nodeType"] == "CONFIGURATION"
+                node_uid_2 = response["uniqueId"]
+
+                await SR.delete_nodes([node_uid_1, node_uid_2])
+                await SR.delete_nodes([folder_uid])
+
+        asyncio.run(testing())
+
+
+
+
 def test_comm(clear_sar):  # noqa: F811
     SR = SaveRestoreAPI_Threads(base_url=base_url, timeout=2)
     SR.set_auth(username=user_username, password=user_password)