Merge pull request #154 from alliander-opensource/fix/trafo-clock-error

Change error message and add unit tests

Author: bramstoeller

src/power_grid_model/validation/errors.py

@@ -432,7 +432,7 @@ class TransformerClockError(MultiFieldValidationError):
     """
 
     _message = (
-        "Even number is not possible if one side is wye winding and the other side is not wye winding.\n"
-        "Odd number is not possible, if both sides are wye winding or both sides are not wye winding.\n"
-        ", for {n} {objects}."
+        "Invalid clock number for {n} {objects}. "
+        "If one side has wye winding and the other side has not, the clock number should be odd. "
+        "If either both or none of the sides have wye winding, the clock number should be even."
     )

src/power_grid_model/validation/rules.py

@@ -613,7 +613,7 @@ def none_missing(data: SingleDataset, component: str, fields: Union[str, List[st
     return errors
 
 
-def all_clocks_valid(
+def all_valid_clocks(
     data: SingleDataset, component: str, clock_field: str, winding_from_field: str, winding_to_field: str
 ) -> List[TransformerClockError]:
     """

src/power_grid_model/validation/validation.py

@@ -34,7 +34,6 @@
     all_between,
     all_between_or_at,
     all_boolean,
-    all_clocks_valid,
     all_cross_unique,
     all_finite,
     all_greater_or_equal,
@@ -45,6 +44,7 @@
     all_not_two_values_equal,
     all_not_two_values_zero,
     all_unique,
+    all_valid_clocks,
     all_valid_enum_values,
     all_valid_ids,
     none_missing,
@@ -405,7 +405,7 @@ def validate_transformer(data: SingleDataset) -> List[ValidationError]:
     errors += all_valid_enum_values(data, "transformer", "winding_from", WindingType)
     errors += all_valid_enum_values(data, "transformer", "winding_to", WindingType)
     errors += all_between_or_at(data, "transformer", "clock", 0, 12)
-    errors += all_clocks_valid(data, "transformer", "clock", "winding_from", "winding_to")
+    errors += all_valid_clocks(data, "transformer", "clock", "winding_from", "winding_to")
     errors += all_valid_enum_values(data, "transformer", "tap_side", BranchSide)
     errors += all_between_or_at(data, "transformer", "tap_pos", "tap_min", "tap_max")
     errors += all_between_or_at(data, "transformer", "tap_nom", "tap_min", "tap_max")
@@ -464,8 +464,8 @@ def validate_three_winding_transformer(data: SingleDataset) -> List[ValidationEr
     errors += all_valid_enum_values(data, "three_winding_transformer", "winding_3", WindingType)
     errors += all_between_or_at(data, "three_winding_transformer", "clock_12", 0, 12)
     errors += all_between_or_at(data, "three_winding_transformer", "clock_13", 0, 12)
-    errors += all_clocks_valid(data, "three_winding_transformer", "clock_12", "winding_1", "winding_2")
-    errors += all_clocks_valid(data, "three_winding_transformer", "clock_13", "winding_1", "winding_3")
+    errors += all_valid_clocks(data, "three_winding_transformer", "clock_12", "winding_1", "winding_2")
+    errors += all_valid_clocks(data, "three_winding_transformer", "clock_13", "winding_1", "winding_3")
     errors += all_valid_enum_values(data, "three_winding_transformer", "tap_side", Branch3Side)
     errors += all_between_or_at(data, "three_winding_transformer", "tap_pos", "tap_min", "tap_max")
     errors += all_between_or_at(data, "three_winding_transformer", "tap_nom", "tap_min", "tap_max")

tests/unit/validation/test_rules.py

@@ -39,6 +39,7 @@
     all_not_two_values_equal,
     all_not_two_values_zero,
     all_unique,
+    all_valid_clocks,
     all_valid_enum_values,
     all_valid_ids,
     none_match_comparison,
@@ -352,15 +353,21 @@ def test_all_finite():
 
     dfoo = [("id", "i4"), ("foo", "f8")]
     dbar = [("id", "i4"), ("bar", "f8")]
-    valid = {
+    invalid = {
         "foo_test": np.array([(1, 0.1), (2, np.inf), (3, -0.3)], dtype=dfoo),
         "bar_test": np.array([(4, 0.4), (5, 0.5), (6, -np.inf)], dtype=dbar),
     }
-    errors = all_finite(valid)
+    errors = all_finite(invalid)
     assert len(errors) == 2
     assert InfinityError("foo_test", "foo", [2]) in errors
     assert InfinityError("bar_test", "bar", [6]) in errors
 
 
+@pytest.mark.skip("No unit tests available for none_missing")
 def test_none_missing():
-    none_missing
+    raise NotImplementedError(f"Unit test for {none_missing}")
+
+
+@pytest.mark.skip("No unit tests available for all_valid_clocks")
+def test_all_valid_clocks():
+    raise NotImplementedError(f"Unit test for {all_valid_clocks}")