pyegeria 0.8.4.44__py3-none-any.whl → 0.8.4.45__py3-none-any.whl

commands/tech/list_related_elements.py

@@ -32,7 +32,7 @@ EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
 EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
 EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
 EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
-EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "220"))
 
 
 def list_related_elements(
@@ -49,14 +49,13 @@ def list_related_elements(
     c_client = EgeriaTech(server, url, user_id=username, user_pwd=password)
     token = c_client.create_egeria_bearer_token()
 
-    om_typedef = c_client.get_typedef_by_name(om_type)
-    if type(om_typedef) is str:
-        print(
-            f"The type name '{om_type}' is not known to the Egeria platform at {url} - {server}"
-        )
-        sys.exit(1)
-
-    elements = c_client.get_related_elements(element_guid, relationship_type, om_type)
+    if om_type is not None:
+        om_typedef = c_client.get_typedef_by_name(om_type)
+        if type(om_typedef) is str:
+            print(
+                f"The type name '{om_type}' is not known to the Egeria platform at {url} - {server}"
+            )
+            sys.exit(1)
 
     def generate_table() -> Table:
         """Make a new table."""
@@ -69,33 +68,42 @@ def list_related_elements(
             caption_style="white on black",
             show_lines=True,
             box=box.ROUNDED,
-            title=f"Elements for Open Metadata Type: '{om_type}' ",
+            title=f"Elements related to: '{element_guid}' ",
             expand=True,
             # width=500
         )
-
-        table.add_column("Qualified Name")
-        table.add_column("Type")
-        table.add_column("Created")
-        table.add_column("Home Store")
-        table.add_column("GUID", width=38, no_wrap=True)
+        table.add_column("Relationship GUID", width=38, no_wrap=True)
+        table.add_column("Rel Header", width=38, no_wrap=True)
+        table.add_column("Relationship Props")
+        table.add_column("Related GUID", width=38, no_wrap=True)
         table.add_column("Properties")
-        table.add_column("Classifications")
+        table.add_column("Element Header")
+
+        elements = c_client.get_related_elements(
+            element_guid, relationship_type, om_type
+        )
 
         if type(elements) is list:
             for element in elements:
-                header = element["elementHeader"]
-                el_q_name = element["properties"].get("qualifiedName", "---")
+                header = element["relationshipHeader"]
                 el_type = header["type"]["typeName"]
                 el_home = header["origin"]["homeMetadataCollectionName"]
                 el_create_time = header["versions"]["createTime"][:-10]
                 el_guid = header["guid"]
                 el_class = header.get("classifications", "---")
+                rel_header_md = (
+                    f"* Type: {el_type}\n"
+                    f"* Home: {el_home}\n"
+                    f"* Created: {el_create_time}\n"
+                )
+                rel_header_out = Markdown(rel_header_md)
 
-                el_props_md = ""
-                for prop in element["properties"].keys():
-                    el_props_md += f"* **{prop}**: {element['properties'][prop]}\n"
-                el_props_out = Markdown(el_props_md)
+                rel_props_md = ""
+                for prop in element["relationshipProperties"].keys():
+                    rel_props_md += (
+                        f"* **{prop}**: {element['relationshipProperties'][prop]}\n"
+                    )
+                rel_props_out = Markdown(rel_props_md)
 
                 c_md = ""
                 if type(el_class) is list:
@@ -112,14 +120,30 @@ def list_related_elements(
                                 c_md += f"  * **{prop}**: {class_props[prop]}\n"
                 c_md_out = Markdown(c_md)
 
+                rel_element = element["relatedElement"]
+                rel_el_header = rel_element["elementHeader"]
+                rel_type = rel_el_header["type"]["typeName"]
+                rel_home = rel_el_header["origin"]["homeMetadataCollectionName"]
+                rel_guid = rel_el_header["guid"]
+
+                rel_el_header_md = f"* Type: {rel_type}\n" f"* Home: {rel_home}\n"
+                rel_el_header_out = Markdown(rel_el_header_md)
+
+                rel_el_props_md = ""
+                for prop in rel_element["properties"].keys():
+                    rel_el_props_md += (
+                        f"* **{prop}**: {rel_element['properties'][prop]}\n"
+                    )
+                rel_el_props_out = Markdown(rel_el_props_md)
+
                 table.add_row(
-                    el_q_name,
-                    el_type,
-                    el_create_time,
-                    el_home,
                     el_guid,
-                    el_props_out,
-                    c_md_out,
+                    rel_header_out,
+                    rel_props_out,
+                    # el_q_name,
+                    rel_guid,
+                    rel_el_props_out,
+                    rel_el_header_out,
                 )
 
             return table
@@ -159,11 +183,15 @@ def main():
     password = args.password if args.password is not None else EGERIA_USER_PASSWORD
 
     try:
-        element_guid = Prompt.ask("Guid of base element")
-        om_type = Prompt.ask(
-            "Enter the Open Metadata Type to find elements of:", default="Project"
+        element_guid = Prompt.ask("Guid of base element").strip()
+        om_type = Prompt.ask("Enter the Open Metadata Type to find elements of")
+        relationship_type = Prompt.ask("Enter the relationship type to follow")
+
+        om_type = None if len(om_type) == 0 else om_type.strip()
+        relationship_type = (
+            None if len(relationship_type) == 0 else relationship_type.strip()
         )
-        relationship_type = Prompt.ask("Enter the relationship type to follow: ")
+
         list_related_elements(
             element_guid, om_type, relationship_type, server, url, userid, password
         )

pyegeria/classification_manager_omvs.py

@@ -1494,169 +1494,11 @@ class ClassificationManager(Client):
     #
     #   related elements
     #
-    async def _async_get_all_related_elements(
-        self,
-        element_guid: str,
-        open_metadata_type_name: str = None,
-        start_at_end: int = 1,
-        effective_time: str = None,
-        for_lineage: bool = None,
-        for_duplicate_processing: bool = None,
-        start_from: int = 0,
-        page_size: int = max_paging_size,
-        time_out: int = default_time_out,
-    ) -> list | str:
-        """
-        Retrieve elements linked any relationship type name. It is also possible to limit the results by
-        specifying a type name for the elements that should be returned. If no type name is specified then any type of
-        element may be returned. Async version.
-
-        https://egeria-project.org/types/
-
-        Parameters
-        ----------
-        element_guid: str
-            - the base element to get related elements for
-        open_metadata_type_name : str, default = None
-            - open metadata type to be used to restrict the search
-        start_at_end: int, default = 1
-            - The end of the relationship to start from - typically End1
-        effective_time: str, default = None
-            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
-        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
-        start_from: int, default = 0
-            - index of the list to start from (0 for start).
-        page_size
-            - maximum number of elements to return.
-
-
-        time_out: int, default = default_time_out
-            - http request timeout for this request
-
-        Returns
-        -------
-        [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
-
-        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.
-        """
-
-        possible_query_params = query_string(
-            [
-                ("startFrom", start_from),
-                ("pageSize", page_size),
-                ("forLineage", for_lineage),
-                ("forDuplicateProcessing", for_duplicate_processing),
-                ("startAtEnd", start_at_end),
-            ]
-        )
-
-        body = {
-            "class": "FindProperties",
-            "openMetadataTypeName": open_metadata_type_name,
-            "effectiveTime": effective_time,
-        }
-
-        url = (
-            f"{base_path(self, self.view_server)}/elements/{element_guid}/by-relationship"
-            f"{possible_query_params}"
-        )
-        response: Response = await self._async_make_request(
-            "POST", url, body_slimmer(body), time_out=time_out
-        )
-        elements = response.json().get("elements", "No elements found")
-        if type(elements) is list:
-            if len(elements) == 0:
-                return "No elements found"
-        return elements
-
-    def get_all_related_elements(
-        self,
-        element_guid: str,
-        open_metadata_type_name: str = None,
-        start_at_end: int = 1,
-        effective_time: str = None,
-        for_lineage: bool = None,
-        for_duplicate_processing: bool = None,
-        start_from: int = 0,
-        page_size: int = max_paging_size,
-        time_out: int = default_time_out,
-    ) -> list | str:
-        """
-        Retrieve elements linked via any relationship type name. It is also possible to limit the results by
-        specifying a type name for the elements that should be returned. If no type name is specified then any type of
-        element may be returned.
-
-        https://egeria-project.org/types/
-
-        Parameters
-        ----------
-        element_guid: str
-            - the base element to get related elements for
-        open_metadata_type_name : str, default = None
-            - open metadata type to be used to restrict the search
-        start_at_end: int, default = 1
-            - The end of the relationship to start from - typically End1
-        effective_time: str, default = None
-            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
-        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
-        start_from: int, default = 0
-            - index of the list to start from (0 for start).
-        page_size
-            - maximum number of elements to return.
-
-
-        time_out: int, default = default_time_out
-            - http request timeout for this request
-
-        Returns
-        -------
-        [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
-
-        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.
-        """
-
-        loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(
-            self._async_get_all_related_elements(
-                element_guid,
-                open_metadata_type_name,
-                start_at_end,
-                effective_time,
-                for_lineage,
-                for_duplicate_processing,
-                start_from,
-                page_size,
-                time_out,
-            )
-        )
-        return response
 
     async def _async_get_related_elements(
         self,
         element_guid: str,
-        relationship_type: str,
+        relationship_type: str = None,
         open_metadata_type_name: str = None,
         start_at_end: int = 1,
         effective_time: str = None,
@@ -1667,9 +1509,9 @@ class ClassificationManager(Client):
         time_out: int = default_time_out,
     ) -> list | str:
         """
-        Retrieve elements linked any relationship type name. It is also possible to limit the results by
-        specifying a type name for the elements that should be returned. If no type name is specified then any type of
-        element may be returned. Async version.
+        Retrieve elements linked by relationship type name. If the relationship type is None, then all related elements
+        will be returned. It is also possible to limit the results by specifying a type name for the elements that
+        should be returned. If no type name is specified then any type of element may be returned. Async version.
 
         https://egeria-project.org/types/
 
@@ -1677,8 +1519,9 @@ class ClassificationManager(Client):
         ----------
         element_guid: str
             - the base element to get related elements for
-        relationship_type: str
-            - the type of relationship to navigate to related elements
+        relationship_type: str, optional, default = None
+            - the type of relationship to navigate to related elements.
+              If None, then all related elements will be returned.
         open_metadata_type_name : str, default = None
             - open metadata type to be used to restrict the search
         start_at_end: int, default = 1
@@ -1729,10 +1572,17 @@ class ClassificationManager(Client):
             "effectiveTime": effective_time,
         }
 
-        url = (
-            f"{base_path(self, self.view_server)}/elements/{element_guid}/by-relationship/"
-            f"{relationship_type}{possible_query_params}"
-        )
+        if relationship_type is None:
+            url = (
+                f"{base_path(self, self.view_server)}/elements/{element_guid}/by-relationship"
+                f"{possible_query_params}"
+            )
+        else:
+            url = (
+                f"{base_path(self, self.view_server)}/elements/{element_guid}/by-relationship/"
+                f"{relationship_type}{possible_query_params}"
+            )
+
         response: Response = await self._async_make_request(
             "POST", url, body_slimmer(body), time_out=time_out
         )
@@ -1745,7 +1595,7 @@ class ClassificationManager(Client):
     def get_related_elements(
         self,
         element_guid: str,
-        relationship_type: str,
+        relationship_type: str = None,
         open_metadata_type_name: str = None,
         start_at_end: int = 1,
         effective_time: str = None,
@@ -1756,9 +1606,9 @@ class ClassificationManager(Client):
         time_out: int = default_time_out,
     ) -> list | str:
         """
-        Retrieve elements linked via any relationship type name. It is also possible to limit the results by
-        specifying a type name for the elements that should be returned. If no type name is specified then any type of
-        element may be returned.
+        Retrieve elements linked by relationship type name. If the relationship type is None, then all related elements
+        will be returned. It is also possible to limit the results by specifying a type name for the elements that
+        should be returned. If no type name is specified then any type of element may be returned.
 
         https://egeria-project.org/types/
 

{pyegeria-0.8.4.44.dist-info → pyegeria-0.8.4.45.dist-info}/METADATA

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

{pyegeria-0.8.4.44.dist-info → pyegeria-0.8.4.45.dist-info}/RECORD

@@ -56,7 +56,7 @@ commands/tech/list_elements.py,sha256=vO4SPEhcKm0L5rHVr6r8KYX3sPazGJ78oWsO2wLcf2
 commands/tech/list_elements_for_classification.py,sha256=oAge8RFz4z9H-jCE0fBDhS4AbIHqhQWBvZ4Dp7BZbfM,6194
 commands/tech/list_elements_x.py,sha256=k5jkekB7wh6cbzjn7FnwL7pKrPFq_oE-x36c_Z1FuSo,6500
 commands/tech/list_registered_services.py,sha256=QzE_ebdopNkHWMxa-xc902GG6ac4Yw-ln8i8NUsgHVA,6542
-commands/tech/list_related_elements.py,sha256=syDB5ujhWvPl8HmG2a1_GfCG29pXS6VOzN3XE621RvQ,6321
+commands/tech/list_related_elements.py,sha256=rM7YJ1rSWQTsPePMxlw2rEb5QC5jOX1HjypqWhmvquA,7607
 commands/tech/list_related_specification.py,sha256=mWrKenXOskL4cl0DHjH2Z8M9-FJzjkzK62W-tsx3WDU,5918
 commands/tech/list_relationship_types.py,sha256=BlVzrPznZXqMVLN2-2vYEVRGeYsiJrqXxIJEikobyoo,5875
 commands/tech/list_tech_templates.py,sha256=RiyA8a4fIL9BGeGf37Bkk471mK5ECkDJMN9QVNReC1M,6192
@@ -70,7 +70,7 @@ pyegeria/_globals.py,sha256=1Uc8392wjbiVN5L__RzxC1-U97RMXj77_iUsMSgeAjQ,638
 pyegeria/_validators.py,sha256=rnZelHJnjHaLZ8UhUTDyB59MfIUJifhALtkYoHBaos4,12736
 pyegeria/asset_catalog_omvs.py,sha256=fffZsSukOrG-xszD6uEPf2IX4p0IK63T0_w7_6BpG1Q,21075
 pyegeria/automated_curation_omvs.py,sha256=TQfA1_Evy6oQECtxYULeZUuPPRiSxwSMXcid2qytcHI,133257
-pyegeria/classification_manager_omvs.py,sha256=vqKZXp8XW0UKnMdkYrBCr81XdFdhPiREWsq4-mlftT4,186351
+pyegeria/classification_manager_omvs.py,sha256=Op6JqnJWMoIRkgzRr__P-mnROSaoWBq54cnjuAhoo5Q,180808
 pyegeria/collection_manager_omvs.py,sha256=kye2kjthNnmwxMZhHQKV0xoHbxcNPWjNzRAYOItj_gY,99201
 pyegeria/core_omag_server_config.py,sha256=EtHaPKyc9d6pwTgbnQqGwe5lSBMPIfJOlbJEa1zg1JA,94946
 pyegeria/create_tech_guid_lists.py,sha256=HHkC6HW58EN1BiolrYSRqSE0JhPbTepOFzwtdwBxVaU,4640
@@ -93,8 +93,8 @@ pyegeria/server_operations.py,sha256=ciH890hYT85YQ6OpByn4w7s3a7TtvWZpIG5rkRqbcI0
 pyegeria/utils.py,sha256=1h6bwveadd6GpbnGLTmqPBmBk68QvxdjGTI9RfbrgKY,5415
 pyegeria/valid_metadata_omvs.py,sha256=raBU_bK0oMhOqjOUTSbU_OZuGKsYqRoiFbtUwz4OtZI,29060
 pyegeria/x_action_author_omvs.py,sha256=xu1IQ0YbhIKi17C5a7Aq9u1Az2czwahNPpX9czmyVxE,6454
-pyegeria-0.8.4.44.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-0.8.4.44.dist-info/METADATA,sha256=a-zfS0OW2e5-RFjSsbWkynA-WszU6ydU5lEHCwYl16w,2868
-pyegeria-0.8.4.44.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyegeria-0.8.4.44.dist-info/entry_points.txt,sha256=flo8ASXXBWDaip5ThOzzOKq0U6BMdVO27MHjXWZRXOw,3496
-pyegeria-0.8.4.44.dist-info/RECORD,,
+pyegeria-0.8.4.45.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-0.8.4.45.dist-info/METADATA,sha256=g_Eni-Iwrn3MkWF0xzpAiRjDgQk256NWNGUWvANwPgk,2868
+pyegeria-0.8.4.45.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pyegeria-0.8.4.45.dist-info/entry_points.txt,sha256=flo8ASXXBWDaip5ThOzzOKq0U6BMdVO27MHjXWZRXOw,3496
+pyegeria-0.8.4.45.dist-info/RECORD,,