pyegeria 0.3.2__tar.gz → 0.3.3__tar.gz

{pyegeria-0.3.2/src/pyegeria.egg-info → pyegeria-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.3.2
+Version: 0.3.3
 Summary: A python client for Egeria
 Home-page: https://egeria-project.org/egeria-python
 Author: Dan Wolfson

{pyegeria-0.3.2 → pyegeria-0.3.3}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyegeria"
-version = "0.3.2"
+version = "0.3.3"
 #license = 'Apache 2.0'
 authors = [
     {name ="Dan Wolfson", email= "dan.wolfson@pdr-associates.com"},

{pyegeria-0.3.2 → pyegeria-0.3.3}/setup.py

@@ -5,7 +5,7 @@ setup(
     extras_require=dict(tests=["pytest"]),
     # packages=find_packages(where="src"),
     package_dir={"": "src"},
-    version='0.3.2',
+    version='0.3.3',
     packages=find_packages(where="src"),
     url="https://egeria-project.org/egeria-python",
     project_urls={

{pyegeria-0.3.2 → pyegeria-0.3.3}/src/pyegeria/__init__.py

@@ -26,7 +26,7 @@ if disable_ssl_warnings:
 
 from ._exceptions import (InvalidParameterException, PropertyServerException, UserNotAuthorizedException,
                           print_exception_response)
-from .utils import print_response, body_slimmer
+from .utils import print_response, body_slimmer, wrap_text
 from ._client import Client
 from .automated_curation_omvs import AutomatedCuration
 from .core_omag_server_config import CoreServerConfig

{pyegeria-0.3.2 → pyegeria-0.3.3}/src/pyegeria/automated_curation_omvs.py

@@ -6,15 +6,15 @@ Copyright Contributors to the ODPi Egeria project.
 
 """
 import asyncio
-import json
 from datetime import datetime
-from httpx import AsyncClient, Response
+
+from httpx import Response
 
 from pyegeria import Client, max_paging_size, body_slimmer
-from ._validators import validate_name, validate_guid, validate_search_string
 from pyegeria._exceptions import (
     InvalidParameterException,
 )
+from ._validators import validate_name, validate_guid, validate_search_string
 
 
 class AutomatedCuration(Client):
@@ -92,7 +92,7 @@ class AutomatedCuration(Client):
 
         url = f"{self.platform_url}/servers/{server}/api/open-metadata/automated-curation/catalog-templates/new-element"
         response = await self._async_make_request("POST", url, body)
-        return response.json().get("guid","GUID failed to be returned")
+        return response.json().get("guid", "GUID failed to be returned")
 
     def create_element_from_template(self, body: dict, server: str = None) -> str:
         """ Create a new metadata element from a template.  Async version.
@@ -145,8 +145,8 @@ class AutomatedCuration(Client):
         )
         return response
 
-    async def _async_create_kafka_server_element_from_template(self, kafka_server:str, host_name: str, port: str,
-                                                               server:str = None) -> str:
+    async def _async_create_kafka_server_element_from_template(self, kafka_server: str, host_name: str, port: str,
+                                                               server: str = None) -> str:
         """ Create a Kafka server element from a template. Async version.
 
             Parameters
@@ -210,7 +210,6 @@ class AutomatedCuration(Client):
         )
         return response
 
-
     async def _async_create_postgres_server_element_from_template(self, postgres_server: str, host_name: str, port: str,
                                                                   db_user: str, db_pwd: str, server: str = None) -> str:
         """ Create a Postgres server element from a template. Async version.
@@ -247,7 +246,7 @@ class AutomatedCuration(Client):
                 "serverName": postgres_server,
                 "hostIdentifier": host_name,
                 "portNumber": port,
-                "databaseUserId" : db_user,
+                "databaseUserId": db_user,
                 "databasePassword": db_pwd
             }
         }
@@ -285,14 +284,14 @@ class AutomatedCuration(Client):
             """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_create_postgres_server_element_from_template(postgres_server,host_name,
-                                                                     port, db_user,db_pwd,server)
+            self._async_create_postgres_server_element_from_template(postgres_server, host_name,
+                                                                     port, db_user, db_pwd, server)
         )
         return response
 
     #
-# Engine Actions
-#
+    # Engine Actions
+    #
     async def _async_get_engine_actions(self, server: str = None, start_from: int = 0,
                                         page_size: int = max_paging_size) -> list:
         """ Retrieve the engine actions that are known to the server. Async version.
@@ -562,16 +561,19 @@ class AutomatedCuration(Client):
         name : str
             The name of the engine action to retrieve.
         server : str, optional
-            The name of the server to retrieve the engine action from. If not provided, the default server specified in the instance will be used.
+             The name of the server to retrieve the engine action from. If not provided, the default server specified in
+             the instance will be used.
         start_from : int, optional
             The index to start retrieving engine actions from. If not provided, the default value will be used.
         page_size : int, optional
-            The maximum number of engine actions to retrieve in a single request. If not provided, the default global maximum paging size will be used.
+            The maximum number of engine actions to retrieve in a single request. If not provided, the default global
+            maximum paging size will be used.
 
         Returns
         -------
         list of dict | str
-            A list of dictionaries representing the retrieved engine actions, or "no actions" if no engine actions were found with the given name.
+            A list of dictionaries representing the retrieved engine actions, or "no actions" if no engine actions were
+             found with the given name.
         Raises:
         ------
         InvalidParameterException
@@ -604,16 +606,19 @@ class AutomatedCuration(Client):
         name : str
             The name of the engine action to retrieve.
         server : str, optional
-            The name of the server to retrieve the engine action from. If not provided, the default server specified in the instance will be used.
+            The name of the server to retrieve the engine action from. If not provided, the default server specified in
+            the instance will be used.
         start_from : int, optional
             The index to start retrieving engine actions from. If not provided, the default value will be used.
         page_size : int, optional
-            The maximum number of engine actions to retrieve in a single request. If not provided, the default global maximum paging size will be used.
+            The maximum number of engine actions to retrieve in a single request. If not provided, the default global
+             maximum paging size will be used.
 
         Returns
         -------
         list of dict | str
-            A list of dictionaries representing the retrieved engine actions, or "no actions" if no engine actions were found with the given name.
+            A list of dictionaries representing the retrieved engine actions, or "no actions" if no engine actions were
+            found with the given name.
         Raises:
         ------
         InvalidParameterException
@@ -745,9 +750,9 @@ class AutomatedCuration(Client):
         )
         return response
 
-#
-# Governance action processes
-#
+    #
+    # Governance action processes
+    #
 
     async def _async_get_governance_action_process_by_guid(self, process_guid: str, server: str = None) -> dict | str:
         """ Retrieve the governance action process metadata element with the supplied unique identifier. Async Version.
@@ -863,7 +868,7 @@ class AutomatedCuration(Client):
        """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_gov_action_process_graph(process_guid, server)
+            self._async_gov_action_process_graph(process_guid, server)
         )
         return response
 
@@ -877,11 +882,13 @@ class AutomatedCuration(Client):
            name : str
                The name of the engine action to retrieve.
            server : str, optional
-               The name of the server to retrieve the engine action from. If not provided, the default server specified in the instance will be used.
+               The name of the server to retrieve the engine action from. If not provided, the default server specified
+               in the instance will be used.
            start_from : int, optional
                The index to start retrieving engine actions from. If not provided, the default value will be used.
            page_size : int, optional
-               The maximum number of engine actions to retrieve in a single request. If not provided, the default global maximum paging size will be used.
+               The maximum number of engine actions to retrieve in a single request. If not provided, the default
+               global maximum paging size will be used.
 
            Returns
            -------
@@ -916,11 +923,13 @@ class AutomatedCuration(Client):
            name : str
                The name of the engine action to retrieve.
            server : str, optional
-               The name of the server to retrieve the engine action from. If not provided, the default server specified in the instance will be used.
+               The name of the server to retrieve the engine action from. If not provided, the default server specified
+               in the instance will be used.
            start_from : int, optional
                The index to start retrieving engine actions from. If not provided, the default value will be used.
            page_size : int, optional
-               The maximum number of engine actions to retrieve in a single request. If not provided, the default global maximum paging size will be used.
+               The maximum number of engine actions to retrieve in a single request. If not provided, the default global
+                maximum paging size will be used.
 
            Returns
            -------
@@ -1041,8 +1050,8 @@ class AutomatedCuration(Client):
 
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_gov_action_processes(search_string, server, starts_with, ends_with, ignore_case,
-                                                 start_from, page_size)
+            self._async_find_gov_action_processes(search_string, server, starts_with, ends_with, ignore_case,
+                                                  start_from, page_size)
         )
         return response
 
@@ -1117,6 +1126,8 @@ class AutomatedCuration(Client):
             - unique name of the requesting governance service (if initiated by a governance engine)
         orig_engine_name: str
             - optional unique name of the governance engine (if initiated by a governance engine).
+        server: str, optional
+            - if not specified, the server from the class instance will be used
 
         Returns
         -------
@@ -1202,7 +1213,8 @@ class AutomatedCuration(Client):
                     action_type_name: str
                       The name of the governance action type to retrieve.
                     server: str, optional
-                        The name of the server. If None, will use the default server specified in the instance will be used.
+                        The name of the server. If None, will use the default server specified in the instance
+                        will be used.
                 Returns:
                 -------
                     dict: The JSON representation of the governance action type element.
@@ -1369,8 +1381,10 @@ class AutomatedCuration(Client):
         return response
 
     async def _async_initiate_gov_action_type(self, action_type_qualified_name: str, request_source_guids: [str],
-                                              action_targets: list, start_time: datetime= None, request_parameters: dict= None,
-                                              orig_service_name: str= None, orig_engine_name: str = None, server: str = None) -> str:
+                                              action_targets: list, start_time: datetime = None,
+                                              request_parameters: dict = None,
+                                              orig_service_name: str = None, orig_engine_name: str = None,
+                                              server: str = None) -> str:
         """ Using the named governance action type as a template, initiate an engine action. Async version.
 
         Parameters
@@ -1389,6 +1403,8 @@ class AutomatedCuration(Client):
             - unique name of the requesting governance service (if initiated by a governance engine)
         orig_engine_name: str
             - optional unique name of the governance engine (if initiated by a governance engine).
+        server : str, optional
+            - The name of the server. If None, will use the default server specified in the instance will be used.
 
         Returns
         -------
@@ -1439,6 +1455,8 @@ class AutomatedCuration(Client):
             - unique name of the requesting governance service (if initiated by a governance engine)
         orig_engine_name: str
             - optional unique name of the governance engine (if initiated by a governance engine).
+        server : str, optional
+            - The name of the server. If None, will use the default server specified in the instance will be used.
 
         Returns
         -------
@@ -1458,7 +1476,7 @@ class AutomatedCuration(Client):
         )
         return response
 
-    async def _async_initiate_postgres_server_survey(self, postgres_server_guid: str,  server: str = None )-> str:
+    async def _async_initiate_postgres_server_survey(self, postgres_server_guid: str, server: str = None) -> str:
         server = self.server_name if server is None else server
         url = (f"{self.platform_url}/servers/{server}/api/open-metadata/automated-curation/governance-action-types/"
                f"initiate")
@@ -1467,9 +1485,9 @@ class AutomatedCuration(Client):
             "class": "InitiateGovernanceActionTypeRequestBody",
             "governanceActionTypeQualifiedName": "Egeria:GovernanceActionType:2adeb8f1-0f59-4970-b6f2-6cc25d4d2402survey-postgres-server",
             "actionTargets": [{
-                "class" : "NewActionTarget",
-                "actionTargetName" : "serverToSurvey",
-                "actionTargetGUID" : postgres_server_guid
+                "class": "NewActionTarget",
+                "actionTargetName": "serverToSurvey",
+                "actionTargetGUID": postgres_server_guid
             }]
         }
         response = await self._async_make_request("POST", url, body)
@@ -1507,7 +1525,7 @@ class AutomatedCuration(Client):
     def initiate_file_folder_survey(self, file_folder_guid: str, server: str = None) -> str:
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_initiate_file_folder_survey( file_folder_guid, server)
+            self._async_initiate_file_folder_survey(file_folder_guid, server)
         )
         return response
 
@@ -1536,14 +1554,13 @@ class AutomatedCuration(Client):
         )
         return response
 
-    async def run_gov_action_postgres_server_survey(self, postgres_server: str, host_name: str, port: str,):
+    async def run_gov_action_postgres_server_survey(self, postgres_server: str, host_name: str, port: str, ):
         pass
         # New combo process to do
         # run a process the creates the postgres server catalog entry, runs the server survey
         # creates a survey report
         # adds a to-do list element when done
 
-
     async def _async_initiate_engine_action(self, qualified_name: str, domain_identifier: int, display_name: str,
                                             description: str, request_source_guids: str, action_targets: str,
                                             received_guards: [str], start_time: datetime, gov_engine_name: str,
@@ -1928,8 +1945,8 @@ class AutomatedCuration(Client):
 
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_add_catalog_target(integ_connector_guid, metadata_element_guid,
-                                           server)
+            self._async_remove_catalog_target(integ_connector_guid, metadata_element_guid,
+                                              server)
         )
         return
 
@@ -2081,7 +2098,7 @@ class AutomatedCuration(Client):
         return response
 
     async def _async_find_technology_types(self, search_string: str = "*", server: str = None, start_from: int = 0,
-                                           page_size: int = max_paging_size, starts_with: bool=False,
+                                           page_size: int = max_paging_size, starts_with: bool = False,
                                            ends_with: bool = False, ignore_case: bool = True) -> list | str:
         """ Retrieve the list of technology types that contain the search string. Async version.
 
@@ -2127,7 +2144,7 @@ class AutomatedCuration(Client):
         ends_with_s = str(ends_with).lower()
         ignore_case_s = str(ignore_case).lower()
         validate_name(search_string)
-        if search_string== "*":
+        if search_string == "*":
             search_string = ""
 
         url = (f"{self.platform_url}/servers/{server}/api/open-metadata/automated-curation/technology-types/"
@@ -2139,7 +2156,7 @@ class AutomatedCuration(Client):
         return response.json().get("elements", "no tech found")
 
     def find_technology_types(self, type_name: str = "*", server: str = None, start_from: int = 0,
-                              page_size: int = max_paging_size, starts_with: bool=False,
+                              page_size: int = max_paging_size, starts_with: bool = False,
                               ends_with: bool = False, ignore_case: bool = True) -> list | str:
         """ Retrieve the list of technology types that contain the search string. Async version.
 
@@ -2168,7 +2185,7 @@ class AutomatedCuration(Client):
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
             self._async_find_technology_types(type_name, server, start_from,
-                                              page_size, starts_with,ends_with, ignore_case)
+                                              page_size, starts_with, ends_with, ignore_case)
         )
         return response
 
@@ -2183,6 +2200,6 @@ class AutomatedCuration(Client):
 
 if __name__ == "__main__":
     p = AutomatedCuration("meow", "https://127.0.0.1:9443", "garygeeke", verify_flag=False)
-    response = p.get_active_service_list_for_server()
-    out = response.json()["result"]
+    response = p.get_active_engine_actions()
+    out = response.json()
     print(out)

pyegeria-0.3.3/src/pyegeria/exceptions.py

@@ -0,0 +1,382 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Definitions, utilities and exceptions in support of the Egeria Python Client package.
+
+"""
+
+import json
+from enum import Enum
+
+"""
+
+The following definitions are used in creating Exception messages. 
+They mirror similar definitions in the Egeria core. 
+Note that not all of the definitions are currently used - they merely serve as placeholders for future extensions.
+
+"""
+
+
+class EgeriaErrorCode(Enum):
+    """ Egeria error codes """
+
+    def __str__(self):
+        return (
+                "http_error_code="
+                + self.value["http_error_code"]
+                + "messageId="
+                + self.value["message_id"]
+                + ", message="
+                + self.value["message_template"]
+                + ", systemAction="
+                + self.value["system_action"]
+                + ", userAction="
+                + self.value["user_action"]
+        )
+
+
+class OMAGServerInstanceErrorCode(EgeriaErrorCode):
+    """ OMAGServer instance error codes """
+
+    BAD_SERVER_SECURITY_CONNECTION = dict(
+        https_error_code="400",
+        message_id="OMAG-MULTI-TENANT-400-001",
+        message_template="The OMAG server {0} has been configured with a bad connection to its security connector."
+                         + " Error message is {1}. Connection is {2}",
+        system_action="The system is unable to validate the users issuing requests to this server.",
+        user_action="Review the error message to determine the cause of the problem.",
+    )
+
+    """
+        OMAG-MULTI-TENANT-400-002 - The OMAG server {0} has been requested to shut down but the following services are
+        still running: {1}
+    """
+    SERVICES_NOT_SHUTDOWN = dict(
+        https_error_code="400",
+        message_id="OMAG-MULTI-TENANT-400-002",
+        message_template="The OMAG server {0} has been requested to shutdown but the following services " +
+                         "are still running: {1}",
+        system_action="The system is unable to shutdown the server correctly.",
+        user_action="Review other error messages to determine the cause of the problem."
+                    + " This is likely to be a logic error in the services listed in the message",
+    )
+
+    """
+        OMAG-MULTI-TENANT-400-003 - Method {0} called on behalf of the {1} service is unable to create a client-side
+        open metadata topic connection because the topic name is not configured in the configuration for this service.
+    """
+    NO_TOPIC_INFORMATION = dict(
+        https_error_code="400",
+        message_id="OMAG-MULTI-TENANT-400-003",
+        message_template="Method {0} called on behalf of the {1} service is unable to create a client-side open "
+                         + "metadata topic connection because the topic name is not configured in the configuration "
+                         + "for this service.",
+        system_action="This is a configuration error and an exception is sent to the requester.",
+        user_action="Correct the configuration of the access service to include the name of the topic.",
+    )
+
+    """
+        OMAG-MULTI-TENANT-400-004 - The connector provider class name {0} does not create a connector of class {1} 
+        which is required for the {2}
+    """
+    NOT_CORRECT_CONNECTOR_PROVIDER = dict(
+        https_error_code="400",
+        message_id="OMAG-MULTI-TENANT-400-004",
+        message_template="The connector provider class name {0} does not create a connector of class {1} which is"
+                         + " required for the {2}",
+        system_action="An invalid parameter exception is returned to the caller.",
+        user_action="Either change the connector or the hosting environment because the current"
+                    + " combination is not compatible.",
+    )
+
+    """
+        OMAG-MULTI-TENANT-404-001 - The OMAG Server {0} is not available to service a request from user {1}
+    """
+    SERVER_NOT_AVAILABLE = dict(
+        https_error_code="404",
+        message_id="OMAG-MULTI-TENANT-404-001",
+        message_template="The OMAG Server {0} is not available to service a request from user {1}",
+        system_action="The system is unable to process the request because the server"
+                      + " is not running on the called platform.",
+        user_action="Verify that the correct server is being called on the correct platform and that this server "
+                    + "is running. Retry the request when the server is available.",
+    )
+
+    """
+        OMAG-MULTI-TENANT-404-002- The {0} service is not available on OMAG Server {1} to handle a request from user {2}
+    """
+    SERVICE_NOT_AVAILABLE = dict(
+        https_error_code="404",
+        message_id="OMAG-MULTI-TENANT-404-002",
+        message_template="The {0} service is not available on OMAG Server {1} to handle a request from user {2}",
+        system_action="The system is unable to process the request because the service is not available.",
+        user_action="Verify that the correct server is being called on the correct platform and that the "
+                    + "requested service is configured to run there.  "
+                    + "Once the correct environment is in place, retry the request.",
+    )
+
+    """
+        OMAG-MULTI-TENANT-404-003 - The server name is not available for the {0} operation
+    """
+    SERVER_NAME_NOT_AVAILABLE = dict(
+        https_error_code="404",
+        message_id="OMAG-MULTI-TENANT-404-003",
+        message_template="The server name is not available for the {0} operation",
+        system_action="The system is unable to return the server name because it is not available.",
+        user_action="Check that the server where the access service is running initialized correctly.  "
+        + "Correct any errors discovered and retry the request when the open metadata services are available.",
+    )
+
+    """
+        OMAG-MULTI-TENANT-404-004 - The open metadata repository services are not initialized for the {0} operation
+    """
+    OMRS_NOT_INITIALIZED = dict(
+        https_error_code="404",
+        message_id="OMAG-MULTI-TENANT-404-004",
+        message_template="The open metadata repository services are not initialized for the {0} operation",
+        system_action="The system is unable to connect to the open metadata repository services because"
+                      + " they are not running in this server.",
+        user_action="Check that the server where the called service is running initialized correctly.  "
+        + "Correct any errors discovered and retry the request when the open metadata services are available.",
+    )
+
+    """
+        OMAG-MULTI-TENANT-404-005 - The open metadata repository services are not available for the {0} operation
+    """
+    OMRS_NOT_AVAILABLE = (
+        dict(
+            https_error_code="404",
+            message_id="OMAG-MULTI-TENANT-404-005",
+            message_template="The open metadata repository services are not available for the {0} operation",
+            system_action="The system is unable to connect to the open metadata repository services because"
+                          " they are not in the correct state to be called.",
+            user_action="Check that the server where the called service is running initialized correctly and is not"
+                        + " in the process of shutting down. Correct any errors discovered and retry the"
+                        + " request when the open metadata repository services are available.",
+        ),
+    )
+
+    """
+        OMAG-MULTI-TENANT-500-003 - Method {0} called on behalf of the {1} service detected a {2} exception when
+        creating an open metadata topic connection because the connector provider is incorrect.  
+        The error message was {3}
+    """
+    BAD_TOPIC_CONNECTOR_PROVIDER = dict(
+        http_error_code="500",
+        message_id="OMAG-MULTI-TENANT-500-003",
+        message_template="Method {0} called on behalf of the {1} service detected a {2} exception when creating an "
+        + "open metadata topic connection because the connector provider is incorrect.  The error message was {3}",
+        system_action="This is an internal error.  The access service is not using a valid connector provider.",
+        user_action="Raise an issue on Egeria's GitHub and work with the Egeria community to resolve.",
+    )
+
+
+class OMAGCommonErrorCode(EgeriaErrorCode):
+    CLIENT_SIDE_REST_API_ERROR = dict(
+        http_error_code="503",
+        message_id="CLIENT-SIDE-REST-API-CONNECTOR-503-002",
+        message_template="A client-side error {0} was received by method {1} from API call {2} during the call {3}."
+                         + " The error message was {4}",
+        system_action="The client has issued a call to the open metadata access service REST API in a remote server"
+                      + " and has received an exception from the local client libraries.",
+        user_action="Review the error message to determine the cause of the error. Check that the server is running"
+                    + " and the URL is correct. Look for errors in the local server's console to understand and"
+                    + " correct the cause of the error. Then rerun the request",
+    )
+
+    EXCEPTION_RESPONSE_FROM_API = dict(
+        http_error_code="503",
+        message_id="SERVER-SIDE-REST-API-ERROR-503-003 ",
+        message_template="A {0} exception was received from REST API call {1} to server {2}: error message was: {3}",
+        system_action="The system has issued a call to an open metadata access service REST API in a remote server"
+                      + " and has received an exception response.",
+        user_action="The error message should indicate the cause of the error. "
+                    + "Otherwise look for errors in the remote server's audit log and console to understand and "
+                    + "correct the source of the error.",
+    )
+
+    SERVER_URL_NOT_SPECIFIED = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-001",
+        message_template="The OMAG Server Platform URL is null",
+        system_action="The system is unable to identify the OMAG Server Platform.",
+        user_action="Create a new client and pass the URL for the server on the constructor.",
+    )
+
+    SERVER_URL_MALFORMED = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-002",
+        message_template="The OMAS Server URL: {0} is not in a recognized format",
+        system_action="The system is unable to connect to the OMAG Server Platform to fulfill any requests.",
+        user_action="Create a new client and pass the correct URL for the server on the constructor.",
+    )
+
+    SERVER_NAME_NOT_SPECIFIED = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-003",
+        message_template="The OMAG Server name is null",
+        system_action="The system is unable to locate to the OMAG Server to fulfill any request.",
+        user_action="Create a new client and pass the correct name for the server on the constructor.",
+    )
+
+    NULL_USER_ID = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-004",
+        message_template="The user identifier {0} passed on the operation is null",
+        system_action="The system is unable to process the request without a user id..",
+        user_action="Correct the code in the caller to provide the user id.",
+    )
+
+    NULL_GUID = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-005",
+        message_template="The unique identifier (guid) passed is null or not a string",
+        system_action="The system is unable to process the request without a guid.",
+        user_action="Correct the code in the caller to provide the guid.",
+    )
+
+    NULL_NAME = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-006",
+        message_template="The name passed on the parameter of the operation is null",
+        system_action="The system is unable to process the request without a name.",
+        user_action="Correct the code in the caller to provide the name on the parameter.",
+    )
+
+    NULL_ARRAY_PARAMETER = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-007",
+        message_template="The array value passed on the {0} parameter of the {1} operation is null or empty",
+        system_action="The system is unable to process the request without this value.",
+        user_action="Correct the code in the caller to provide the array.",
+    )
+
+    NEGATIVE_START_FROM = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-008",
+        message_template="The starting point for the results {0}, passed on the {1} parameter of the {2}"
+                         + " operation, is negative",
+        system_action="The system is unable to process the request with this invalid value."
+        + "It should be zero for the start of the values, or a number greater than 0"
+        + "to start partway down the list.",
+        user_action="Correct the code in the caller to provide a non-negative value for the starting point.",
+    )
+
+    NEGATIVE_PAGE_SIZE = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-009",
+        message_template="The page size for the results {0}, passed on the {1} parameter of the {2} operation, " +
+                         "is negative",
+        system_action="The system is unable to process the request with this invalid value. "
+                      + "It should be zero to return all the result, or greater than zero to set a maximum.",
+        user_action="Correct the code in the caller to provide a non-negative value for the page size.",
+    )
+
+    MAX_PAGE_SIZE = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-010",
+        message_template=(
+                "The number of records to return, {0}, passed on the {1} parameter of the {2} operation, "
+                + "is greater than the allowable maximum of {3}"
+        ),
+        system_action="The system is unable to process the request with this page size value.",
+        user_action="Correct the code in the caller to provide a smaller page size.",
+    )
+
+    NULL_ENUM = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-012",
+        message_template="The enumeration value passed on the {0} parameter of the {1} operation is null",
+        system_action="The system is unable to process the request without a enumeration value.",
+        user_action="Correct the code in the caller to provide the enumeration value.",
+    )
+
+    NULL_TEXT = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-013",
+        message_template="The text field passed on the {0} parameter of the {1} operation is null",
+        system_action="The system is unable to process the request without this text value.",
+        user_action="Correct the code in the caller to provide a value in the text field.",
+    )
+
+    NULL_OBJECT = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-015",
+        message_template="The object passed on the {0} parameter of the {1} operation is null",
+        system_action="The system is unable to process the request without this object.",
+        user_action="Correct the code in the caller to provide the object.",
+    )
+
+    NULL_SEARCH_STRING = dict(
+        http_error_code="400",
+        message_id="OMAG-COMMON-400-022",
+        message_template="The search string passed on the {0} parameter of the {1} operation is null",
+        system_action="The system is unable to process the request without a search string.",
+        user_action="Correct the code in the caller to provide the search string.",
+    )
+
+
+class EgeriaException(Exception):
+    """
+    Define the Egeria exceptions raised during error handling. Modeled on the exceptions defined in the Egeria core.
+
+    """
+    raw_error_message = ""
+    def __init__(self, response_body) -> None:
+        response_dict = json.loads(response_body)
+        self.response_class = response_dict["class"]
+        self.related_http_code = response_dict["relatedHTTPCode"]
+        self.exception_class_name = response_dict["exceptionClassName"]
+        self.action_description = response_dict["actionDescription"]
+        self.exception_error_message = response_dict["exceptionErrorMessage"]
+        self.exception_error_message_id = response_dict["exceptionErrorMessageId"]
+
+        # self.exception_error_message_id = response_dict["exceptionErrorMessageId"]
+        self.exception_error_message_parameters = response_dict[
+            "exceptionErrorMessageParameters"
+        ]
+        self.exception_system_action = response_dict["exceptionSystemAction"]
+        self.exception_user_action = response_dict["exceptionUserAction"]
+
+    def __str__(self):
+        return self.exception_error_message
+
+
+class InvalidParameterException(EgeriaException):
+    """Exception due to invalid parameters such as one of the parameters is null or invalid"""
+
+    def __init__(self, response_body):
+        EgeriaException.__init__(self, response_body)
+
+
+class PropertyServerException(EgeriaException):
+    """Exception due to a problem retrieving information from the property server"""
+
+    def __init__(self, response_body):
+        EgeriaException.__init__(self, response_body)
+
+
+class UserNotAuthorizedException(EgeriaException):
+    """Exception as the requesting user is not authorized to issue this request"""
+
+    def __init__(self, response_body):
+        EgeriaException.__init__(self, response_body)
+
+
+def print_exception_response(e: EgeriaException):
+    """ Prints the exception response """
+
+    if isinstance(e, EgeriaException):
+        print(f"\n\nException: {e.response_class}")
+        print(f"\t\t   Error Message: {e.exception_error_message}")
+        print(
+            f"\t\t   Error Code: {e.exception_error_message_id} with http code {str(e.related_http_code)}"
+        )
+        # print(f"\t\t   Raw Error Text is {e.raw_error_message}")
+        print(f"\t\t   Class: {e.exception_class_name}")
+        print(f"\t\t   Caller: {e.action_description}")
+        print(f"\t\t   System Action: {e.exception_system_action}")
+        print(f"\t\t   User Action: {e.exception_user_action}")
+    else:
+        print(f"\n\n\t  Not an Egeria exception {e}")

{pyegeria-0.3.2 → pyegeria-0.3.3}/src/pyegeria/registered_info.py

@@ -10,12 +10,16 @@ integration service, it is important to know what companion service it depends o
 companion service is also configured and running.
 
 """
+import json
+from rich.console import Console
+from rich import print, print_json
+
 import pandas as pd
 from tabulate import tabulate
 
-from .utils import wrap_text
+from pyegeria.utils import wrap_text
 
-from ._client import Client
+from pyegeria._client import Client
 
 
 class RegisteredInfo(Client):
@@ -42,6 +46,9 @@ class RegisteredInfo(Client):
 
         list_severity_definitions(self, fmt: str = 'json', skinny: bool = True, wrap_len: int = 30) -> list | str
             Returns a list of severity definitions for an OMAG Server used by the audit services.
+
+        list_asset_types(self, server: str = None) -> list | str
+            Lists the defined asset types.
     """
 
     admin_command_root: str
@@ -93,7 +100,7 @@ class RegisteredInfo(Client):
                The principle specified by the user_id does not have authorization for the requested action
 
            """
-        if kind is None or kind is "help":
+        if kind is None or kind == "help":
             return ("""
             The kinds of services that you can get more information include:
                 all.....................lists all registered services
@@ -107,15 +114,15 @@ class RegisteredInfo(Client):
                 Pass in a parameter from the left-hand column into the function to 
                 get more details on the specified service category.
             """)
-        if kind is "all":
+        if kind == "all":
             url = f"{self.admin_command_root}"
         else:
             url = f"{self.admin_command_root}/{kind}"
         response = self.make_request("GET", url)
 
-        if fmt is 'json':
+        if fmt == 'json':
             return response.json().get("services", "No services found")
-        elif fmt is 'table':
+        elif fmt == 'table':
             df = pd.DataFrame(response.json().get("services", []))
             if skinny:
                 df = df.drop(columns=['serviceId', 'serviceDevelopmentStatus'])
@@ -155,10 +162,38 @@ class RegisteredInfo(Client):
                f"/users/{self.user_id}/audit-log/severity-definitions"
                )
         response = self.make_request("GET", url)
-        if fmt is 'json':
+        if fmt == 'json':
             return response.json().get("severities", "No severities found")
-        elif fmt is 'table':
+        elif fmt == 'table':
             df = pd.DataFrame(response.json().get("severities", []))
             if skinny:
                 df = df.drop(columns=['ordinal'])
             return tabulate(wrap_text(df, wrap_len=wrap_len), headers='keys', tablefmt='psql')
+
+    def list_asset_types(self, server: str = None) -> list | str:
+        """ Get the registered severities for the OMAG Server
+
+          Parameters
+          ----------
+           server: str, optional, default = None
+
+          Returns
+          -------
+          dict | str
+              Returns a list of the asset types.
+
+          Raises
+          ------
+          InvalidParameterException
+              If the response code is not 200.
+          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
+
+        """
+        server = self.server_name if server is None else server
+        url = f"{self.platform_url}/servers/{self.server_name}/api/open-metadata/asset-catalog/assets/types"
+
+        response = self.make_request("GET", url)
+        return response.json().get('types', 'no types found')

{pyegeria-0.3.2 → pyegeria-0.3.3/src/pyegeria.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.3.2
+Version: 0.3.3
 Summary: A python client for Egeria
 Home-page: https://egeria-project.org/egeria-python
 Author: Dan Wolfson

{pyegeria-0.3.2 → pyegeria-0.3.3}/src/pyegeria.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ src/pyegeria/_globals.py
 src/pyegeria/_validators.py
 src/pyegeria/automated_curation_omvs.py
 src/pyegeria/core_omag_server_config.py
+src/pyegeria/exceptions.py
 src/pyegeria/full_omag_server_config.py
 src/pyegeria/glossary_omvs.py
 src/pyegeria/gov_engine.py

{pyegeria-0.3.2 → pyegeria-0.3.3}/tests/test_core_omag_server_config.py

@@ -114,7 +114,7 @@ class TestCoreAdminServices:
             print_exception_response(e)
             assert False, "Invalid request"
 
-    def test_configure_all_access_services_good(self, server:str = good_server_1):
+    def test_configure_all_access_services_good(self, server:str = good_server_3):
         try:
             o_client = CoreServerConfig(
                 server, self.good_platform1_url,

{pyegeria-0.3.2 → pyegeria-0.3.3}/tests/test_registered_info.py

@@ -10,6 +10,7 @@ The routines assume that pytest is being used as the test tool and framework.
 A running Egeria environment is needed to run these tests.
 
 """
+import json
 import pytest
 from rich import print as rprint
 from rich.console import Console
@@ -28,7 +29,7 @@ disable_ssl_warnings = True
 
 class TestRegisteredInfoServices:
     good_platform1_url = "https://127.0.0.1:9443"
-    good_platform2_url = "https://127.0.0.1:9444"
+    good_platform2_url = "https://cray.local:9443"
     bad_platform1_url = "https://localhost:9443"
 
     good_user_1 = "garygeeke"
@@ -37,7 +38,7 @@ class TestRegisteredInfoServices:
     bad_user_2 = ""
 
     good_server_1 = "simple-metadata-store"
-    good_server_2 = "cocoMDS2"
+    good_server_2 = "view-server"
     good_server_3 = "active-metadata-store"
     bad_server_1 = "coco"
     bad_server_2 = ""
@@ -127,3 +128,26 @@ class TestRegisteredInfoServices:
         ) as e:
             print_exception_response(e)
             assert False, "Invalid request"
+
+    def test_list_asset_types(self):
+        user = self.good_user_2
+        try:
+            r_client = RegisteredInfo(self.good_platform1_url, user, "secret",
+                                      server_name =self.good_server_2,)
+            token = r_client.create_egeria_bearer_token(user, "secret")
+            response = r_client.list_asset_types()
+
+            assert type(response) is list, "No services found"
+            if type(response) is list:
+                print(f"\n\nAsset types are: \n\n")
+                print(json.dumps(response, indent=4))
+            else:
+                print(f"\n\n{response}: \n\n")
+
+        except (
+                InvalidParameterException,
+                PropertyServerException,
+                UserNotAuthorizedException
+        ) as e:
+            print_exception_response(e)
+            assert False, "Invalid request"