Merge pull request #546 from FlorentinD/drop-graphs-from-str

Allow gds.graph.drop by graph name

Author: FlorentinD

changelog.md

@@ -17,6 +17,7 @@
 ## Improvements
 
 * Expose user facing custom types so that they can be directly imported from `graphdatascience`.
+* Allow dropping graphs through `gds.graph.drop` by name and not only based on `Graph` objects.
 
 
 ## Other changes

graphdatascience/graph/graph_proc_runner.py

@@ -294,18 +294,20 @@ def ogbl(self) -> OGBLLoader:
         self._namespace += ".ogbl"
         return OGBLLoader(self._query_runner, self._namespace, self._server_version)
 
-    @graph_type_check
     def drop(
         self,
-        G: Graph,
+        graph: Union[Graph, str],
         failIfMissing: bool = False,
         dbName: str = "",
         username: Optional[str] = None,
     ) -> Optional["Series[Any]"]:
         self._namespace += ".drop"
 
+        if isinstance(graph, Graph):
+            graph = graph.name()
+
         params = CallParameters(
-            graph_name=G.name(),
+            graph_name=graph,
             fail_if_missing=failIfMissing,
             db_name=dbName,
         )

graphdatascience/tests/integration/conftest.py

@@ -110,7 +110,7 @@ def clean_up(gds: GraphDataScience) -> Generator[None, None, None]:
 
     res = gds.graph.list()
     for graph_name in res["graphName"]:
-        gds.graph.get(graph_name).drop(failIfMissing=True)
+        gds.graph.drop(graph_name, failIfMissing=True)
 
     res = gds.pipeline.list() if gds.server_version() >= ServerVersion(2, 5, 0) else gds.beta.pipeline.list()
     for pipeline_name in res["pipelineName"]:

graphdatascience/tests/integration/test_edge_embedding_model.py

@@ -4,7 +4,6 @@
 
 from graphdatascience.graph_data_science import GraphDataScience
 from graphdatascience.model.simple_rel_embedding_model import SimpleRelEmbeddingModel
-from graphdatascience.query_runner.neo4j_query_runner import Neo4jQueryRunner
 from graphdatascience.server_version.server_version import ServerVersion
 
 GRAPH_NAME = "g"
@@ -21,9 +20,9 @@
 
 
 @pytest.fixture(autouse=True)
-def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
+def run_around_tests(gds: GraphDataScience) -> Generator[None, None, None]:
     # Runs before each test
-    runner.run_cypher(
+    gds.run_cypher(
         """
         CREATE
         (a: Node {x: 1, y: 2, z: [42.1, 131.0, 12.99]}),
@@ -39,8 +38,8 @@ def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
     yield  # Test runs here
 
     # Runs after each test
-    runner.run_cypher("MATCH (n) DETACH DELETE n")
-    runner.run_cypher(f"CALL gds.graph.drop('{GRAPH_NAME}', false)")
+    gds.run_cypher("MATCH (n) DETACH DELETE n")
+    gds.graph.drop(GRAPH_NAME)
 
 
 @pytest.fixture

graphdatascience/tests/integration/test_error_handling.py

@@ -3,15 +3,14 @@
 import pytest
 
 from graphdatascience import GraphDataScience
-from graphdatascience.query_runner.neo4j_query_runner import Neo4jQueryRunner
 
 GRAPH_NAME = "g"
 
 
 @pytest.fixture(autouse=True)
-def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
+def run_around_tests(gds: GraphDataScience) -> Generator[None, None, None]:
     # Runs before each test
-    runner.run_cypher(
+    gds.run_cypher(
         """
         CREATE
         (a: Node),
@@ -26,8 +25,8 @@ def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
     yield  # Test runs here
 
     # Runs after each test
-    runner.run_cypher("MATCH (n) DETACH DELETE n")
-    runner.run_cypher(f"CALL gds.graph.drop('{GRAPH_NAME}', false)")
+    gds.run_cypher("MATCH (n) DETACH DELETE n")
+    gds.graph.drop(GRAPH_NAME)
 
 
 def test_bogus_algo(gds: GraphDataScience) -> None:

graphdatascience/tests/integration/test_graph_construct.py

@@ -6,17 +6,16 @@
 
 from graphdatascience.graph_data_science import GraphDataScience
 from graphdatascience.query_runner.arrow_query_runner import ArrowQueryRunner
-from graphdatascience.query_runner.neo4j_query_runner import Neo4jQueryRunner
 from graphdatascience.server_version.server_version import ServerVersion
 from graphdatascience.tests.integration.conftest import AUTH, URI
 
 GRAPH_NAME = "g"
 
 
 @pytest.fixture(autouse=True)
-def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
+def run_around_tests(gds: GraphDataScience) -> Generator[None, None, None]:
     # Runs before each test
-    runner.run_cypher(
+    gds.run_cypher(
         """
         CREATE
         (a: Node {x: 1, y: 2, z: [42]}),
@@ -32,8 +31,8 @@ def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
     yield  # Test runs here
 
     # Runs after each test
-    runner.run_cypher("MATCH (n) DETACH DELETE n")
-    runner.run_cypher(f"CALL gds.graph.drop('{GRAPH_NAME}', false) YIELD graphName")
+    gds.run_cypher("MATCH (n) DETACH DELETE n")
+    gds.graph.drop(GRAPH_NAME)
 
 
 @pytest.mark.filterwarnings("ignore: GDS Enterprise users can use Apache Arrow")

graphdatascience/tests/integration/test_graph_ops.py

@@ -6,7 +6,6 @@
 
 from graphdatascience.graph_data_science import GraphDataScience
 from graphdatascience.query_runner.arrow_query_runner import ArrowQueryRunner
-from graphdatascience.query_runner.neo4j_query_runner import Neo4jQueryRunner
 from graphdatascience.query_runner.query_runner import QueryRunner
 from graphdatascience.server_version.server_version import ServerVersion
 from graphdatascience.tests.integration.conftest import AUTH, DB, URI
@@ -15,9 +14,9 @@
 
 
 @pytest.fixture(autouse=True)
-def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
+def run_around_tests(gds: GraphDataScience) -> Generator[None, None, None]:
     # Runs before each test
-    runner.run_cypher(
+    gds.run_cypher(
         """
         CREATE
         (a: Node {x: 1, y: 2, z: [42], name: "nodeA"}),
@@ -33,8 +32,8 @@ def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
     yield  # Test runs here
 
     # Runs after each test
-    runner.run_cypher("MATCH (n) DETACH DELETE n")
-    runner.run_cypher(f"CALL gds.graph.drop('{GRAPH_NAME}', false)")
+    gds.run_cypher("MATCH (n) DETACH DELETE n")
+    gds.graph.drop(GRAPH_NAME, failIfMissing=False)
 
 
 def test_project_graph_native(gds: GraphDataScience) -> None:
@@ -109,7 +108,7 @@ def test_beta_project_subgraph(runner: QueryRunner, gds: GraphDataScience) -> No
     result2 = gds.graph.list(sub_G)
     assert result2["nodeCount"][0] == 2
 
-    runner.run_cypher(f"CALL gds.graph.drop('{sub_G.name()}')")
+    gds.graph.drop(sub_G)
 
 
 @pytest.mark.compatible_with(min_inclusive=ServerVersion(2, 5, 0))
@@ -124,7 +123,7 @@ def test_project_subgraph(runner: QueryRunner, gds: GraphDataScience) -> None:
     result2 = gds.graph.list(sub_G)
     assert result2["nodeCount"][0] == 2
 
-    runner.run_cypher(f"CALL gds.graph.drop('{sub_G.name()}')")
+    gds.graph.drop(sub_G)
 
 
 @pytest.mark.compatible_with(min_inclusive=ServerVersion(2, 4, 0))
@@ -139,7 +138,7 @@ def test_sample_rwr(runner: QueryRunner, gds: GraphDataScience) -> None:
     result2 = gds.graph.list(rwr_G)
     assert result2["nodeCount"][0] == 2
 
-    runner.run_cypher(f"CALL gds.graph.drop('{rwr_G.name()}')")
+    gds.graph.drop(rwr_G)
 
 
 @pytest.mark.skip_on_aura  # The alpha procedure is not part of the allowlist
@@ -159,7 +158,7 @@ def test_sample_rwr_alpha(runner: QueryRunner, gds: GraphDataScience) -> None:
     result2 = gds.graph.list(rwr_G)
     assert result2["nodeCount"][0] == 2
 
-    runner.run_cypher(f"CALL gds.graph.drop('{rwr_G.name()}')")
+    gds.graph.drop(rwr_G)
 
 
 @pytest.mark.compatible_with(min_inclusive=ServerVersion(2, 4, 0))
@@ -174,7 +173,7 @@ def test_sample_cnarw(runner: QueryRunner, gds: GraphDataScience) -> None:
     result2 = gds.graph.list(cnarw_G)
     assert result2["nodeCount"][0] == 2
 
-    runner.run_cypher(f"CALL gds.graph.drop('{cnarw_G.name()}')")
+    gds.graph.drop(cnarw_G)
 
 
 @pytest.mark.compatible_with(min_inclusive=ServerVersion(2, 4, 0))
@@ -253,7 +252,7 @@ def test_graph_type_check(gds: GraphDataScience) -> None:
             "To resolve a graph name string into a `Graph` object, please use `gds.graph.get`"
         ),
     ):
-        gds.graph.drop(G.name(), True)  # type: ignore
+        gds.graph.list(G.name())  # type: ignore
 
     result = gds.graph.drop(G, True)
     assert result is not None

graphdatascience/tests/integration/test_simple_algo.py

@@ -9,9 +9,9 @@
 
 
 @fixture(autouse=True)
-def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
+def run_around_tests(gds: GraphDataScience) -> Generator[None, None, None]:
     # Runs before each test
-    runner.run_cypher(
+    gds.run_cypher(
         """
         CREATE
         (a: Node),
@@ -26,11 +26,11 @@ def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
     yield  # Test runs here
 
     # Runs after each test
-    runner.run_cypher("MATCH (n) DETACH DELETE n")
-    runner.run_cypher(f"CALL gds.graph.drop('{GRAPH_NAME}')")
+    gds.run_cypher("MATCH (n) DETACH DELETE n")
+    gds.graph.drop(GRAPH_NAME)
 
 
-def test_pageRank_mutate(runner: Neo4jQueryRunner, gds: GraphDataScience) -> None:
+def test_pageRank_mutate(gds: GraphDataScience) -> None:
     G, _ = gds.graph.project(GRAPH_NAME, "*", "*")
 
     result = gds.pageRank.mutate(G, mutateProperty="rank", dampingFactor=0.2, tolerance=0.3)

graphdatascience/tests/integration/test_single_mode_algos.py

@@ -4,16 +4,15 @@
 from pytest import fixture
 
 from graphdatascience.graph_data_science import GraphDataScience
-from graphdatascience.query_runner.neo4j_query_runner import Neo4jQueryRunner
 from graphdatascience.server_version.server_version import ServerVersion
 
 GRAPH_NAME = "g"
 
 
 @fixture(autouse=True)
-def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
+def run_around_tests(gds: GraphDataScience) -> Generator[None, None, None]:
     # Runs before each test
-    runner.run_cypher(
+    gds.run_cypher(
         """
         CREATE
         (a: Node),
@@ -28,8 +27,8 @@ def run_around_tests(runner: Neo4jQueryRunner) -> Generator[None, None, None]:
     yield  # Test runs here
 
     # Runs after each test
-    runner.run_cypher("MATCH (n) DETACH DELETE n")
-    runner.run_cypher(f"CALL gds.graph.drop('{GRAPH_NAME}')")
+    gds.run_cypher("MATCH (n) DETACH DELETE n")
+    gds.graph.drop(GRAPH_NAME)
 
 
 @pytest.mark.compatible_with(min_inclusive=ServerVersion(2, 5, 0))