[WIP] node properties alias

Author: knutwalker

graphdatascience/graph/graph_cypher_runner.py

@@ -195,6 +195,9 @@ def project(
 
         match_part = str(match_part)
 
+        print("nodes", nodes)
+        print("labels", label_mappings)
+
         case_part = []
         if label_mappings:
             with_rel = f", {rel_var}" if rel_var else ""
@@ -273,14 +276,21 @@ def _node_properties_spec(self, spec: Any, name: Optional[str] = None) -> NodePr
         if isinstance(spec, str):
             return NodeProperty(name=name or spec, property_key=spec)
 
-        if name is None:
-            raise ValueError(f"Node properties spec must be used with the dict syntax: {spec}")
+        if isinstance(spec, dict):
+            name = spec.pop("name", name)
+            if name is None:
+                raise ValueError(
+                    f"Node properties must specify either a name in the outer dict or by using the `name` key: {spec}"
+                )
+            property_key = spec.pop("property_key", name)
+
+            return NodeProperty(name=name, property_key=property_key, **spec)
 
         if spec is True:
-            return NodeProperty(name=name, property_key=name)
+            if name is None:
+                raise ValueError(f"Node properties spec must be used with the dict syntax: {spec}")
 
-        if isinstance(spec, dict):
-            return NodeProperty(name=name, property_key=name, **spec)
+            return NodeProperty(name=name, property_key=name)
 
         raise TypeError(f"Invalid node property specification: {spec}")
 

graphdatascience/tests/unit/test_graph_cypher.py

@@ -220,8 +220,11 @@ def test_multiple_multi_graph(runner: CollectingQueryRunner, gds: GraphDataScien
 
 @pytest.mark.parametrize("server_version", [ServerVersion(2, 4, 0)])
 def test_node_properties(runner: CollectingQueryRunner, gds: GraphDataScience) -> None:
+    # G, _ = gds.graph.cypher.project(
+    #     "g", nodes=dict(L1=["prop1"], L2=["prop2", "prop3"], L3=dict(prop4=True, prop5=dict()))
+    # )
     G, _ = gds.graph.cypher.project(
-        "g", nodes=dict(L1=["prop1"], L2=["prop2", "prop3"], L3=dict(prop4=True, prop5=dict()))
+        "g", nodes={"L1": ["prop1"], "L2": ["prop2", "prop3"], "L3": {"prop4": True, "prop5": {}}}
     )
 
     assert G.name() == "g"
@@ -247,3 +250,25 @@ def test_node_properties(runner: CollectingQueryRunner, gds: GraphDataScience) -
         "sourceNodeProperties: sourceNodeProperties, "
         "targetNodeProperties: targetNodeProperties})"
     )
+
+
+@pytest.mark.parametrize("server_version", [ServerVersion(2, 4, 0)])
+def test_node_properties_alias(runner: CollectingQueryRunner, gds: GraphDataScience) -> None:
+    G, _ = gds.graph.cypher.project(
+        "g", nodes=dict(A=dict(target_prop1="source_prop1", target_prop2=dict(property_key="source_prop2")))
+    )
+
+    assert G.name() == "g"
+    assert runner.last_params() == dict(graph_name="g")
+
+    assert runner.last_query() == (
+        """MATCH (source:A)-->(target:A)
+WITH source, target, """
+        "[{target_prop1: source.source_prop1, target_prop1: source.source_prop2}] AS sourceNodeProperties"
+        """[{target_prop1: target.source_prop1, target_prop1: target.source_prop2}] AS targetNodeProperties
+ RETURN gds.graph.project($graph_name, source, target, {"""
+        "sourceNodeLabels: labels(source), "
+        "targetNodeLabels: labels(target), "
+        "sourceNodeProperties: sourceNodeProperties, "
+        "targetNodeProperties: targetNodeProperties})"
+    )