Merge pull request #746 from neo4j-contrib/task/reserved-keys

Improve reserved keyword error ; add tests

neomodel/core.py

@@ -246,8 +246,21 @@ def __new__(mcs, name, bases, namespace):
         else:
             if "deleted" in namespace:
                 raise ValueError(
-                    "Class property called 'deleted' conflicts "
-                    "with neomodel internals."
+                    "Property name 'deleted' is not allowed as it conflicts with neomodel internals."
+                )
+            elif "id" in namespace:
+                raise ValueError(
+                    """
+                        Property name 'id' is not allowed as it conflicts with neomodel internals.
+                        Consider using 'uid' or 'identifier' as id is also a Neo4j internal.
+                    """
+                )
+            elif "element_id" in namespace:
+                raise ValueError(
+                    """
+                        Property name 'element_id' is not allowed as it conflicts with neomodel internals.
+                        Consider using 'uid' or 'identifier' as element_id is also a Neo4j internal.
+                    """
                 )
             for key, value in (
                 (x, y) for x, y in namespace.items() if isinstance(y, Property)

neomodel/relationship.py

@@ -10,6 +10,10 @@ def __new__(mcs, name, bases, dct):
         inst = super().__new__(mcs, name, bases, dct)
         for key, value in dct.items():
             if issubclass(value.__class__, Property):
+                if key == "source" or key == "target":
+                    raise ValueError(
+                        "Property names 'source' and 'target' are not allowed as they conflict with neomodel internals."
+                    )
                 value.name = key
                 value.owner = inst
 
@@ -153,4 +157,3 @@ def inflate(cls, rel):
         srel._end_node_element_id_property = rel.end_node.element_id
         srel.element_id_property = rel.element_id
         return srel
-

test/test_models.py

@@ -7,8 +7,10 @@
 from neomodel import (
     DateProperty,
     IntegerProperty,
+    Relationship,
     StringProperty,
     StructuredNode,
+    StructuredRel,
     install_labels,
 )
 from neomodel.core import db
@@ -296,3 +298,32 @@ class DateTest(StructuredNode):
         birthdate = DateProperty()
 
     user = DateTest(birthdate=datetime.now()).save()
+
+
+def test_reserved_property_keys():
+    error_match = r".*is not allowed as it conflicts with neomodel internals.*"
+    with raises(ValueError, match=error_match):
+
+        class ReservedPropertiesDeletedNode(StructuredNode):
+            deleted = StringProperty()
+
+    with raises(ValueError, match=error_match):
+
+        class ReservedPropertiesIdNode(StructuredNode):
+            id = StringProperty()
+
+    with raises(ValueError, match=error_match):
+
+        class ReservedPropertiesElementIdNode(StructuredNode):
+            element_id = StringProperty()
+
+    error_match = r"Property names 'source' and 'target' are not allowed as they conflict with neomodel internals."
+    with raises(ValueError, match=error_match):
+
+        class ReservedPropertiesSourceRel(StructuredRel):
+            source = StringProperty()
+
+    with raises(ValueError, match=error_match):
+
+        class ReservedPropertiesTargetRel(StructuredRel):
+            target = StringProperty()