APP-6523: Added optional description parameters to cm/attributedef.creator() methods

Author: Aryamanz29

pyatlan/model/typedef.py

@@ -832,6 +832,7 @@ def create(
         applicable_other_asset_types: Optional[OtherAssetTypes] = None,
         applicable_domains: Optional[Set[str]] = None,
         applicable_domain_types: Optional[DomainTypes] = None,
+        description: Optional[str] = None,
     ) -> AttributeDef:
         from pyatlan.utils import validate_required_fields
 
@@ -847,7 +848,7 @@ def create(
             ),
             is_new=True,
             cardinality=Cardinality.SINGLE,
-            description="",
+            description=description,
             name="",
             include_in_notification=False,
             is_indexable=True,
@@ -1152,7 +1153,9 @@ def with_logo_from_icon(
     )
 
     @staticmethod
-    def create(display_name: str) -> CustomMetadataDef:
+    def create(
+        display_name: str, description: Optional[str] = None
+    ) -> CustomMetadataDef:
         from pyatlan.utils import validate_required_fields
 
         validate_required_fields(
@@ -1164,6 +1167,7 @@ def create(display_name: str) -> CustomMetadataDef:
             category=AtlanTypeCategory.CUSTOM_METADATA,
             display_name=display_name,
             name=display_name,
+            description=description,
         )
 
 

tests/integration/custom_metadata_test.py

@@ -75,6 +75,8 @@
     "Uniqueness",
 ]
 DQ_TYPE_EXTRA_LIST = ["Unknown", "Others"]
+CM_DESCRIPTION = "Automated testing of the Python SDK (cm)."
+ATTRIBUTE_DESCRIPTION = "Automated testing of the Python SDK (attribute)."
 
 _removal_epoch: Optional[int]
 
@@ -88,7 +90,7 @@ def create_custom_metadata(
     icon: Optional[AtlanIcon] = None,
     color: Optional[AtlanTagColor] = None,
 ) -> CustomMetadataDef:
-    cm_def = CustomMetadataDef.create(display_name=name)
+    cm_def = CustomMetadataDef.create(display_name=name, description=CM_DESCRIPTION)
     cm_def.attribute_defs = attribute_defs
     if icon and color:
         cm_def.options = CustomMetadataDef.Options.with_logo_from_icon(
@@ -143,6 +145,7 @@ def cm_ipr(
         AttributeDef.create(
             display_name=CM_ATTR_IPR_LICENSE,
             attribute_type=AtlanCustomAttributePrimitiveType.STRING,
+            description=ATTRIBUTE_DESCRIPTION,
             **limit_attribute_applicability_kwargs,
         ),
         AttributeDef.create(
@@ -175,6 +178,7 @@ def test_cm_ipr(cm_ipr: CustomMetadataDef, limit_attribute_applicability_kwargs)
     assert cm_ipr.guid
     assert cm_ipr.name != cm_name
     assert cm_ipr.display_name == cm_name
+    assert cm_ipr.description == CM_DESCRIPTION
     attributes = cm_ipr.attribute_defs
     assert attributes
     assert len(attributes) == 5
@@ -183,6 +187,7 @@ def test_cm_ipr(cm_ipr: CustomMetadataDef, limit_attribute_applicability_kwargs)
     assert one_with_limited.options
     assert one_with_limited.display_name == CM_ATTR_IPR_LICENSE
     assert one_with_limited.name
+    assert one_with_limited.description == ATTRIBUTE_DESCRIPTION
     assert one_with_limited.name != CM_ATTR_IPR_LICENSE
     assert one_with_limited.type_name == AtlanCustomAttributePrimitiveType.STRING.value
     assert not one_with_limited.options.multi_value_select

tests/unit/test_base_vcr_json.py

@@ -13,7 +13,7 @@ class TestBaseVCRJSON(BaseVCR):
 
     BASE_URL = "https://httpbin.org"
 
-    @pytest.fixture(scope="session")
+    @pytest.fixture(scope="module")
     def vcr_config(self):
         """
         Override the VCR configuration to use JSON serialization across the module.