pyegeria 5.4.0.23__py3-none-any.whl → 5.4.0.25__py3-none-any.whl

pyegeria/_client_new.py

@@ -35,7 +35,7 @@ from pyegeria._validators import (
     )
 from pyegeria.models import SearchStringRequestBody, FilterRequestBody, GetRequestBody, NewElementRequestBody, \
     TemplateRequestBody, UpdateStatusRequestBody, UpdateElementRequestBody, NewRelationshipRequestBody, \
-    DeleteRequestBody, UpdateRelationshipRequestBody, ResultsRequestBody
+    DeleteRequestBody, UpdateRelationshipRequestBody, ResultsRequestBody, NewClassificationRequestBody
 from pyegeria.utils import body_slimmer
 
 ...
@@ -146,6 +146,7 @@ class Client2:
         self._update_element_request_adapter = TypeAdapter(UpdateElementRequestBody)
         self._update_status_request_adapter = TypeAdapter(UpdateStatusRequestBody)
         self._new_relationship_request_adapter = TypeAdapter(NewRelationshipRequestBody)
+        self._new_classification_request_adapter = TypeAdapter(NewClassificationRequestBody)
         self._delete_request_adapter = TypeAdapter(DeleteRequestBody)
         self._template_request_adapter = TypeAdapter(TemplateRequestBody)
         self._update_relationship_request_adapter = TypeAdapter(UpdateRelationshipRequestBody)
@@ -476,7 +477,8 @@ class Client2:
         except (HTTPStatusError, httpx.HTTPStatusError, httpx.RequestError) as e:
             # context["caught_exception"] = e
             # context['HTTPStatusCode'] = e.response.status_code
-            additional_info = {"userid": self.user_id}
+            additional_info = {"userid": self.user_id, "reason": response.text}
+
             raise PyegeriaClientException(response, context, additional_info, e)
         #
         # except json.JSONDecodeError as e:
@@ -754,9 +756,21 @@ class Client2:
             return None
         return validated_body
 
+    def validate_new_element_from_template_request(self, body: dict | TemplateRequestBody
+                                     ) -> NewElementRequestBody | None:
+        if isinstance(body, TemplateRequestBody):
+            validated_body = body
+
+        elif isinstance(body, dict):
+            # if body.get("properties", {}).get("class", "") == prop:
+            validated_body = self._template_request_adapter.validate_python(body)
+        else:
+            return None
+        return validated_body
+
     def validate_new_relationship_request(self, body: dict | NewRelationshipRequestBody,
                                           prop: str = None) -> NewRelationshipRequestBody | None:
-        if isinstance(body, NewElementRequestBody):
+        if isinstance(body, NewRelationshipRequestBody):
             if (prop and body.properties.class_ == prop) or (prop is None):
                 validated_body = body
             else:
@@ -774,6 +788,26 @@ class Client2:
 
         return validated_body
 
+    def validate_new_classification_request(self, body: dict | NewClassificationRequestBody,
+                                          prop: str = None) -> NewClassificationRequestBody | None:
+        if isinstance(body, NewClassificationRequestBody):
+            if (prop and body.properties.class_ == prop) or (prop is None):
+                validated_body = body
+            else:
+                raise PyegeriaInvalidParameterException(additional_info=
+                                                        {"reason": "unexpected property class name"})
+
+        elif isinstance(body, dict):
+            if body.get("properties", {}).get("class", "") == prop:
+                validated_body = self._new_classification_request_adapter.validate_python(body)
+            else:
+                raise PyegeriaInvalidParameterException(additional_info=
+                                                        {"reason": "unexpected property class name"})
+        else:
+            return None
+
+        return validated_body
+
     def validate_delete_request(self, body: dict | DeleteRequestBody,
                                 cascade_delete: bool = False) -> DeleteRequestBody | None:
         if isinstance(body, DeleteRequestBody):
@@ -818,9 +852,9 @@ class Client2:
         elif status:
             body = {
                 "class": "UpdateStatusRequestBody",
-                "status": status
+                "newStatus": status
                 }
-            validated_body = UpdateStatusRequestBody.validate_python(body)
+            validated_body = UpdateStatusRequestBody.model_validate(body)
         else:
             raise PyegeriaInvalidParameterException(additional_info={"reason": "invalid parameters"})
 
@@ -938,11 +972,11 @@ class Client2:
         else:
             body = {
                 "class": "GetRequestBody",
-
+                "metadataElementTypeName": _type
                 }
             validated_body = GetRequestBody.model_validate(body)
 
-        json_body = validated_body.model_dump_json(indent=2)
+        json_body = validated_body.model_dump_json(indent=2, exclude_none=True)
 
         response = await self._async_make_request("POST", url, json_body)
         elements = response.json().get("element", NO_ELEMENTS_FOUND)
@@ -971,7 +1005,7 @@ class Client2:
                 }
             validated_body = ResultsRequestBody.model_validate(body)
 
-        json_body = validated_body.model_dump_json(indent=2)
+        json_body = validated_body.model_dump_json(indent=2, exclude_none=True)
 
         response = await self._async_make_request("POST", url, json_body)
         elements = response.json().get("elements", None)
@@ -995,7 +1029,15 @@ class Client2:
         logger.info(json_body)
         response = await self._async_make_request("POST", url, json_body)
         logger.info(response.json())
-        return response.json().get("guid")
+        return response.json().get("guid", "NO_GUID_RETURNED")
+
+    async def _async_create_element_from_template(self, url: str, body: dict | TemplateRequestBody = None) -> str:
+        validated_body = self.validate_new_element_from_template_request(body)
+        json_body = validated_body.model_dump_json(indent=2, exclude_none=True)
+        logger.info(json_body)
+        response = await self._async_make_request("POST", url, json_body, is_json=True)
+        logger.info(response.json())
+        return response.json().get("guid", "NO_GUID_RETURNED")
 
     async def _async_update_element_body_request(self, url: str, prop: list[str],
                                                  body: dict | UpdateElementRequestBody = None) -> None:
@@ -1023,6 +1065,16 @@ class Client2:
         else:
             await self._async_make_request("POST", url)
 
+    async def _async_new_classification_request(self, url: str, prop: str,
+                                              body: dict | NewRelationshipRequestBody = None) -> None:
+        validated_body = self.validate_new_classification_request(body, prop)
+        if validated_body:
+            json_body = validated_body.model_dump_json(indent=2, exclude_none=True)
+            logger.info(json_body)
+            await self._async_make_request("POST", url, json_body)
+        else:
+            await self._async_make_request("POST", url)
+
     async def _async_delete_request(self, url: str, body: dict | DeleteRequestBody = None,
                                     cascade_delete: bool = False) -> None:
         validated_body = self.validate_delete_request(body, cascade_delete)
@@ -1034,9 +1086,6 @@ class Client2:
             await self._async_make_request("POST", url)
 
 
-
-
-
     async def _async_update_relationship_request(self, url: str, prop: str,
                                               body: dict | UpdateRelationshipRequestBody = None) -> None:
         validated_body = self.validate_update_relationship_request(body, prop)

pyegeria/_exceptions_new.py

@@ -374,6 +374,11 @@ def print_exception_table(e: PyegeriaException):
 def print_basic_exception(e: PyegeriaException):
     """Prints the exception response"""
     related_code = e.related_http_code if hasattr(e, "related_http_code") else ""
+    http_reason = e.response.text if e.response else ""
+    table = Table(title=f"Exception: {e.__class__.__name__}", show_lines=True, header_style="bold", box=box.HEAVY_HEAD)
+    table.caption = e.pyegeria_code
+    table.add_column("Facet", justify="center")
+    table.add_column("Item", justify="left", width=80)
     related_response = e.response.json() if e.response else ""
     table = Table(title=f"Exception: {e.__class__.__name__}", show_lines=True, header_style="bold", box=box.HEAVY_HEAD)
     table.caption = e.pyegeria_code
@@ -382,6 +387,7 @@ def print_basic_exception(e: PyegeriaException):
 
     if isinstance(e, PyegeriaException):
         table.add_row("HTTP Code", str(e.response_code))
+        table.add_row("HTTP Reason", str(http_reason))
         table.add_row("Egeria Code", str(related_code))
         table.add_row("Caller Method", e.context.get("caller method", "---")) if e.context else ""
         table.add_row("Request URL", str(e.response_url))

pyegeria/_output_formats.py

@@ -143,6 +143,14 @@ COLLECTION_DICT = Format(
         ],
 )
 
+BASIC_COLLECTIONS_COLUMNS = [
+    Column(name='Qualified Name', key='qualified_name', format=True),
+    Column(name='GUID', key='guid', format=True),
+    Column(name='Type Name', key='type_name'),
+    Column(name="Containing Members", key='collection_members'),
+    Column(name="Member Of", key='member_of_collections')
+]
+
 COLLECTION_REPORT = Format(
     types=["REPORT"],
     columns=COLLECTIONS_MEMBERS_COLUMNS + [
@@ -163,7 +171,11 @@ GOVERNANCE_DEFINITIONS_COLUMNS = COMMON_COLUMNS + [
     Column(name="Scope", key='scope'),
     Column(name="Type", key='type_name'),
     ]
-
+GOVERNANCE_DEFINITIONS_BASIC =  [
+    Column(name="Type", key='type_name'),
+    Column(name='Qualified Name', key='qualified_name', format=True),
+    Column(name="GUID", key='guid', format=True),
+    ]
 COMMON_ANNOTATIONS = {
     "wikilinks": ["[[Commons]]"]
 }
@@ -235,6 +247,8 @@ output_format_sets = FormatSetDict({
                     Column(name="Effective To", key='effective_to'),
                     Column(name="GUID", key='guid'),
                     Column(name="Open Metadata Type Name", key='type_name'),
+                    Column(name="Glossary", key='parent_glossary'),
+                    Column(name="Subject Aream", key='subject_area'),
                 ],
             )
             ]
@@ -253,6 +267,21 @@ output_format_sets = FormatSetDict({
             spec_params={},
         )
     ),
+    "BasicCollections": FormatSet(
+        heading="Common Collection Information",
+        description="Attributes generic to all Collections.",
+        aliases=[],
+        annotations=COMMON_ANNOTATIONS,
+        formats=[Format(
+            types=["ALL"],
+            columns=BASIC_COLLECTIONS_COLUMNS,
+            )],  # Reusing common formats
+        action=ActionParameter(
+            function="CollectionManager.find_collections",
+            user_params=["search_string"],
+            spec_params={},
+            )
+        ),
 
     "CollectionMembers": FormatSet(
         heading="Collection Membership Information",
@@ -406,7 +435,18 @@ output_format_sets = FormatSetDict({
             spec_params={"output_format":"DICT"},
         )
     ),
-
+    "Governance Basics": FormatSet(
+        heading="Basic Governance-Definitions Information",
+        description="Core Attributes useful to Governance-Definitions.",
+        aliases=["BasicGovernance"],
+        annotations={"wikilinks": ["[[Governance]]"]},
+        formats=[Format(types=["ALL"], columns=GOVERNANCE_DEFINITIONS_BASIC)],
+        action=ActionParameter(
+            function="GovernanceOfficer.find_governance_definitions",
+            user_params=["search_string"],
+            spec_params={},
+            )
+    ),
     "Governance Definitions": FormatSet(
         heading="Governance-Definitions Information",
         description="Attributes useful to Governance-Definitions.",

pyegeria/collection_manager.py

@@ -672,7 +672,7 @@ class CollectionManager(Client2):
         ----
         Body sample:
         {
-          "class": "AnyTimeRequestBody",
+          "class": "GetRequestBody",
           "asOfTime": "{{$isoTimestamp}}",
           "effectiveTime": "{{$isoTimestamp}}",
           "forLineage": false,
@@ -680,7 +680,7 @@ class CollectionManager(Client2):
         }
         """
 
-        url = str(HttpUrl(f"{self.collection_command_root}/{collection_guid}"))
+        url = str(HttpUrl(f"{self.collection_command_root}/{collection_guid}/retrieve"))
         type = element_type if element_type else "Collection"
 
         response = await self._async_get_guid_request(url, _type=type,
@@ -1414,6 +1414,26 @@ class CollectionManager(Client2):
             self._async_create_collection(display_name, description, category,
                                           ["ContextEvent"], body))
 
+    @dynamic_catch
+    def create_glossary_category(self, display_name: str, parent_guid: str, description: str = None ) -> str:
+        """Create a new glossary category."""
+        body = {
+            "class": "NewRelationshipRequestBody",
+            "parentGUID": parent_guid,
+            "parentRelationshipTypeName": "CategoryHierarchy",
+            "parentAtEnd1": True,
+            "is_own_anchor": False,
+            "anchor_guid": parent_guid,
+            "properties": {
+                "class": "GlossaryCategoryProperties",
+                "displayName": display_name,
+                "description": description,
+                "parentCategory": parent_guid,
+                },
+            }
+        response = self.create_collection(body=body)
+        return response
+
     @dynamic_catch
     async def _async_create_data_spec_collection(self, display_name: str = None, description: str = None,
                                                 category: str = None, classification_name: str = None,
@@ -1520,15 +1540,16 @@ class CollectionManager(Client2):
         }
 
         """
-        validated_body = self.validate_new_element_request(body,"DataSpecProperties")
-
-        if validated_body is None and display_name is not None:
+        if body:
+            validated_body = self.validate_new_element_request(body,"DataSpecProperties")
+        elif display_name is not None:
             qualified_name = self.__create_qualified_name__("DataSpec", display_name, EGERIA_LOCAL_QUALIFIER)
-            print(f"\n\tDisplayName was {display_name}, classification {classification_name}\n")
-            initial_classifications_data = {"class" : "ClassificationProperties"}
+            logger.info(f"\n\tDisplayName was {display_name}, classification {classification_name}\n")
             if classification_name:
-                initial_classification_dict = {
-                    classification_name: InitialClassifications.model_validate(initial_classifications_data)
+                initial_classification_data = {
+                    classification_name: {
+                    "class" : "ClassificationProperties"
+                    }
                 }
             else:
                 initial_classification_dict = None
@@ -2398,12 +2419,11 @@ class CollectionManager(Client2):
         """
 
         url = (f"{self.collection_command_root}/{collection_guid}/update")
-        await self._async_update_element_request_body(url, "DigitalProductProperties", body )
+        await self._async_update_element_body_request(url, "DigitalProductProperties", body )
 
 
     @dynamic_catch
-    def update_digital_product(self, collection_guid: str,  body: dict | UpdateElementRequestBody,
-                                       merge_update: bool = True) -> None:
+    def update_digital_product(self, collection_guid: str,  body: dict | UpdateElementRequestBody,) -> None:
         """ Update the properties of a digital product..
             Collections: https://egeria-project.org/concepts/collection
 
@@ -2467,7 +2487,7 @@ class CollectionManager(Client2):
         """
 
         return asyncio.get_event_loop().run_until_complete(
-            self._async_update_digital_product(collection_guid, body, merge_update))
+            self._async_update_digital_product(collection_guid, body))
 
 
     @dynamic_catch
@@ -2512,7 +2532,7 @@ class CollectionManager(Client2):
         }
         """
 
-        url = f"{self.collection_command_root}/{collection_guid}/update-status"
+        url = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/collection-manager/metadata-elements/{collection_guid}/update-status"
         await self._async_update_status_request(url, status, body)
 
     @dynamic_catch
@@ -5071,6 +5091,12 @@ class CollectionManager(Client2):
         loop = asyncio.get_event_loop()
         loop.run_until_complete(self._async_add_to_collection(collection_guid, element_guid, body))
 
+    def add_term_to_category(self, category_guid: str, term_guid: str,
+                             body: dict | NewRelationshipRequestBody = None) -> None:
+        """Add a term to a category.  The request body is optional."""
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(self._async_add_to_collection(category_guid, term_guid, body))
+
 
     @dynamic_catch
     async def _async_update_collection_membership_prop(self, collection_guid: str, element_guid: str, body: dict = None,
@@ -5296,6 +5322,45 @@ class CollectionManager(Client2):
         #
 
 
+    def remove_term_from_category(self, category_guid: str, term_guid: str,
+                               body: dict | DeleteRequestBody= None) -> None:
+        """Remove a term from a category.
+
+        Parameters
+        ----------
+        category_guid: str
+            identity of the collection to return members for.
+        term_guid: str
+            Effective time of the query. If not specified will default to any time.
+        body: dict, optional, defaults to None
+            The body of the request to add to the collection. See notes.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+
+        InvalidParameterException
+          If the client passes incorrect parameters on the request - such as bad URLs or invalid values
+        PropertyServerException
+          Raised by the server when an issue arises in processing a valid request
+        NotAuthorizedException
+          The principle specified by the user_id does not have authorization for the requested action
+
+        Notes
+        -----
+
+        """
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(self._async_remove_from_collection(category_guid, term_guid, body))
+
+        #
+        #
+        #
+
+
     @dynamic_catch
     async def _async_get_member_list(self, collection_guid: str = None, collection_name: str = None,
                                      collection_qname: str = None, ) -> list | str: