feat(client): add GAS.update_dataset and deprecate GAS.rename_dataset

Author: edsn60

tensorbay/client/gas.py

@@ -345,6 +345,25 @@ def list_dataset_names(self) -> PagingList[str]:
             lambda offset, limit: self._generate_dataset_names(None, offset, limit), 128
         )
 
+    def update_dataset(
+        self,
+        name: str,
+        *,
+        new_alias: str = ...,  # type: ignore[assignment]
+    ) -> None:
+        """Update a TensorBay Dataset.
+
+        Arguments:
+            name: Name of the dataset, unique for a user.
+            new_alias: New alias of the dataset.
+
+        """
+        dataset_id = self._get_dataset(name)["id"]
+        patch_data = {"name": name}
+        if new_alias is not ...:  # type: ignore[comparison-overlap]
+            patch_data["alias"] = new_alias
+        self._client.open_api_do("PATCH", "", dataset_id, json=patch_data)
+
     def rename_dataset(self, name: str, new_name: str) -> None:
         """Rename a TensorBay Dataset with given name.
 

tensorbay/client/tests/test_gas.py

@@ -321,6 +321,22 @@ def test_list_dataset_names(self, mocker):
         assert list(datasets) == [data["name"] for data in response_data["datasets"]]
         open_api_do.assert_called_once_with("GET", "", params=params)
 
+    def test_update_dataset(self, mocker):
+        response_data = {
+            "id": "123456",
+            "type": 1,
+            "commitId": "4",
+            "defaultBranch": DEFAULT_BRANCH,
+        }
+        open_api_do = mocker.patch(f"{gas.__name__}.Client.open_api_do")
+        mocker.patch(
+            f"{gas.__name__}.GAS._get_dataset",
+            return_value=response_data,
+        )
+        patch_data = {"name": "test", "alias": "new_alias"}
+        self.gas_client.update_dataset("test", new_alias="new_alias")
+        open_api_do.assert_called_once_with("PATCH", "", response_data["id"], json=patch_data)
+
     def test_rename_dataset(self, mocker):
         response_data = {
             "id": "123456",
@@ -334,7 +350,7 @@ def test_rename_dataset(self, mocker):
             return_value=response_data,
         )
         patch_data = {"name": "new_test"}
-        self.gas_client.rename_dataset("test", "new_test")
+        self.gas_client.rename_dataset("test", new_name="new_test")
         open_api_do.assert_called_once_with("PATCH", "", response_data["id"], json=patch_data)
 
     def test_upload_dataset(self, mocker):

tests/test_dataset.py

@@ -148,6 +148,17 @@ def test_get_fusion_dataset_to_latest_commit(self, accesskey, url):
 
         gas_client.delete_dataset(dataset_name)
 
+    def test_update_dataset(self, accesskey, url):
+        gas_client = GAS(access_key=accesskey, url=url)
+        dataset_name = get_dataset_name()
+        gas_client.create_dataset(dataset_name)
+
+        new_dataset_alias = f"{get_dataset_name()}alias"
+        gas_client.update_dataset(name=dataset_name, new_alias=new_dataset_alias)
+        dataset_client = gas_client.get_dataset(dataset_name)
+        assert dataset_client.alias == new_dataset_alias
+        gas_client.delete_dataset(dataset_name)
+
     def test_rename_dataset(self, accesskey, url):
         gas_client = GAS(access_key=accesskey, url=url)
         dataset_name = get_dataset_name()