Merge pull request #37 from atlanhq/update_crud

Make minor changes found when updating documentation

Author: ErnestoLoma

pyatlan/HISTORY.md HISTORY.md

@@ -1,6 +1,14 @@
+## 0.0.21 (Apr 11, 2023)
+
+* Added relation_attributes parameter to IndexSearchRequest to specify the attributes to be included in each relationship that is included in the results of the search
+* Set assets to empty list when no entities are returned by search
+* Add classmethod ref_by_guid to Referencable
+* Add classmethod ref_by_qualified_name to Referencable
+
 ## 0.0.20 (Apr 5, 2023)
 
 * Corrected issue with from, size and track_total_hits in DSL object not being sent to server if the defaults weren't changed
+* Added relation_attributes parameter to IndexSearchRequest to specify the attributes to be included in each relationship that is included in the results of the search
 
 ## 0.0.19 (Mar 30, 2023)
 

pyatlan/client/atlan.py

@@ -156,6 +156,7 @@ def _get_next_page(self):
                 request_obj=self._criteria,
             )
             if "entities" not in raw_json:
+                self._assets = []
                 return False
             self._assets = parse_obj_as(list[Asset], raw_json["entities"])
             return True
@@ -320,7 +321,7 @@ def get_asset_by_qualified_name(
             return asset
         except AtlanError as ae:
             if ae.status_code == HTTPStatus.NOT_FOUND:
-                raise NotFoundError(message=ae.user_message, code=ae.code)
+                raise NotFoundError(message=ae.user_message, code=ae.code) from ae
             raise ae
 
     @validate_arguments()
@@ -341,9 +342,13 @@ def get_asset_by_guid(
                 GET_ENTITY_BY_GUID.format_path_with_params(guid),
                 query_params,
             )
-            raw_json["entity"]["attributes"].update(
-                raw_json["entity"]["relationshipAttributes"]
-            )
+            if (
+                "relationshipAttributes" in raw_json["entity"]
+                and raw_json["entity"]["relationshipAttributes"]
+            ):
+                raw_json["entity"]["attributes"].update(
+                    raw_json["entity"]["relationshipAttributes"]
+                )
             raw_json["entity"]["relationshipAttributes"] = {}
             asset = AssetResponse[A](**raw_json).entity
             asset.is_incomplete = False
@@ -355,9 +360,18 @@ def get_asset_by_guid(
             return asset
         except AtlanError as ae:
             if ae.status_code == HTTPStatus.NOT_FOUND:
-                raise NotFoundError(message=ae.user_message, code=ae.code)
+                raise NotFoundError(message=ae.user_message, code=ae.code) from ae
             raise ae
 
+    @validate_arguments()
+    def retrieve_minimal(self, guid: str, asset_type: Type[A]) -> A:
+        return self.get_asset_by_guid(
+            guid=guid,
+            asset_type=asset_type,
+            min_ext_info=True,
+            ignore_relationships=True,
+        )
+
     def upsert(
         self,
         entity: Union[Asset, list[Asset]],
@@ -387,6 +401,13 @@ def purge_entity_by_guid(self, guid) -> AssetMutationResponse:
         )
         return AssetMutationResponse(**raw_json)
 
+    def delete_entity_by_guid(self, guid) -> AssetMutationResponse:
+        raw_json = self._call_api(
+            DELETE_ENTITY_BY_GUID.format_path_with_params(guid),
+            {"deleteType": AtlanDeleteType.SOFT.value},
+        )
+        return AssetMutationResponse(**raw_json)
+
     def search(self, criteria: IndexSearchRequest) -> SearchResults:
         raw_json = self._call_api(
             INDEX_SEARCH,
@@ -419,7 +440,6 @@ def get_typedefs(self, type_category: AtlanTypeCategory) -> TypeDefResponse:
         return TypeDefResponse(**raw_json)
 
     def create_typedef(self, typedef: TypeDef) -> TypeDefResponse:
-        payload = None
         if isinstance(typedef, ClassificationDef):
             # Set up the request payload...
             payload = TypeDefResponse(
@@ -463,15 +483,15 @@ def add_classifications(
         classification_names: list[str],
         propagate: bool = True,
         remove_propagation_on_delete: bool = True,
-        restrict_lineage_propogation: bool = True,
+        restrict_lineage_propagation: bool = True,
     ) -> None:
         classifications = Classifications(
             __root__=[
                 Classification(
                     type_name=ClassificationName(display_text=name),
                     propagate=propagate,
                     remove_propagations_on_entity_delete=remove_propagation_on_delete,
-                    restrict_propagation_through_lineage=restrict_lineage_propogation,
+                    restrict_propagation_through_lineage=restrict_lineage_propagation,
                 )
                 for name in classification_names
             ]
@@ -528,11 +548,9 @@ def _update_asset_by_attribute(self, asset, asset_type, qualified_name: str):
             AssetRequest[Asset](entity=asset),
         )
         response = AssetMutationResponse(**raw_json)
-        assets = response.assets_partially_updated(asset_type=asset_type)
-        if assets:
+        if assets := response.assets_partially_updated(asset_type=asset_type):
             return assets[0]
-        assets = response.assets_updated(asset_type=asset_type)
-        if assets:
+        if assets := response.assets_updated(asset_type=asset_type):
             return assets[0]
         return None