Support str as param type

Author: FlorentinD

changelog.md

@@ -24,5 +24,6 @@
 * Allow passing the optional graph filter also as type `str` to `gds.graph.list()` instead of only `Graph`.
 * Listen and to SIGINT and SIGTERM and interrupt projection and write-backs based on GDS Session. Note this only works if the query runs in the main thread.
 * Avoid data copy by using the arrow-based DataFrame backend for arrow-based endpoints and if pandas>2.0
+* Support `node_properties` parameter also as type `str` instead of only list for endpoint `gds.graph.nodeProperties.stream`.
 
 ## Other changes

doc/sphinx/source/graph.rst

@@ -131,7 +131,7 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
     Removes node properties from a projected graph.
 
-.. py:function:: gds.graph.nodeProperties.stream(G: Graph,node_properties: List[str],node_labels: Strings = ["*"],separate_property_columns: bool = False, db_node_properties: List[str] = [], **config: Any,) -> DataFrame
+.. py:function:: gds.graph.nodeProperties.stream(G: Graph,node_properties: Union[List[str], str],node_labels: Strings = ["*"],separate_property_columns: bool = False, db_node_properties: List[str] = [], **config: Any,) -> DataFrame
 
     Streams the given node properties.
 

graphdatascience/graph/graph_entity_ops_runner.py

@@ -101,14 +101,17 @@ class GraphNodePropertiesRunner(GraphEntityOpsBaseRunner):
     def stream(
         self,
         G: Graph,
-        node_properties: list[str],
+        node_properties: Union[str, list[str]],
         node_labels: Strings = ["*"],
         separate_property_columns: bool = False,
         db_node_properties: list[str] = [],
         **config: Any,
     ) -> DataFrame:
         self._namespace += ".stream"
 
+        if isinstance(node_properties, str):
+            node_properties = [node_properties]
+
         # find if list contain duplicates
         if len(set(node_properties)) != len(node_properties):
             raise ValueError(f"The provided node_properties contain duplicate property names: `{node_properties}`.")

graphdatascience/tests/unit/test_graph_ops.py

@@ -263,6 +263,15 @@ def test_graph_nodeProperties_stream(runner: CollectingQueryRunner, gds: GraphDa
         "config": {"concurrency": 2},
     }
 
+    gds.graph.nodeProperties.stream(G, "dummyProp", "dummyLabel", concurrency=2)
+    assert runner.last_query() == "CALL gds.graph.nodeProperties.stream($graph_name, $properties, $entities, $config)"
+    assert runner.last_params() == {
+        "graph_name": "g",
+        "properties": ["dummyProp"],
+        "entities": "dummyLabel",
+        "config": {"concurrency": 2},
+    }
+
 
 def test_graph_streamRelationshipProperty(runner: CollectingQueryRunner, gds: GraphDataScience) -> None:
     G, _ = gds.graph.project("g", "*", "*")