pyegeria 5.4.8.2__py3-none-any.whl → 5.4.8.3__py3-none-any.whl

pyegeria/_client_new.py

@@ -12,6 +12,7 @@ import os
 import re
 import time
 from collections.abc import Callable
+from datetime import datetime
 from typing import Any
 
 from httpx import Response
@@ -536,7 +537,7 @@ class Client2(BaseClient):
 
     async def _async_get_guid_for_name(
             self, name: str, property_name: list[str] = ["qualifiedName", "displayName"],
-            type_name: str = "ValidMetadataValue"
+            type_name: str = None
 
     ) -> list | str:
         """
@@ -570,6 +571,8 @@ class Client2(BaseClient):
                 raise PyegeriaException(context={"issue": "Multiple elements found for supplied name!"})
             elif len(elements) == 1:
                 return elements[0]["elementHeader"]["guid"]
+        else:
+            return NO_ELEMENTS_FOUND
         return elements
 
     def get_guid_for_name(
@@ -1687,7 +1690,7 @@ class Client2(BaseClient):
     @dynamic_catch
     async def _async_create_note_log(
             self,
-            element_guid: str,
+            element_guid: str = None,
             display_name: str = None,
             description: str = None,
             body: dict = None,
@@ -1697,8 +1700,8 @@ class Client2(BaseClient):
 
         Parameters
         ----------
-        element_guid: str
-            - unique identifier of the element where the note log is located
+        element_guid: str, optional
+            - unique identifier of the element where the note log is attached
         display_name: str, optional
             - name of the note log
         description: str, optional
@@ -1752,14 +1755,17 @@ class Client2(BaseClient):
             context = {"issue": "Invalid display name and body not provided"}
             raise PyegeriaInvalidParameterException(context=context)
 
-        url = f"{self.command_root}feedback-manager/elements/{element_guid}/note-logs"
+        if element_guid:
+            url = f"{self.command_root}feedback-manager/elements/{element_guid}/note-logs"
+        else:
+            url = f"{self.command_root}feedback-manager/elements/note-logs"
         response = await self._async_make_request("POST", url, body_slimmer(body))
         return response.json()
 
     @dynamic_catch
     def create_note_log(
             self,
-            element_guid: str,
+            element_guid: str = None,
             display_name: str = None,
             description: str = None,
             body: dict = None,
@@ -1769,8 +1775,8 @@ class Client2(BaseClient):
 
         Parameters
         ----------
-        element_guid
-            - unique identifier of the element where the note log is located
+        element_guid, str, optional
+            - unique identifier of the element where the note log is attached
         display_name: str, optional
             - name of the note log
         description: str, optional
@@ -1981,7 +1987,7 @@ class Client2(BaseClient):
 
         """
 
-        url = f"{self.command_root}feedback-manager/elements/{note_log_guid}/remove"
+        url = f"{self.command_root}feedback-manager/note-logs/{note_log_guid}/remove"
         await self._async_delete_element_request(url, body, cascade_delete)
 
     @dynamic_catch
@@ -2090,7 +2096,7 @@ class Client2(BaseClient):
 
         url = f"{self.command_root}feedback-manager/note-logs/by-search-string"
         response = await self._async_find_request(url, _type="NoteLog",
-                                                  _gen_output=self._generate_note_log_output,
+                                                  _gen_output=self._generate_feedback_output,
                                                   search_string=search_string,
                                                   classification_names=classification_names,
                                                   metadata_element_types=metadata_element_types,
@@ -2162,7 +2168,7 @@ class Client2(BaseClient):
         return resp
 
     @dynamic_catch
-    async def _async_get_note_logs_by_gname(
+    async def _async_get_note_logs_by_name(
             self, filter: str,
             element_type: str = "NoteLog",
             body: dict | FilterRequestBody = None,
@@ -2194,7 +2200,7 @@ class Client2(BaseClient):
 
         url = f"{self.command_root}feedback-manager/note-logs/by-name"
         response = await self._async_get_name_request(url, _type=element_type,
-                                                      _gen_output=self._generate_note_log_output, start_from=start_from,
+                                                      _gen_output=self._generate_feedback_output, start_from=start_from,
                                                       page_size=page_size, output_format=output_format,
                                                       report_spec=report_spec,
                                                       body=body)
@@ -2233,7 +2239,7 @@ class Client2(BaseClient):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_note_log_by_name(filter, element_type, body, output_format, report_spec, start_from,
+            self._async_get_note_logs_by_name(filter, element_type, body, output_format, report_spec, start_from,
                                              page_size)
         )
         return response
@@ -2281,7 +2287,7 @@ class Client2(BaseClient):
         if element == NO_ELEMENTS_FOUND:
             return NO_ELEMENTS_FOUND
         if output_format != 'JSON':  # return a simplified markdown representation
-            return self._generate_note_log_output(element, None, output_format, report_spec)
+            return self._generate_feedback_output(element, None, output_format, report_spec)
         return response.json().get("elements", NO_ELEMENTS_FOUND)
 
     @dynamic_catch
@@ -2498,6 +2504,183 @@ class Client2(BaseClient):
         )
         return response
 
+    @dynamic_catch
+    async def _async_add_journal_entry(self, note_log_qn: str = None, element_qn: str =  None, note_log_display_name: str = None, journal_entry_display_name: str = None, journal_entry_description: str = None,
+                                body: dict | NewElementRequestBody = None ) -> str:
+        """
+        Creates a new journal entry for a note log and returns the unique identifier for it. The note_log will be
+        created if it does not exist. Async version.
+
+        Parameters
+        ----------
+        note_log_qn: str = None
+            - If provided, the journal entry will be attached to this note log. If not provided, a new note_log will be created.
+        element_qn: str = None
+            - If provided, and note log needs to be created, this will be used to define the new note log and attach it
+             to the specified element.
+        note_log_display_name: str = None
+            - optional note log display name
+        journal_entry_display_name: str = None
+            - optional journal entry display name
+        journal_entry_description: str = None
+            - the journal entry text
+
+        body
+            - optional body for the note - if provided, details here will supercede other parameters.
+
+        Returns
+        -------
+        GUID for the journal entry (note).
+
+        Raises
+        ------
+        PyegeriaException
+
+        Notes
+        _____
+
+        Sample body (a note is an asset)
+        {
+          "class" : "NewElementRequestBody",
+          "anchorGUID" : "{{noteLogGUID}}",
+          "isOwnAnchor": false,
+          "parentGUID": "{{noteLogGUID}}",
+          "parentRelationshipTypeName": "AttachedNoteLogEntry",
+          "parentAtEnd1": true,
+          "properties": {
+            "class" : "NotificationProperties",
+            "typeName" : "Notification",
+            "qualifiedName": "add unique name here",
+            "displayName": "add short name here",
+            "description": "add description here",
+            "systemAction" : "add optional system action that occurred as part of this notification processing",
+            "userResponse" : "add optional action that the reader should take",
+            "priority" : 1,
+            "activityStatus" : "FOR_INFO",
+            "additionalProperties": {
+              "property1" : "propertyValue1",
+              "property2" : "propertyValue2"
+            },
+            "extendedProperties": {
+              "property1" : "propertyValue1",
+              "property2" : "propertyValue2"
+            },
+            "effectiveFrom": "{{$isoTimestamp}}",
+            "effectiveTo": "{{$isoTimestamp}}"
+          },
+          "externalSourceGUID": "add guid here",
+          "externalSourceName": "add qualified name here",
+          "effectiveTime" : "{{$isoTimestamp}}",
+          "forLineage" : false,
+          "forDuplicateProcessing" : false
+        }
+
+        """
+        note_log_guid = None
+        element_guid = None
+        # If a note_log_qn has been provided, look up its GUID
+        if note_log_qn:
+            note_log_guid = await self._async_get_guid_for_name(note_log_qn, ["qualifiedName"],'NoteLog' ) if note_log_qn else None
+
+        # If we need to create a new note_log, then use the qualified name from the element_qn parameter, if provided.
+        if note_log_guid is None or note_log_guid == NO_ELEMENTS_FOUND:
+            if element_qn is None:
+                if note_log_display_name is None:
+                    note_log_display_name = f"NoName-{datetime.now().strftime('%Y-%m-%d %H:%M')}"
+
+            else:
+                element_guid = await self._async_get_guid_for_name(element_qn, ["qualifiedName"])
+
+            note_log = await self._async_create_note_log(element_guid = element_guid, display_name = note_log_display_name)
+            note_log_guid = note_log["guid"]
+
+        # Create the Journal Entry (Note)
+        journal_entry_guid = await self._async_create_note(note_log_guid, journal_entry_display_name,
+                                                                 journal_entry_description, body)
+
+        return journal_entry_guid
+
+    @dynamic_catch
+    def add_journal_entry(self, note_log_qn: str = None, element_qn: str = None,
+                           note_log_display_name: str = None, journal_entry_display_name: str = None,
+                           journal_entry_description: str = None,
+                           body: dict | NewElementRequestBody = None) -> str:
+        """
+        Creates a new journal entry for a note log and returns the unique identifier for it. The note_log will be
+        created if it does not exist.
+
+        Parameters
+        ----------
+        note_log_qn: str = None
+            - If provided, the journal entry will be attached to this note log. If not provided, a new note_log will be created.
+        element_qn: str = None
+            - If provided, and note log needs to be created, this will be used to define the new note log and attach it
+             to the specified element.
+        note_log_display_name: str = None
+            - optional note log display name
+        journal_entry_display_name: str = None
+            - optional journal entry display name
+        journal_entry_description: str = None
+            - the journal entry text
+
+        body
+            - optional body for the note - if provided, details here will supercede other parameters.
+
+        Returns
+        -------
+        GUID for the journal entry (note).
+
+        Raises
+        ------
+        PyegeriaException
+
+        Notes
+        _____
+
+        Sample body (a note is an asset)
+        {
+          "class" : "NewElementRequestBody",
+          "anchorGUID" : "{{noteLogGUID}}",
+          "isOwnAnchor": false,
+          "parentGUID": "{{noteLogGUID}}",
+          "parentRelationshipTypeName": "AttachedNoteLogEntry",
+          "parentAtEnd1": true,
+          "properties": {
+            "class" : "NotificationProperties",
+            "typeName" : "Notification",
+            "qualifiedName": "add unique name here",
+            "displayName": "add short name here",
+            "description": "add description here",
+            "systemAction" : "add optional system action that occurred as part of this notification processing",
+            "userResponse" : "add optional action that the reader should take",
+            "priority" : 1,
+            "activityStatus" : "FOR_INFO",
+            "additionalProperties": {
+              "property1" : "propertyValue1",
+              "property2" : "propertyValue2"
+            },
+            "extendedProperties": {
+              "property1" : "propertyValue1",
+              "property2" : "propertyValue2"
+            },
+            "effectiveFrom": "{{$isoTimestamp}}",
+            "effectiveTo": "{{$isoTimestamp}}"
+          },
+          "externalSourceGUID": "add guid here",
+          "externalSourceName": "add qualified name here",
+          "effectiveTime" : "{{$isoTimestamp}}",
+          "forLineage" : false,
+          "forDuplicateProcessing" : false
+        }
+
+        """
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_add_journal_entry(note_log_qn, element_qn, note_log_display_name, journal_entry_display_name, journal_entry_description, body)
+        )
+        return response
+
+
     @dynamic_catch
     async def _async_update_note(self, note_guid: str, display_name: str = None, description: str = None,
                                  body: dict | UpdateElementRequestBody = None, merge_update: bool = True) -> None:
@@ -2767,19 +2950,19 @@ class Client2(BaseClient):
 
         url = f"{self.command_root}feedback-manager/assets/by-search-string"
         response = await self._async_find_request(url, "Notification", self._generate_feedback_output,
-                                                  search_string, [], ["Notification"],
+                                                  search_string, None, ["Notification"] ,
                                                   starts_with, ends_with, ignore_case,
                                                   start_from, page_size, output_format, report_spec,
-                                                  body, )
+                                                  body )
         return response
 
     @dynamic_catch
     def find_notes(
             self, search_string: str = None,
             body: dict | SearchStringRequestBody = None,
-            starts_with: bool = None,
-            ends_with: bool = None,
-            ignore_case: bool = None,
+            starts_with: bool = True,
+            ends_with: bool = False,
+            ignore_case: bool = False,
             start_from: int = 0,
             page_size: int = 0,
             output_format: str = "JSON",
@@ -2929,7 +3112,7 @@ class Client2(BaseClient):
 
         """
 
-        url = f"{self.command_root}feedback-manager/note-logs/by-name"
+        url = f"{self.command_root}feedback-manager/note-logs/{note_log_guid}/retrieve"
         response = await self._async_get_results_body_request(url, "Notification", self._generate_feedback_output,
                                                               0, 0, output_format, report_spec, body)
         return response
@@ -3873,6 +4056,7 @@ class Client2(BaseClient):
     #
     # Search Tags
     #
+    @dynamic_catch
     async def _async_add_search_keyword_to_element(
             self,
             element_guid: str,
@@ -3929,6 +4113,7 @@ class Client2(BaseClient):
         response = await self._async_make_request("POST", url, body_slimmer(body))
         return response.json().get('guid', 'Search keyword was not created')
 
+    @dynamic_catch
     def add_search_keyword_to_element(
             self,
             element_guid: str,
@@ -3976,6 +4161,8 @@ class Client2(BaseClient):
         )
         return response
 
+
+    @dynamic_catch
     async def _async_update_search_keyword(
             self,
             keyword_guid: str,
@@ -4017,6 +4204,7 @@ class Client2(BaseClient):
         url = f"{self.command_root}classification-manager/search-keywords/{keyword_guid}/update"
         await self._async_update_relationship_request(url, None, body_slimmer(body))
 
+    @dynamic_catch
     def update_search_keyword(
             self,
             keyword_guid: str,
@@ -4060,6 +4248,7 @@ class Client2(BaseClient):
             self._async_update_search_keyword(keyword_guid, body)
         )
 
+    @dynamic_catch
     async def _async_remove_search_keyword(
             self,
             keyword_guid: str
@@ -4083,16 +4272,15 @@ class Client2(BaseClient):
         """
 
         url = f"{self.command_root}classification-manager/search-keywords/{keyword_guid}/remove"
-        await self._async_delete_relationship_request(url)
+        await self._async_delete_relationship_request(url = url, body = None, cascade_delete = False)
 
+    @dynamic_catch
     def remove_search_keyword(
             self,
             keyword_guid,
     ) -> None:
         """
-        Remove the licensed for an element.
-
-        licenses: https://egeria-project.org/types/1/0120-Assignment-licenses/
+        Remove the search keyword for an element.
 
         Parameters
         ----------
@@ -4111,7 +4299,7 @@ class Client2(BaseClient):
 
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_remove_search_keyword(keyword_guid, )
+            self._async_remove_search_keyword(keyword_guid )
         )
 
     @dynamic_catch
@@ -4423,7 +4611,9 @@ class Client2(BaseClient):
         col_data = populate_common_columns(element, columns_struct)
         columns_list = col_data.get('formats', {}).get('attributes', [])
         # Overlay extras (project roles) only where empty
-        if isinstance(element['keywordElements'], list):
+        keyword_elements = element.get("keywordElements", [])
+
+        if keyword_elements != [] and isinstance(element['keywordElements'], list):
             extra = self._extract_element_properties_for_keyword(element, columns_struct)
             col_data = overlay_additional_values(col_data, extra)
 
@@ -4456,6 +4646,7 @@ class Client2(BaseClient):
             columns_struct=output_formats,
         )
 
+
     #
     # Helper functions for requests
     #
@@ -4556,11 +4747,12 @@ class Client2(BaseClient):
         elif isinstance(body, dict):
             validated_body = self._delete_relationship_request_adapter.validate_python(body)
         else:  # handle case where body not provided
-            body = {
-                "class": "DeleteRelationshipRequestBody",
-                "cascadeDelete": cascade_delete
-            }
-            validated_body = DeleteRelationshipRequestBody.model_validate(body)
+            # body = {
+            #     "class": "DeleteRelationshipRequestBody",
+            #     "cascadeDelete": cascade_delete
+            # }
+            # validated_body = DeleteRelationshipRequestBody.model_validate(body)
+            return None
         return validated_body
 
     @dynamic_catch
@@ -4888,7 +5080,7 @@ class Client2(BaseClient):
     @dynamic_catch
     async def _async_delete_relationship_request(self, url: str, body: dict | DeleteRelationshipRequestBody = None,
                                                  cascade_delete: bool = False) -> None:
-        validated_body = self.validate_delete_relationshp_request(body, cascade_delete)
+        validated_body = self.validate_delete_relationship_request(body, cascade_delete)
         if validated_body:
             json_body = validated_body.model_dump_json(indent=2, exclude_none=True)
             logger.info(json_body)

pyegeria/_exceptions_new.py

@@ -379,7 +379,12 @@ def print_basic_exception(e: PyegeriaException):
     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 ""
+    if e.response:
+        related_response = e.response.json() if isinstance(e, PyegeriaException) else None
+        exception_msg_id = related_response.get("exceptionErrorMessageId", None)
+    else:
+        exception_msg_id = ""
+
     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")

pyegeria/base_report_formats.py

@@ -307,6 +307,7 @@ base_report_specs = FormatSetDict({
             Format(
                 types=["ALL"],
                 attributes= [
+                    Column(name='Search Keyword', key='keyword'),
                     Column(name="Search Keyword GUID", key='guid'),
                     Column(name="Element Display Name", key='element_display_name'),
                     Column(name="Element GUID", key='element_guid'),

pyegeria/config.py

@@ -150,6 +150,7 @@ class UserProfileConfig(BaseModel):
     egeria_home_collection: str = Field(default="MyHome", alias="Egeria Home Collection")
     egeria_home_glossary_name: str = Field(default="Egeria-Markdown", alias="Egeria Home Glossary Name")
     egeria_local_qualifier: str = Field(default="PDR", alias="Egeria Local Qualifier")
+    egeria_usage_level: str = Field(default="Advanced", alias="Egeria Usage Level")
     user_name: Optional[str] = "erinoverview"
     user_pwd: Optional[str] = "secret"