pyegeria 5.2.0.9__py3-none-any.whl → 5.2.0.10__py3-none-any.whl

pyegeria/metadata_explorer_omvs.py

@@ -40,6 +40,31 @@ def base_path(client, view_server: str):
     return f"{client.platform_url}/servers/{view_server}/api/open-metadata/metadata-explorer"
 
 
+def process_related_element_list(response: Response, mermaid_only: bool) -> str | dict:
+    """Process the result payload
+
+    Parameters
+    ----------
+    response
+    mermaid_only
+
+    Returns
+    -------
+
+    """
+    elements = response.json().get("relatedElementList", "No elements found")
+    if isinstance(elements, str):
+        return "No elements found"
+    el_list = elements.get("elementList", "No elements found")
+    if isinstance(el_list, str):
+        return el_list
+    if mermaid_only:
+        return elements.get("mermaidGraph", "No mermaid graph found")
+    if len(el_list) == 0:
+        return "No elements returned"
+    return elements
+
+
 class MetadataExplorer(Client):
     """MetadataExplorer is a class that extends the Client class. The Metadata Explorer OMVS provides APIs for
       supporting the search, query and retrieval of open metadata. It is an advanced API for users that understands
@@ -319,6 +344,7 @@ class MetadataExplorer(Client):
         as_of_time: str = None,
         for_lineage: bool = None,
         for_duplicate_processing: bool = None,
+        mermaid_only: bool = False,
     ) -> dict | str:
         """
         Retrieve the metadata element and all of its anchored elements using its unique identifier. Async version.
@@ -335,11 +361,15 @@ class MetadataExplorer(Client):
             - determines if elements classified as Memento should be returned - normally false
         for_duplicate_processing: bool, default is set by server
             - Normally false. Set true when the caller is part of a deduplication function
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
         Returns
         -------
         dict | str
-            If the element is found, a dict of the element details is returned. Otherwise the string "No element found".
+            If the element is found, and mermaid_only is False, a dict of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -371,7 +401,22 @@ class MetadataExplorer(Client):
         response: Response = await self._async_make_request(
             "POST", url, body_slimmer(body)
         )
-        return response.json().get("elementGraph", "No elements found")
+        # if mermaid_only:
+        #     return response.json()["elementGraph"].get(
+        #         "mermaidGraph", "No elements found"
+        #     )
+        # else:
+        #     return response.json().get("elementGraph", "No elements found")
+        if isinstance(response, str):
+            return "No elements found"
+        el_list = response.json().get("elementGraph", "No elements found")
+        if isinstance(el_list, str):
+            return el_list
+        if mermaid_only:
+            return el_list.get("mermaidGraph", "No mermaid graph found")
+        if len(el_list) == 0:
+            return "No elements returned"
+        return el_list
 
     def get_metadata_element_graph(
         self,
@@ -380,9 +425,10 @@ class MetadataExplorer(Client):
         as_of_time: str = None,
         for_lineage: bool = None,
         for_duplicate_processing: bool = None,
+        mermaid_only: bool = False,
     ) -> dict | str:
         """
-        Retrieve the metadata element using its unique identifier.
+        Retrieve the metadata element and all of its anchored elements using its unique identifier. Async version.
 
         Parameters
         ----------
@@ -396,11 +442,15 @@ class MetadataExplorer(Client):
             - determines if elements classified as Memento should be returned - normally false
         for_duplicate_processing: bool, default is set by server
             - Normally false. Set true when the caller is part of a deduplication function
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
         Returns
         -------
         dict | str
-            If the element is found, a dict of the element details is returned. Otherwise the string "No element found".
+            If the element is found, and mermaid_only is False, a dict of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -415,54 +465,59 @@ class MetadataExplorer(Client):
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
             self._async_get_metadata_element_graph(
-                guid, effective_time, as_of_time, for_lineage, for_duplicate_processing
+                guid,
+                effective_time,
+                as_of_time,
+                for_lineage,
+                for_duplicate_processing,
+                mermaid_only,
             )
         )
         return response
 
-    def get_metadata_element_mermaid_graph(
-        self,
-        guid: str,
-        effective_time: str = None,
-        as_of_time: str = None,
-        for_lineage: bool = None,
-        for_duplicate_processing: bool = None,
-    ) -> dict | str:
-        """
-        Retrieve the metadata element using its unique identifier.
-
-        Parameters
-        ----------
-        guid : str
-            - unique identifier of the element to retrieve
-        effective_time: str, default = None
-            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
-        as_of_time: str, default = None
-            - Query the element as of this time. If None, then use current time.
-        for_lineage: bool, default is set by server
-            - determines if elements classified as Memento should be returned - normally false
-        for_duplicate_processing: bool, default is set by server
-            - Normally false. Set true when the caller is part of a deduplication function
-
-        Returns
-        -------
-        dict | str
-            If the element is found, a dict of the element details is returned. Otherwise the string "No element found".
-
-        Raises
-        ------
-        InvalidParameterException
-            one of the parameters is null or invalid or
-        PropertyServerException
-            There is a problem adding the element properties to the metadata repository or
-        UserNotAuthorizedException
-            the requesting user is not authorized to issue this request.
-        """
-
-        response = self.get_metadata_element_graph(
-            guid, effective_time, as_of_time, for_lineage, for_duplicate_processing
-        )
-        return response.get("mermaidGraph", "No elements found")
+    # def get_metadata_element_mermaid_graph(
+    #     self,
+    #     guid: str,
+    #     effective_time: str = None,
+    #     as_of_time: str = None,
+    #     for_lineage: bool = None,
+    #     for_duplicate_processing: bool = None,
+    # ) -> dict | str:
+    #     """
+    #     Retrieve the metadata element using its unique identifier.
+    #
+    #     Parameters
+    #     ----------
+    #     guid : str
+    #         - unique identifier of the element to retrieve
+    #     effective_time: str, default = None
+    #         - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
+    #     as_of_time: str, default = None
+    #         - Query the element as of this time. If None, then use current time.
+    #     for_lineage: bool, default is set by server
+    #         - determines if elements classified as Memento should be returned - normally false
+    #     for_duplicate_processing: bool, default is set by server
+    #         - Normally false. Set true when the caller is part of a deduplication function
+    #
+    #     Returns
+    #     -------
+    #     dict | str
+    #         If the element is found, a dict of the element details is returned. Otherwise the string "No element found".
+    #
+    #     Raises
+    #     ------
+    #     InvalidParameterException
+    #         one of the parameters is null or invalid or
+    #     PropertyServerException
+    #         There is a problem adding the element properties to the metadata repository or
+    #     UserNotAuthorizedException
+    #         the requesting user is not authorized to issue this request.
+    #     """
+    #
+    #     response = self.get_metadata_element_graph(
+    #         guid, effective_time, as_of_time, for_lineage, for_duplicate_processing
+    #     )
+    #     return response.get("mermaidGraph", "No elements found")
 
     async def _async_get_metadata_element_by_unique_name(
         self,
@@ -897,6 +952,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve the metadata elements connected to the supplied element.
@@ -920,6 +976,9 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
+
 
         Returns
         -------
@@ -967,12 +1026,7 @@ class MetadataExplorer(Client):
         response: Response = await self._async_make_request(
             "POST", url, body_slimmer(body), time_out=time_out
         )
-
-        elements = response.json().get("elementList", "No elements found")
-        if type(elements) is list:
-            if len(elements) == 0:
-                return "No elements found"
-        return elements
+        return process_related_element_list(response, mermaid_only)
 
     def get_all_related_metadata_elements(
         self,
@@ -984,6 +1038,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve the metadata elements connected to the supplied element.
@@ -1006,6 +1061,9 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
+
 
         Returns
         -------
@@ -1045,6 +1103,7 @@ class MetadataExplorer(Client):
                 start_from,
                 page_size,
                 time_out,
+                mermaid_only,
             )
         )
         return response
@@ -1060,6 +1119,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve the metadata elements connected to the supplied element.
@@ -1085,6 +1145,8 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
         Returns
         -------
@@ -1133,11 +1195,7 @@ class MetadataExplorer(Client):
             "POST", url, body_slimmer(body), time_out=time_out
         )
 
-        elements = response.json().get("elementList", "No elements found")
-        if type(elements) is list:
-            if len(elements) == 0:
-                return "No elements found"
-        return elements
+        return process_related_element_list(response, mermaid_only)
 
     def get_related_metadata_elements(
         self,
@@ -1150,6 +1208,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve the metadata elements connected to the supplied element.
@@ -1174,6 +1233,8 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
         Returns
         -------
@@ -1214,6 +1275,7 @@ class MetadataExplorer(Client):
                 start_from,
                 page_size,
                 time_out,
+                mermaid_only,
             )
         )
         return response
@@ -1229,6 +1291,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve the relationships linking the supplied elements.
@@ -1254,6 +1317,9 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
+
 
         Returns
         -------
@@ -1303,11 +1369,7 @@ class MetadataExplorer(Client):
             "POST", url, body_slimmer(body), time_out=time_out
         )
 
-        elements = response.json().get("elementList", "No elements found")
-        if type(elements) is list:
-            if len(elements) == 0:
-                return "No elements found"
-        return elements
+        return process_related_element_list(response, mermaid_only)
 
     def get_all_metadata_element_relationships(
         self,
@@ -1320,6 +1382,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve the relationships linking the supplied elements.
@@ -1344,6 +1407,8 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
         Returns
         -------
@@ -1384,6 +1449,7 @@ class MetadataExplorer(Client):
                 start_from,
                 page_size,
                 time_out,
+                mermaid_only,
             )
         )
         return response
@@ -1400,6 +1466,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve the relationships linking the supplied elements.
@@ -1427,6 +1494,8 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
         Returns
         -------
@@ -1476,11 +1545,7 @@ class MetadataExplorer(Client):
             "POST", url, body_slimmer(body), time_out=time_out
         )
 
-        elements = response.json().get("elementList", "No elements found")
-        if type(elements) is list:
-            if len(elements) == 0:
-                return "No elements found"
-        return elements
+        return process_related_element_list(response, mermaid_only)
 
     def get_metadata_element_relationships(
         self,
@@ -1494,6 +1559,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve the relationships linking the supplied elements.
@@ -1520,6 +1586,9 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
+
 
         Returns
         -------
@@ -1561,6 +1630,7 @@ class MetadataExplorer(Client):
                 start_from,
                 page_size,
                 time_out,
+                mermaid_only,
             )
         )
         return response
@@ -2098,6 +2168,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve all the versions of a relationship. Async version.
@@ -2123,6 +2194,8 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
         Returns
         -------
@@ -2164,12 +2237,11 @@ class MetadataExplorer(Client):
         response: Response = await self._async_make_request(
             "POST", url, body_slimmer(body), time_out=time_out
         )
-
-        elements = response.json().get("elementList", "No elements found")
-        if type(elements) is list:
-            if len(elements) == 0:
-                return "No elements found"
-        return elements
+        rel = response.json().get("relationshipList", "No elements found")
+        if isinstance(rel, (list, dict)):
+            return rel.get("elementList", "No elements found")
+        else:
+            return rel
 
     def get_relationship_history(
         self,
@@ -2183,6 +2255,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve all the versions of a relationship.
@@ -2208,6 +2281,8 @@ class MetadataExplorer(Client):
              - maximum number of elements to return.
          time_out: int, default = default_time_out
              - http request timeout for this request
+         mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
          Returns
          -------
@@ -2237,6 +2312,7 @@ class MetadataExplorer(Client):
                 start_from,
                 page_size,
                 time_out,
+                mermaid_only,
             )
         )
         return response

pyegeria/valid_metadata_omvs.py

@@ -1421,7 +1421,7 @@ class ValidMetadataManager(Client):
         url = f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/open-metadata-types"
 
         resp = await self._async_make_request("GET", url)
-        return resp.json().get("typeDefs", "No TypeDefs Found")
+        return resp.json()
 
     def get_all_entity_types(self) -> list | str:
         """Returns the list of different types of metadata organized into two groups.  The first are the

{pyegeria-5.2.0.9.dist-info → pyegeria-5.2.0.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 5.2.0.9
+Version: 5.2.0.10
 Summary: A python client for Egeria
 Home-page: https://github.com/odpi/egeria-python
 License: Apache 2.0

{pyegeria-5.2.0.9.dist-info → pyegeria-5.2.0.10.dist-info}/RECORD

@@ -52,6 +52,8 @@ pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/CleanShot
 pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/CleanShot 2024-11-25 at 20.36.42@2x.png,sha256=ki-tG_CkXAa-SGajxkfkwHPaOw2uipUKYRf9H86FB_k,27874
 pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/CleanShot 2024-11-25 at 20.36.55@2x.png,sha256=Y3XWP5RB8tY93ChiAHEGU1oc-o5O-3RRoAIs9SnHdLc,98769
 pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/CleanShot 2024-11-25 at 20.37.07@2x.png,sha256=pJZ0Yz5bXAadZasEBzUTxFy_VRB216saLD6OkyjnOWQ,455058
+pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/CleanShot 2024-12-06 at 08.46.30@2x.png,sha256=IbIpTsOAKt-TyvH-_tTG9_jemENgeVZ5QIoMuVLhHFo,950898
+pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/CleanShot 2024-12-06 at 11.27.56@2x.png,sha256=PZKjjJIht9SUouRNu5m5gNmc62mI0BXycnS7GLCbLxA,337971
 pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/catalogs  2024-11-25 at 16.28.53@2x.png,sha256=VXRq9sOKApd5Vm1w5GwABI4RJM1V50R8S_rjQfNV3QI,171649
 pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-data-catalogs-2024-11-20 at 16.17.43@2x.png,sha256=MUgoH6orUk9qUeCv8yEjuQ6sAao3eZyK3DOF4aXfqkw,525598
 pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-schemas 2024-11-25 at 20.14.50@2x.png,sha256=W6_JDqWKBOqeEMTAteX7JJ_MIPOigc2ttD01UYBxNxg,443831
@@ -173,7 +175,7 @@ pyegeria/full_omag_server_config.py,sha256=k3fUfopAFAE3OKkFR7zZPiki_FYj6j2xQ4oD2
 pyegeria/glossary_browser_omvs.py,sha256=NcitYaZJqwVODBO5zBtWpXPNUJJ3DKzEbRaOFSAyUlg,93554
 pyegeria/glossary_manager_omvs.py,sha256=SWgPGkRag5hOXYM-cpbWI6oW_DXUZBt4ePtmOP7ZYUc,128787
 pyegeria/mermaid_utilities.py,sha256=GXiS-subb5nJcDqlThZWX2T8WspU1neFfhf4TxRoMh4,8344
-pyegeria/metadata_explorer_omvs.py,sha256=519Im5lyO0JaFqAr1xxQcPJ3jYMtC8OYXmh4Gj6DBPs,82282
+pyegeria/metadata_explorer_omvs.py,sha256=1Uf8xlRx440hRmUZxvRJHbUBQeuZgsL31j9D_1J3o9Y,85615
 pyegeria/my_profile_omvs.py,sha256=DyECbUFEcgokrIbzdMMNljC3bqfqKGXAF2wZEpzvRYs,34666
 pyegeria/platform_services.py,sha256=CJIOYIFEbcIGwdWlApAQcXxZTsdrhFtpJcm4O3p7dG0,41646
 pyegeria/project_manager_omvs.py,sha256=Y7Lyqh4jIujJrr_Ub7feo904FN_uz4R10T4hKhqE1Uw,67499
@@ -182,10 +184,10 @@ pyegeria/runtime_manager_omvs.py,sha256=ygrY5I_oSoJQun05W7wSNbZT_nOtPp_BkIKKFCLF
 pyegeria/server_operations.py,sha256=ciH890hYT85YQ6OpByn4w7s3a7TtvWZpIG5rkRqbcI0,16766
 pyegeria/template_manager_omvs.py,sha256=heqbKeum5hPCHap4r1RUZU8YB3QaQlxVNbq4GZimJtE,42450
 pyegeria/utils.py,sha256=1h6bwveadd6GpbnGLTmqPBmBk68QvxdjGTI9RfbrgKY,5415
-pyegeria/valid_metadata_omvs.py,sha256=tfCGXed5LLt59YA8uZNNtd9UJ-lRZfPU_uZxK31Yux0,65069
+pyegeria/valid_metadata_omvs.py,sha256=kmcyXBsu99L25r16w9xVXqU_KwADsGuft4yPDZzyUds,65032
 pyegeria/x_action_author_omvs.py,sha256=xu1IQ0YbhIKi17C5a7Aq9u1Az2czwahNPpX9czmyVxE,6454
-pyegeria-5.2.0.9.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-5.2.0.9.dist-info/METADATA,sha256=CK5MUg-H1pbtTDLxSY95cpD8_R8gj8y9CcnwzZ-IjHc,2879
-pyegeria-5.2.0.9.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyegeria-5.2.0.9.dist-info/entry_points.txt,sha256=JhYgb02izlV2wb7SIfCOMxeVISUd9YJvgDW1-kuHad4,5240
-pyegeria-5.2.0.9.dist-info/RECORD,,
+pyegeria-5.2.0.10.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-5.2.0.10.dist-info/METADATA,sha256=AR9GWexnjhSGIuUeXkVdOQyLxU904RF_mZb2LzcAE7M,2880
+pyegeria-5.2.0.10.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pyegeria-5.2.0.10.dist-info/entry_points.txt,sha256=JhYgb02izlV2wb7SIfCOMxeVISUd9YJvgDW1-kuHad4,5240
+pyegeria-5.2.0.10.dist-info/RECORD,,