Merge pull request #910 from billycalladine/issue/909

issue/909 - Restore cardinality error message verbosity

Author: mariusconjeaud

neomodel/async_/cardinality.py

@@ -18,13 +18,14 @@ class AsyncZeroOrOne(AsyncRelationshipManager):
 
     async def check_cardinality(self, node: "AsyncStructuredNode") -> None:
         if await self.get_len():
+            detailed_description = str(self)
             if get_config().soft_cardinality_check:
                 print(
-                    f"Cardinality violation detected : Node already has one relationship of type {self.definition['relation_type']}, should not connect more. Soft check is enabled so the relationship will be created. Note that strict check will be enabled by default in version 6.0"
+                    f"Cardinality violation detected : Node already has {detailed_description}, should not connect more. Soft check is enabled so the relationship will be created."
                 )
             else:
                 raise AttemptedCardinalityViolation(
-                    f"Node already has one relationship of type {self.definition['relation_type']}. Use reconnect() to replace the existing relationship."
+                    f"Node already has {detailed_description}. Use reconnect() to replace the existing relationship."
                 )
 
     async def single(self) -> Optional["AsyncStructuredNode"]:
@@ -111,13 +112,14 @@ class AsyncOne(AsyncRelationshipManager):
 
     async def check_cardinality(self, node: "AsyncStructuredNode") -> None:
         if await self.get_len():
+            detailed_description = str(self)
             if get_config().soft_cardinality_check:
                 print(
-                    f"Cardinality violation detected : Node already has one relationship of type {self.definition['relation_type']}, should not connect more. Soft check is enabled so the relationship will be created. Note that strict check will be enabled by default in version 6.0"
+                    f"Cardinality violation detected : Node already has {detailed_description}, should not connect more. Soft check is enabled so the relationship will be created."
                 )
             else:
                 raise AttemptedCardinalityViolation(
-                    f"Node already has one relationship of type {self.definition['relation_type']}. Use reconnect() to replace the existing relationship."
+                    f"Node already has {detailed_description}. Use reconnect() to replace the existing relationship."
                 )
 
     async def single(self) -> "AsyncStructuredNode":

neomodel/sync_/cardinality.py

@@ -18,13 +18,14 @@ class ZeroOrOne(RelationshipManager):
 
     def check_cardinality(self, node: "StructuredNode") -> None:
         if self.__len__():
+            detailed_description = str(self)
             if get_config().soft_cardinality_check:
                 print(
-                    f"Cardinality violation detected : Node already has one relationship of type {self.definition['relation_type']}, should not connect more. Soft check is enabled so the relationship will be created. Note that strict check will be enabled by default in version 6.0"
+                    f"Cardinality violation detected : Node already has {detailed_description}, should not connect more. Soft check is enabled so the relationship will be created."
                 )
             else:
                 raise AttemptedCardinalityViolation(
-                    f"Node already has one relationship of type {self.definition['relation_type']}. Use reconnect() to replace the existing relationship."
+                    f"Node already has {detailed_description}. Use reconnect() to replace the existing relationship."
                 )
 
     def single(self) -> Optional["StructuredNode"]:
@@ -111,13 +112,14 @@ class One(RelationshipManager):
 
     def check_cardinality(self, node: "StructuredNode") -> None:
         if self.__len__():
+            detailed_description = str(self)
             if get_config().soft_cardinality_check:
                 print(
-                    f"Cardinality violation detected : Node already has one relationship of type {self.definition['relation_type']}, should not connect more. Soft check is enabled so the relationship will be created. Note that strict check will be enabled by default in version 6.0"
+                    f"Cardinality violation detected : Node already has {detailed_description}, should not connect more. Soft check is enabled so the relationship will be created."
                 )
             else:
                 raise AttemptedCardinalityViolation(
-                    f"Node already has one relationship of type {self.definition['relation_type']}. Use reconnect() to replace the existing relationship."
+                    f"Node already has {detailed_description}. Use reconnect() to replace the existing relationship."
                 )
 
     def single(self) -> "StructuredNode":

test/async_/test_cardinality.py

@@ -125,9 +125,15 @@ async def test_cardinality_zero_or_one():
     assert single_driver.version == 1
 
     j = await ScrewDriver(version=2).save()
-    with raises(AttemptedCardinalityViolation):
+    with raises(AttemptedCardinalityViolation) as exc_info:
         await m.driver.connect(j)
 
+    error_message = str(exc_info.value)
+    assert (
+        f"Node already has zero or one relationship in a outgoing direction of type HAS_SCREWDRIVER on node ({m.element_id}) of class 'Monkey'. Use reconnect() to replace the existing relationship."
+        == error_message
+    )
+
     await m.driver.reconnect(h, j)
     single_driver = await m.driver.single()
     assert single_driver.version == 2
@@ -166,9 +172,12 @@ async def test_cardinality_one_or_more():
     cars = await m.car.all()
     assert len(cars) == 1
 
-    with raises(AttemptedCardinalityViolation):
+    with raises(AttemptedCardinalityViolation) as exc_info:
         await m.car.disconnect(c)
 
+    error_message = str(exc_info.value)
+    assert "One or more expected" == error_message
+
     d = await Car(version=3).save()
     await m.car.connect(d)
     cars = await m.car.all()
@@ -202,9 +211,15 @@ async def test_cardinality_one():
     assert single_toothbrush.name == "Jim"
 
     x = await ToothBrush(name="Jim").save()
-    with raises(AttemptedCardinalityViolation):
+    with raises(AttemptedCardinalityViolation) as exc_info:
         await m.toothbrush.connect(x)
 
+    error_message = str(exc_info.value)
+    assert (
+        f"Node already has one relationship in a outgoing direction of type HAS_TOOTHBRUSH on node ({m.element_id}) of class 'Monkey'. Use reconnect() to replace the existing relationship."
+        == error_message
+    )
+
     with raises(AttemptedCardinalityViolation):
         await m.toothbrush.disconnect(b)
 
@@ -266,7 +281,6 @@ async def test_relationship_from_one_cardinality_enforced():
     console_output = stream.getvalue()
     assert "Cardinality violation detected" in console_output
     assert "Soft check is enabled so the relationship will be created" in console_output
-    assert "strict check will be enabled by default in version 6.0" in console_output
 
     config.soft_cardinality_check = False
 
@@ -303,7 +317,6 @@ async def test_relationship_from_zero_or_one_cardinality_enforced():
     console_output = stream.getvalue()
     assert "Cardinality violation detected" in console_output
     assert "Soft check is enabled so the relationship will be created" in console_output
-    assert "strict check will be enabled by default in version 6.0" in console_output
 
     config.soft_cardinality_check = False
 
@@ -363,6 +376,5 @@ async def test_bidirectional_cardinality_validation():
     console_output = stream.getvalue()
     assert "Cardinality violation detected" in console_output
     assert "Soft check is enabled so the relationship will be created" in console_output
-    assert "strict check will be enabled by default in version 6.0" in console_output
 
     config.soft_cardinality_check = False

test/sync_/test_cardinality.py

@@ -121,9 +121,15 @@ def test_cardinality_zero_or_one():
     assert single_driver.version == 1
 
     j = ScrewDriver(version=2).save()
-    with raises(AttemptedCardinalityViolation):
+    with raises(AttemptedCardinalityViolation) as exc_info:
         m.driver.connect(j)
 
+    error_message = str(exc_info.value)
+    assert (
+        f"Node already has zero or one relationship in a outgoing direction of type HAS_SCREWDRIVER on node ({m.element_id}) of class 'Monkey'. Use reconnect() to replace the existing relationship."
+        == error_message
+    )
+
     m.driver.reconnect(h, j)
     single_driver = m.driver.single()
     assert single_driver.version == 2
@@ -162,9 +168,12 @@ def test_cardinality_one_or_more():
     cars = m.car.all()
     assert len(cars) == 1
 
-    with raises(AttemptedCardinalityViolation):
+    with raises(AttemptedCardinalityViolation) as exc_info:
         m.car.disconnect(c)
 
+    error_message = str(exc_info.value)
+    assert "One or more expected" == error_message
+
     d = Car(version=3).save()
     m.car.connect(d)
     cars = m.car.all()
@@ -198,9 +207,15 @@ def test_cardinality_one():
     assert single_toothbrush.name == "Jim"
 
     x = ToothBrush(name="Jim").save()
-    with raises(AttemptedCardinalityViolation):
+    with raises(AttemptedCardinalityViolation) as exc_info:
         m.toothbrush.connect(x)
 
+    error_message = str(exc_info.value)
+    assert (
+        f"Node already has one relationship in a outgoing direction of type HAS_TOOTHBRUSH on node ({m.element_id}) of class 'Monkey'. Use reconnect() to replace the existing relationship."
+        == error_message
+    )
+
     with raises(AttemptedCardinalityViolation):
         m.toothbrush.disconnect(b)
 
@@ -262,7 +277,6 @@ def test_relationship_from_one_cardinality_enforced():
     console_output = stream.getvalue()
     assert "Cardinality violation detected" in console_output
     assert "Soft check is enabled so the relationship will be created" in console_output
-    assert "strict check will be enabled by default in version 6.0" in console_output
 
     config.soft_cardinality_check = False
 
@@ -299,7 +313,6 @@ def test_relationship_from_zero_or_one_cardinality_enforced():
     console_output = stream.getvalue()
     assert "Cardinality violation detected" in console_output
     assert "Soft check is enabled so the relationship will be created" in console_output
-    assert "strict check will be enabled by default in version 6.0" in console_output
 
     config.soft_cardinality_check = False
 
@@ -359,6 +372,5 @@ def test_bidirectional_cardinality_validation():
     console_output = stream.getvalue()
     assert "Cardinality violation detected" in console_output
     assert "Soft check is enabled so the relationship will be created" in console_output
-    assert "strict check will be enabled by default in version 6.0" in console_output
 
     config.soft_cardinality_check = False