Adding new method called remove_atlan_tags()

Author: vaibhavatlan

pyatlan/client/asset.py

@@ -1002,6 +1002,48 @@ def update_atlan_tags(
             return assets[0]
         return updated_asset
 
+    @validate_arguments
+    def remove_atlan_tag(
+        self,
+        asset_type: Type[A],
+        qualified_name: str,
+        atlan_tag_name: str,
+    ) -> A:
+        """
+        Removes a single Atlan tag from the provided asset.
+
+        :param asset_type: type of asset to which to add the Atlan tags
+        :param qualified_name: qualified_name of the asset to which to add the Atlan tags
+        :param atlan_tag_name: human-readable name of the Atlan tag to remove from the asset
+        :raises AtlanError: on any API communication issue
+        """
+        from pyatlan.client.atlan import AtlanClient
+
+        client = AtlanClient.get_current_client()
+        name_asset = client.asset.get_by_qualified_name(
+            qualified_name=qualified_name,
+            asset_type=asset_type,
+            ignore_relationships=False,
+        )
+
+        if asset_type in (AtlasGlossaryTerm, AtlasGlossaryCategory):
+            updated_asset = asset_type.updater(
+                qualified_name=qualified_name,
+                name=name_asset.name,
+                glossary_guid=name_asset.anchor.guid,  # type: ignore
+            )
+        else:
+            updated_asset = asset_type.updater(
+                qualified_name=qualified_name, name=name_asset.name
+            )
+
+        atlan_tag = [AtlanTag(type_name=AtlanTagName(display_text=atlan_tag_name))]
+        updated_asset.remove_classifications = atlan_tag
+        response = self.save(entity=updated_asset, append_atlan_tags=True)
+        if assets := response.assets_updated(asset_type=asset_type):
+            return assets[0]
+        return updated_asset
+
     @validate_arguments
     def remove_atlan_tags(
         self,

pyatlan/client/atlan.py

@@ -1339,19 +1339,19 @@ def add_atlan_tags(
 
     @validate_arguments
     def remove_atlan_tag(
-        self, asset_type: Type[A], qualified_name: str, atlan_tag_names: List[str]
+        self, asset_type: Type[A], qualified_name: str, atlan_tag_name: str
     ) -> None:
-        """Deprecated - use asset.remove_atlan_tags() instead."""
+        """Deprecated - use asset.remove_atlan_tag() instead."""
         warn(
-            "This method is deprecated, please use 'asset.remove_atlan_tags' instead, which offers identical "
+            "This method is deprecated, please use 'asset.remove_atlan_tag' instead, which offers identical "
             "functionality.",
             DeprecationWarning,
             stacklevel=2,
         )
-        self.asset.remove_atlan_tags(
+        self.asset.remove_atlan_tag(
             asset_type=asset_type,
             qualified_name=qualified_name,
-            atlan_tag_names=atlan_tag_names,
+            atlan_tag_name=atlan_tag_name,
         )
 
     @validate_arguments

tests/integration/suggestions_test.py

@@ -287,25 +287,25 @@ def create_atlan_tag1(
     assert table1.qualified_name and table3.qualified_name
     assert t1c1.qualified_name and v2c1.qualified_name
     yield make_atlan_tag(ATLAN_TAG_NAME1)
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Table,
         qualified_name=table1.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME1],
+        atlan_tag_name=ATLAN_TAG_NAME1,
     )
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Table,
         qualified_name=table3.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME1],
+        atlan_tag_name=ATLAN_TAG_NAME1,
     )
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Column,
         qualified_name=t1c1.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME1],
+        atlan_tag_name=ATLAN_TAG_NAME1,
     )
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Column,
         qualified_name=v2c1.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME1],
+        atlan_tag_name=ATLAN_TAG_NAME1,
     )
 
 
@@ -324,35 +324,35 @@ def create_atlan_tag2(
     assert t1c1.qualified_name and t2c1.qualified_name
     assert v1c1.qualified_name and v2c1.qualified_name
     yield make_atlan_tag(ATLAN_TAG_NAME2)
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Table,
         qualified_name=table1.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME2],
+        atlan_tag_name=ATLAN_TAG_NAME2,
     )
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Table,
         qualified_name=table3.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME2],
+        atlan_tag_name=ATLAN_TAG_NAME2,
     )
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Column,
         qualified_name=t1c1.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME2],
+        atlan_tag_name=ATLAN_TAG_NAME2,
     )
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Column,
         qualified_name=v1c1.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME2],
+        atlan_tag_name=ATLAN_TAG_NAME2,
     )
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Column,
         qualified_name=t2c1.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME2],
+        atlan_tag_name=ATLAN_TAG_NAME2,
     )
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Column,
         qualified_name=v2c1.qualified_name,
-        atlan_tag_names=[ATLAN_TAG_NAME2],
+        atlan_tag_name=ATLAN_TAG_NAME2,
     )
 
 

tests/integration/test_client.py

@@ -812,8 +812,8 @@ def test_update_classification(client: AtlanClient, term1: AtlasGlossaryTerm):
 @pytest.mark.order(after="test_update_classification")
 def test_remove_classification(client: AtlanClient, term1: AtlasGlossaryTerm):
     assert term1.qualified_name
-    client.asset.remove_atlan_tags(
-        AtlasGlossaryTerm, term1.qualified_name, [CLASSIFICATION_NAME]
+    client.asset.remove_atlan_tag(
+        AtlasGlossaryTerm, term1.qualified_name, CLASSIFICATION_NAME
     )
     glossary_term = client.asset.get_by_guid(
         term1.guid, asset_type=AtlasGlossaryTerm, ignore_relationships=False

tests/integration/test_task_client.py

@@ -50,10 +50,10 @@ def snowflake_column(
     )
     yield snowflake_column
 
-    client.asset.remove_atlan_tags(
+    client.asset.remove_atlan_tag(
         asset_type=Column,
         qualified_name=snowflake_column_qn,
-        atlan_tag_names=[TAG_NAME],
+        atlan_tag_name=TAG_NAME,
     )
 
 

tests/unit/constants.py

@@ -115,6 +115,14 @@
         ([AtlasGlossary, "qn", [int]], "atlan_tag_names -> 0\n  str type expected"),
         ([AtlasGlossary, "qn", None], "none is not an allowed value"),
     ],
+    "remove_atlan_tag": [
+        (["asset-type", [123], "tag-name"], "name\n  str type expected"),
+        (["asset-type", None, "tag-name"], "none is not an allowed value"),
+        ([None, "qn", "tag-name"], "none is not an allowed value"),
+        (["asset-type", "qn", "tag-name"], "asset_type\n  a class is expected"),
+        ([AtlasGlossary, "qn", [123]], "atlan_tag_name\n  str type expected"),
+        ([AtlasGlossary, "qn", None], "none is not an allowed value"),
+    ],
     "remove_atlan_tags": [
         (["asset-type", [123], ["tag-name"]], "name\n  str type expected"),
         (["asset-type", None, ["tag-name"]], "none is not an allowed value"),

tests/unit/test_deprecated.py

@@ -478,11 +478,11 @@ def test_get_user_by_username(mock_type_def_client, client: AtlanClient):
         ),
         (
             "remove_atlan_tag",
-            "remove_atlan_tags",
+            "remove_atlan_tag",
             {
                 "asset_type": AtlasGlossary,
                 "qualified_name": "qname",
-                "atlan_tag_names": ["Something"],
+                "atlan_tag_name": "Something",
             },
         ),
         (