pyegeria 0.7.45__py3-none-any.whl → 0.8.0__py3-none-any.whl

pyegeria/_deprecated_gov_engine.py

@@ -14,7 +14,7 @@ from ._globals import enable_ssl_check
 
 
 def body_slimmer(body: dict) -> dict:
-    """ body_slimmer is a little function to remove unused keys from a dict
+    """body_slimmer is a little function to remove unused keys from a dict
 
     Parameters
     ----------
@@ -31,44 +31,44 @@ def body_slimmer(body: dict) -> dict:
 
 class GovEng(Client):
     """
-       Client to initiate and manage governance actions and processes.
-
-       Attributes:
-           server_name: str
-                Name of the server to use.
-           platform_url : str
-               URL of the server platform to connect to
-           user_id : str
-               The identity of the user calling the method - this sets a default optionally used by the methods
-               when the user doesn't pass the user_id on a method call.
-           user_pwd: str = None
-                The password associated with the user
-           verify_flag: bool = enable_ssl_check
-                Set true for SSL verification to be enabled, false for disabled. Default behaviour set by the
-                enable_ssl_check attribute from _globals.py
-
-       """
+    Client to initiate and manage governance actions and processes.
+
+    Attributes:
+        server_name: str
+             Name of the server to use.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str = None
+             The password associated with the user
+        verify_flag: bool = enable_ssl_check
+             Set true for SSL verification to be enabled, false for disabled. Default behaviour set by the
+             enable_ssl_check attribute from _globals.py
+
+    """
 
     def __init__(
-            self,
-            server_name: str,
-            platform_url: str,
-            user_id: str,
-            user_pwd: str = None,
-            verify_flag: bool = enable_ssl_check,
+        self,
+        server_name: str,
+        platform_url: str,
+        user_id: str,
+        user_pwd: str = None,
+        verify_flag: bool = enable_ssl_check,
     ):
         self.admin_command_root: str
-        Client.__init__(self, server_name, platform_url, user_id,
-                        user_pwd, verify_flag)
+        Client.__init__(self, server_name, platform_url, user_id, user_pwd)
         self.engine_command_root = (
-                self.platform_url
-                + "/servers/" + server_name
-                + "/open-metadata/framework-services/governance-engine/open-governance-service/users/"
-                + user_id
+            self.platform_url
+            + "/servers/"
+            + server_name
+            + "/open-metadata/framework-services/governance-engine/open-governance-service/users/"
+            + user_id
         )
 
     def get_engine_actions(self, start_from: int = 0, page_size: int = 0) -> [dict]:
-        """ Get engine actions associated deployed on the server.
+        """Get engine actions associated deployed on the server.
 
         Args:
             start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
@@ -85,15 +85,20 @@ class GovEng(Client):
             Pagination of 0 defaults to server default.
 
         """
-        url = (self.engine_command_root + "/engine-actions?startFrom=" +
-               str(start_from) + "&pageSize=" + str(page_size))
+        url = (
+            self.engine_command_root
+            + "/engine-actions?startFrom="
+            + str(start_from)
+            + "&pageSize="
+            + str(page_size)
+        )
         response = self.make_request("GET", url)
 
-        governance_elements = response.json().get('elements')
+        governance_elements = response.json().get("elements")
         return governance_elements
 
     def get_engine_action(self, engine_action_guid: str) -> str:
-        """ Return the governance action associated with the supplied guid
+        """Return the governance action associated with the supplied guid
 
         Parameters
         ----------
@@ -113,11 +118,13 @@ class GovEng(Client):
         url = self.engine_command_root + "/engine-actions/" + engine_action_guid
         response = self.make_request("GET", url)
 
-        governance_element = response.json().get('element')
+        governance_element = response.json().get("element")
         return governance_element
 
-    def get_active_engine_actions(self, start_from: int = 0, page_size: int = 0) -> [str]:
-        """ Get active governance actions associated on the server.
+    def get_active_engine_actions(
+        self, start_from: int = 0, page_size: int = 0
+    ) -> [str]:
+        """Get active governance actions associated on the server.
 
         Args:
             start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
@@ -133,15 +140,22 @@ class GovEng(Client):
         Note:
             Pagination of 0 defaults to server default.
         """
-        url = (self.engine_command_root + "/engine-actions/active?startFrom=" +
-               str(start_from) + "&pageSize=" + str(page_size))
+        url = (
+            self.engine_command_root
+            + "/engine-actions/active?startFrom="
+            + str(start_from)
+            + "&pageSize="
+            + str(page_size)
+        )
 
         response = self.make_request("GET", url)
-        governance_elements = response.json().get('elements')
+        governance_elements = response.json().get("elements")
         return governance_elements
-        
-    def get_engine_actions_by_name(self, name: str, start_from: int = 0, page_size: int = 0) -> str:
-        """ Retrieve engine actions matching the name string.
+
+    def get_engine_actions_by_name(
+        self, name: str, start_from: int = 0, page_size: int = 0
+    ) -> str:
+        """Retrieve engine actions matching the name string.
         Args:
             name (str): The qualified name or display name of the governance action to get.
             start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
@@ -158,19 +172,23 @@ class GovEng(Client):
             Pagination of 0 defaults to server default.
 
         """
-        url = (self.engine_command_root + "/engine-actions/by-name?startFrom=" +
-               str(start_from) + "&pageSize=" + str(page_size))
-        body = {
-            "class": "NameRequestBody",
-            "name": name
-        }
+        url = (
+            self.engine_command_root
+            + "/engine-actions/by-name?startFrom="
+            + str(start_from)
+            + "&pageSize="
+            + str(page_size)
+        )
+        body = {"class": "NameRequestBody", "name": name}
         response = self.make_request("POST", url, body)
 
-        governance_elements = response.json().get('elements')
+        governance_elements = response.json().get("elements")
         return governance_elements
 
-    def find_engine_actions(self, search_string: str, start_from: int = 0, page_size: int = 0) -> [str]:
-        """ Search for engine actions matching the search string.
+    def find_engine_actions(
+        self, search_string: str, start_from: int = 0, page_size: int = 0
+    ) -> [str]:
+        """Search for engine actions matching the search string.
 
         Args:
             search_string (str): The search string to query for.
@@ -186,45 +204,53 @@ class GovEng(Client):
 
         Note:
             Pagination of 0 defaults to server default.
-       """
-        url = (self.engine_command_root + "/engine-actions/by-search-string?startFrom=" +
-               str(start_from) + "&pageSize=" + str(page_size))
-        body = {
-            "class": "SearchStringRequestBody",
-            "searchString": search_string
-        }
+        """
+        url = (
+            self.engine_command_root
+            + "/engine-actions/by-search-string?startFrom="
+            + str(start_from)
+            + "&pageSize="
+            + str(page_size)
+        )
+        body = {"class": "SearchStringRequestBody", "searchString": search_string}
         response = self.make_request("POST", url, body)
 
-        governance_elements = response.json().get('elements')
+        governance_elements = response.json().get("elements")
         return governance_elements
 
     def get_governance_action_process_by_guid(self, gov_process_guid: str) -> str:
         """
-            Retrieves information about a governance action process based on its GUID.
+        Retrieves information about a governance action process based on its GUID.
 
-            Args:
-                gov_process_guid (str): The GUID (Globally Unique Identifier) of the governance action process.
+        Args:
+            gov_process_guid (str): The GUID (Globally Unique Identifier) of the governance action process.
 
-            Returns:
-                str: The JSON representation of the governance action process element.
+        Returns:
+            str: The JSON representation of the governance action process element.
 
-            Raises:
-                InvalidParameterException: If the API response indicates an error (non-200 status code),
-                this exception is raised with details from the response content.
-                PropertyServerException: If the API response indicates a server side error.
-                UserNotAuthorizedException:
+        Raises:
+            InvalidParameterException: If the API response indicates an error (non-200 status code),
+            this exception is raised with details from the response content.
+            PropertyServerException: If the API response indicates a server side error.
+            UserNotAuthorizedException:
 
-            Note:
-                This method assumes that the provided GUID is valid and corresponds to an existing
-                governance action process in the system.
+        Note:
+            This method assumes that the provided GUID is valid and corresponds to an existing
+            governance action process in the system.
 
-            """
-        url = self.engine_command_root + "/governance-action-processes/" + gov_process_guid
+        """
+        url = (
+            self.engine_command_root
+            + "/governance-action-processes/"
+            + gov_process_guid
+        )
         response = self.make_request("GET", url)
-        governance_element = response.json().get('element')
+        governance_element = response.json().get("element")
         return governance_element
 
-    def get_governance_action_processes_by_name(self, name: str, start_from: int = 0, page_size: int = 0) -> [str]:
+    def get_governance_action_processes_by_name(
+        self, name: str, start_from: int = 0, page_size: int = 0
+    ) -> [str]:
         """
         Retrieves governance action processes based on their name only (no wildcards).
 
@@ -244,18 +270,22 @@ class GovEng(Client):
             Pagination of 0 defaults to server default.
 
         """
-        url = (self.engine_command_root + "/governance-action-processes/by-name?startFrom=" + str(start_from)
-               + "&pageSize=" + str(page_size))
-        body = {
-            "class":          "NameRequestBody",
-            "name":           name
-        }
+        url = (
+            self.engine_command_root
+            + "/governance-action-processes/by-name?startFrom="
+            + str(start_from)
+            + "&pageSize="
+            + str(page_size)
+        )
+        body = {"class": "NameRequestBody", "name": name}
         response = self.make_request("POST", url, body)
-        governance_elements = response.json().get('elements')
+        governance_elements = response.json().get("elements")
         return governance_elements
-        
-    def find_governance_action_processes(self, search_string: str, start_from: int = 0, page_size: int = 0) -> [str]:
-        """ Return governance action processes that match the search string (with regex).
+
+    def find_governance_action_processes(
+        self, search_string: str, start_from: int = 0, page_size: int = 0
+    ) -> [str]:
+        """Return governance action processes that match the search string (with regex).
 
         Args:
             search_string (str): The search string to query for.
@@ -273,21 +303,30 @@ class GovEng(Client):
             Pagination of 0 defaults to server default.
 
         """
-        url = (self.engine_command_root + "/governance-action-processes/by-search-string?startFrom=" + str(start_from)
-               + "&pageSize=" + str(page_size))
-        body = {
-            "class": "SearchStringRequestBody",
-            "searchString": search_string
-        }
+        url = (
+            self.engine_command_root
+            + "/governance-action-processes/by-search-string?startFrom="
+            + str(start_from)
+            + "&pageSize="
+            + str(page_size)
+        )
+        body = {"class": "SearchStringRequestBody", "searchString": search_string}
         response = self.make_request("POST", url, body)
 
-        governance_elements = response.json().get('elements')
+        governance_elements = response.json().get("elements")
         return governance_elements
-        
-    def initiate_governance_action_process(self, qualified_name: str, request_source_guids: [str],
-                                           action_targets: [str], start_time: datetime, request_parameters: dict,
-                                           orig_service_name: str, orig_engine_name: str) -> str:
-        """ initiate_gov_action_process
+
+    def initiate_governance_action_process(
+        self,
+        qualified_name: str,
+        request_source_guids: [str],
+        action_targets: [str],
+        start_time: datetime,
+        request_parameters: dict,
+        orig_service_name: str,
+        orig_engine_name: str,
+    ) -> str:
+        """initiate_gov_action_process
 
         This method starts a governance action process using the supplied parameters.
 
@@ -321,80 +360,92 @@ class GovEng(Client):
         """
         url = self.engine_command_root + "/governance-action-processes/initiate"
         body = {
-            "class":                     "GovernanceActionProcessRequestBody",
-            "processQualifiedName":       qualified_name,
-            "requestSourceGUIDs":         request_source_guids,
-            "actionTargets":              action_targets,
-            "startTime":                  int(start_time.timestamp() * 1000),
-            "requestParameters":          request_parameters,
-            "originatorServiceName":      orig_service_name,
-            "originatorEngineName":       orig_engine_name
+            "class": "GovernanceActionProcessRequestBody",
+            "processQualifiedName": qualified_name,
+            "requestSourceGUIDs": request_source_guids,
+            "actionTargets": action_targets,
+            "startTime": int(start_time.timestamp() * 1000),
+            "requestParameters": request_parameters,
+            "originatorServiceName": orig_service_name,
+            "originatorEngineName": orig_engine_name,
         }
         new_body = body_slimmer(body)
         response = self.make_request("POST", url, new_body)
 
-        return response.json().get('guid')
-        
-    def 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,
-                               request_type: str, request_parameters: dict, process_name: str,
-                               request_src_name: str = None, originator_svc_name: str = None,
-                               originator_eng_name: str = None) -> str:
+        return response.json().get("guid")
+
+    def 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,
+        request_type: str,
+        request_parameters: dict,
+        process_name: str,
+        request_src_name: str = None,
+        originator_svc_name: str = None,
+        originator_eng_name: str = None,
+    ) -> str:
         """
-            Initiates an engine action with the specified parameters.
-
-            Args:
-                qualified_name (str): The qualified name of the governance action.
-                domain_identifier (int): The domain identifier for the governance action.
-                display_name (str): The display name of the governance action.
-                description (str): The description of the governance action.
-                request_source_guids (str): GUIDs of the sources initiating the request.
-                action_targets (str): Targets of the governance action.
-                received_guards (List[str]): List of guards received for the action.
-                start_time (datetime): The start time for the governance action.
-                gov_engine_name (str): The name of the governance engine associated with the action.
-                request_type (str): The type of the governance action request.
-                request_parameters (dict): Additional parameters for the governance action.
-                process_name (str): The name of the associated governance action process.
-                request_src_name (str, optional): The name of the request source. Defaults to None.
-                originator_svc_name (str, optional): The name of the originator service. Defaults to None.
-                originator_eng_name (str, optional): The name of the originator engine. Defaults to None.
-
-            Returns:
-                str: The GUID (Globally Unique Identifier) of the initiated governance action.
-
-            Raises:
-                InvalidParameterException: If the API response indicates an error (non-200 status code),
-                this exception is raised with details from the response content.
-
-            Note:
-                The `start_time` parameter should be a `datetime` object representing the start 
-                time of the governance action.
-
-
-            """
-        url = self.engine_command_root + ("/governance-engines/" + gov_engine_name +
-                                          "/engine-actions/initiate")
+        Initiates an engine action with the specified parameters.
+
+        Args:
+            qualified_name (str): The qualified name of the governance action.
+            domain_identifier (int): The domain identifier for the governance action.
+            display_name (str): The display name of the governance action.
+            description (str): The description of the governance action.
+            request_source_guids (str): GUIDs of the sources initiating the request.
+            action_targets (str): Targets of the governance action.
+            received_guards (List[str]): List of guards received for the action.
+            start_time (datetime): The start time for the governance action.
+            gov_engine_name (str): The name of the governance engine associated with the action.
+            request_type (str): The type of the governance action request.
+            request_parameters (dict): Additional parameters for the governance action.
+            process_name (str): The name of the associated governance action process.
+            request_src_name (str, optional): The name of the request source. Defaults to None.
+            originator_svc_name (str, optional): The name of the originator service. Defaults to None.
+            originator_eng_name (str, optional): The name of the originator engine. Defaults to None.
+
+        Returns:
+            str: The GUID (Globally Unique Identifier) of the initiated governance action.
+
+        Raises:
+            InvalidParameterException: If the API response indicates an error (non-200 status code),
+            this exception is raised with details from the response content.
+
+        Note:
+            The `start_time` parameter should be a `datetime` object representing the start
+            time of the governance action.
+
+
+        """
+        url = self.engine_command_root + (
+            "/governance-engines/" + gov_engine_name + "/engine-actions/initiate"
+        )
 
         body = {
-            "class":                      "GovernanceActionRequestBody",
-            "qualifiedName":              qualified_name + str(int(start_time.timestamp())),
-            "domainIdentifier":           domain_identifier,
-            "displayName":                display_name,
-            "description":                description,
-            "requestSourceGUIDs":         request_source_guids,
-            "actionTargets":              action_targets,
-            "receivedGuards":             received_guards,
-            "startTime":                  int(start_time.timestamp()*1000),
-            "requestType":                request_type,
-            "requestParameters":          request_parameters,
-            "process_name":                process_name,
-            "requestSourceName":          request_src_name,
-            "originatorServiceName":      originator_svc_name,
-            "originatorEngineName":       originator_eng_name
+            "class": "GovernanceActionRequestBody",
+            "qualifiedName": qualified_name + str(int(start_time.timestamp())),
+            "domainIdentifier": domain_identifier,
+            "displayName": display_name,
+            "description": description,
+            "requestSourceGUIDs": request_source_guids,
+            "actionTargets": action_targets,
+            "receivedGuards": received_guards,
+            "startTime": int(start_time.timestamp() * 1000),
+            "requestType": request_type,
+            "requestParameters": request_parameters,
+            "process_name": process_name,
+            "requestSourceName": request_src_name,
+            "originatorServiceName": originator_svc_name,
+            "originatorEngineName": originator_eng_name,
         }
         new_body = body_slimmer(body)
         response = self.make_request("POST", url, new_body)
-        return response.json().get('guid')
-
+        return response.json().get("guid")