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

pyegeria/metadata_explorer_omvs.py

@@ -16,7 +16,6 @@ from pyegeria import body_slimmer
 
 from pyegeria._client import Client, max_paging_size
 from pyegeria._globals import default_time_out
-from tests.test_classification_manager_omvs import element_guid
 
 
 def query_seperator(current_string):
@@ -209,6 +208,7 @@ class MetadataExplorer(Client):
         self,
         guid: str,
         effective_time: str = None,
+        as_of_time: str = None,
         for_lineage: bool = None,
         for_duplicate_processing: bool = None,
     ) -> dict | str:
@@ -221,6 +221,8 @@ class MetadataExplorer(Client):
             - 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
@@ -249,8 +251,9 @@ class MetadataExplorer(Client):
         )
 
         body = {
-            "class": "EffectiveTimeRequestBody",
+            "class": "AnyTimeRequestBody",
             "effectiveTime": effective_time,
+            "asOfTime": as_of_time,
         }
 
         url = (
@@ -266,6 +269,7 @@ class MetadataExplorer(Client):
         self,
         guid: str,
         effective_time: str = None,
+        as_of_time: str = None,
         for_lineage: bool = None,
         for_duplicate_processing: bool = None,
     ) -> dict | str:
@@ -278,6 +282,8 @@ class MetadataExplorer(Client):
             - 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
@@ -306,6 +312,158 @@ class MetadataExplorer(Client):
         )
         return response
 
+    async def _async_get_metadata_element_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 and all of its anchored elements using its unique identifier. Async version.
+
+        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.
+        """
+
+        possible_query_params = query_string(
+            [
+                ("forLineage", for_lineage),
+                ("forDuplicateProcessing", for_duplicate_processing),
+            ]
+        )
+
+        body = {
+            "class": "AnyTimeRequestBody",
+            "effectiveTime": effective_time,
+            "asOfTime": as_of_time,
+        }
+
+        url = (
+            f"{base_path(self, self.view_server)}/metadata-elements/{guid}/with-anchored-elements"
+            f"{possible_query_params}"
+        )
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body)
+        )
+        return response.json().get("elementGraph", "No elements found")
+
+    def get_metadata_element_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.
+        """
+
+        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
+            )
+        )
+        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")
+
     async def _async_get_metadata_element_by_unique_name(
         self,
         name: str,
@@ -1829,6 +1987,7 @@ class MetadataExplorer(Client):
         self,
         guid: str,
         effective_time: str = None,
+        as_of_time: str = None,
         for_lineage: bool = None,
         for_duplicate_processing: bool = None,
     ) -> dict | str:
@@ -1869,8 +2028,9 @@ class MetadataExplorer(Client):
         )
 
         body = {
-            "class": "EffectiveTimeRequestBody",
+            "class": "AnyTimeRequestBody",
             "effectiveTime": effective_time,
+            "asOfTime": as_of_time,
         }
 
         url = (

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

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

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

@@ -173,7 +173,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=gW9RNl5OOZge5CrCjHNlSSCVYidylcF4iIwueLF-Vhc,76181
+pyegeria/metadata_explorer_omvs.py,sha256=519Im5lyO0JaFqAr1xxQcPJ3jYMtC8OYXmh4Gj6DBPs,82282
 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
@@ -184,8 +184,8 @@ pyegeria/template_manager_omvs.py,sha256=heqbKeum5hPCHap4r1RUZU8YB3QaQlxVNbq4GZi
 pyegeria/utils.py,sha256=1h6bwveadd6GpbnGLTmqPBmBk68QvxdjGTI9RfbrgKY,5415
 pyegeria/valid_metadata_omvs.py,sha256=tfCGXed5LLt59YA8uZNNtd9UJ-lRZfPU_uZxK31Yux0,65069
 pyegeria/x_action_author_omvs.py,sha256=xu1IQ0YbhIKi17C5a7Aq9u1Az2czwahNPpX9czmyVxE,6454
-pyegeria-5.2.0.7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-5.2.0.7.dist-info/METADATA,sha256=idILXpl4tmI1A1vrlHbQ149zT3clApfPHmFo7NCG84E,2879
-pyegeria-5.2.0.7.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyegeria-5.2.0.7.dist-info/entry_points.txt,sha256=JhYgb02izlV2wb7SIfCOMxeVISUd9YJvgDW1-kuHad4,5240
-pyegeria-5.2.0.7.dist-info/RECORD,,
+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,,