Add get method to CatalogEndpoints

Author: DarthMax

graphdatascience/procedure_surface/api/catalog/catalog_endpoints.py

@@ -14,11 +14,27 @@
 
 
 class CatalogEndpoints(ABC):
+    @abstractmethod
+    def get(self, graph_name: str) -> GraphV2:
+        """Retrieve a handle to a graph from the graph catalog.
+
+        Parameters
+        ----------
+        graph_name
+            The name of the graph.
+
+        Returns
+        -------
+        GraphV2
+            A handle to the graph.
+        """
+        pass
+
     @abstractmethod
     def list(self, G: GraphV2 | str | None = None) -> list[GraphInfoWithDegrees]:
         """List graphs in the graph catalog.
 
-        Args:
+        Parameters:
             G (GraphV2 | str | None, optional): GraphV2 object or name to filter results.
                If None, list all graphs. Defaults to None.
 
@@ -32,7 +48,7 @@ def list(self, G: GraphV2 | str | None = None) -> list[GraphInfoWithDegrees]:
     def drop(self, G: GraphV2 | str, fail_if_missing: bool = True) -> GraphInfo | None:
         """Drop a graph from the graph catalog.
 
-        Args:
+        Parameters:
             G (GraphV2 | str): GraphV2 object or name to drop.
             fail_if_missing (bool): Whether to fail if the graph is missing. Defaults to True.
 

graphdatascience/procedure_surface/arrow/catalog/catalog_arrow_endpoints.py

@@ -52,6 +52,11 @@ def __init__(
             protocol_version = ProtocolVersionResolver(query_runner).resolve()
             self._project_protocol = ProjectProtocol.select(protocol_version)
 
+    def get(self, graph_name: str) -> GraphV2:
+        if not self.list(graph_name):
+            raise ValueError(f"A graph with name '{graph_name}' does not exist in the catalog.")
+        return get_graph(graph_name, self._arrow_client)
+
     def list(self, G: GraphV2 | str | None = None) -> list[GraphInfoWithDegrees]:
         graph_name: str | None = None
         if isinstance(G, GraphV2):

graphdatascience/procedure_surface/cypher/catalog_cypher_endpoints.py

@@ -33,6 +33,11 @@ def __init__(self, cypher_runner: Neo4jQueryRunner, arrow_client: GdsArrowClient
         self.cypher_runner = cypher_runner
         self._arrow_client = arrow_client
 
+    def get(self, graph_name: str) -> GraphV2:
+        if not self.list(graph_name):
+            raise ValueError(f"A graph with name '{graph_name}' does not exist in the catalog.")
+        return get_graph(graph_name, self.cypher_runner)
+
     def list(self, G: GraphV2 | str | None = None) -> list[GraphInfoWithDegrees]:
         graph_name = G if isinstance(G, str) else G.name() if G is not None else None
         params = CallParameters(graphName=graph_name) if graph_name else CallParameters()