feat: allow "Durchgang"-row type with only 1 subrow which has None as result (#381)

Co-authored-by: Konstantin <[email protected]>

Author: hf-kklein

src/rebdhuhn/graph_conversion.py

@@ -76,10 +76,15 @@ def _convert_row_to_decision_node(row: EbdTableRow) -> DecisionNode:
     return DecisionNode(step_number=row.step_number, question=row.description)
 
 
-def _yes_no_edge(decision: bool, source: DecisionNode, target: EbdGraphNode) -> EbdGraphEdge:
-    if decision:
+def _yes_no_transition_edge(decision: Optional[bool], source: DecisionNode, target: EbdGraphNode) -> EbdGraphEdge:
+    if decision is None:
+        # happens in another PR
+        raise NotImplementedError("None not supported yet; https://github.com/Hochfrequenz/rebdhuhn/issues/380")
+    if decision is True:
         return ToYesEdge(source=source, target=target, note=None)
-    return ToNoEdge(source=source, target=target, note=None)
+    if decision is False:
+        return ToNoEdge(source=source, target=target, note=None)
+    raise ValueError(f"Decision must be either True or False or None, but was {decision}")
 
 
 def get_all_nodes(table: EbdTable) -> List[EbdGraphNode]:
@@ -132,7 +137,7 @@ def get_all_edges(table: EbdTable) -> List[EbdGraphEdge]:
         decision_node = _convert_row_to_decision_node(row)
         for sub_row in row.sub_rows:
             if sub_row.check_result.subsequent_step_number is not None and not _is_ende_with_no_code_but_note(sub_row):
-                edge = _yes_no_edge(
+                edge = _yes_no_transition_edge(
                     sub_row.check_result.result,
                     source=decision_node,
                     target=nodes[sub_row.check_result.subsequent_step_number],
@@ -160,7 +165,7 @@ def get_all_edges(table: EbdTable) -> List[EbdGraphEdge]:
                         outcome_node1=outcome_nodes_duplicates[outcome_node.get_key()], outcome_node2=outcome_node
                     )
 
-                edge = _yes_no_edge(
+                edge = _yes_no_transition_edge(
                     sub_row.check_result.result,
                     source=decision_node,
                     target=nodes[outcome_node.get_key()],

src/rebdhuhn/models/ebd_table.py

@@ -57,9 +57,10 @@ class EbdCheckResult:
 
     To model "ja": use result=True, subsequent_step_number=None
     To model "nein🠖2": use result=False, subsequent_step_number="2"
+    To model "🠖110": use result=None, subsequent_step_number="110", happens e.g. in E_0594 step_number 105
     """
 
-    result: bool = attrs.field(validator=attrs.validators.instance_of(bool))
+    result: Optional[bool] = attrs.field(validator=attrs.validators.optional(attrs.validators.instance_of(bool)))
     """
     Either "ja"=True or "nein"=False
     """
@@ -71,6 +72,18 @@ class EbdCheckResult:
     Key of the following/subsequent step, e.g. '2', or '6*' or None, if there is no follow up step
     """
 
+    @result.validator
+    def _validate_result(self, attribute, value) -> None:  # type:ignore[no-untyped-def] #pylint:disable=unused-argument
+        # This just ensures it's a class-level validation
+        self._validate_only_one_none()
+
+    def _validate_only_one_none(self) -> None:
+        if self.result is None and self.subsequent_step_number is None:
+            raise ValueError(
+                # pylint:disable=line-too-long
+                "If the result is not boolean (meaning neither 'ja' nor 'nein' but null), the subsequent step has to be set"
+            )
+
 
 RESULT_CODE_REGEX = r"^((?:[A-Z]\d+)|(?:A\*{2})|(?:A[A-Z]\d))$"
 
@@ -108,7 +121,7 @@ def _check_that_both_true_and_false_occur(  # type:ignore[no-untyped-def]
     instance: EbdTableSubRow, attribute, value: List[EbdTableSubRow]
 ) -> None:
     """
-    Check that the subrows cover both a True and a False outcome
+    Check that the subrows cover both a True and a False outcome. e.g. Ja -> 2 AND Nein -> 3
     """
     # We implicitly assume that the value (list) provided already has exactly two entries.
     # This is enforced by other validators
@@ -119,6 +132,22 @@ def _check_that_both_true_and_false_occur(  # type:ignore[no-untyped-def]
             )
 
 
+def _check_that_neither_true_nor_false_occur(  # type:ignore[no-untyped-def]
+    instance: EbdTableSubRow, attribute, value: List[EbdTableSubRow]
+) -> None:
+    """
+    Check that the subrows contain neither true nor false but only a reference to a future steps.
+    E.g. MaLo Ident E_0594 step_number 105 directly refers to step 110, no ja/nein and only 1 subrow.
+    Screenshot here: https://github.com/Hochfrequenz/rebdhuhn/issues/379
+    """
+    # We implicitly assume that the value (list) provided already has exactly two entries.
+    # This is enforced by other validators
+    if len(value) != 1:
+        raise ValueError("There must be exactly one subrow when the subrows are not a 'ja' or 'nein' distinction")
+    if value[0].check_result.result is not None:
+        raise ValueError("The subrow must not have a 'ja' or 'nein' distinction")
+
+
 _STEP_NUMBER_REGEX = r"\d+\*?"  #: regex used to validate step numbers, e.g. '4' or '7*'
 
 
@@ -142,8 +171,13 @@ class EbdTableRow:
     sub_rows: List[EbdTableSubRow] = attrs.field(
         validator=attrs.validators.deep_iterable(
             member_validator=attrs.validators.instance_of(EbdTableSubRow),
-            iterable_validator=attrs.validators.and_(
-                attrs.validators.min_len(2), attrs.validators.max_len(2), _check_that_both_true_and_false_occur
+            iterable_validator=attrs.validators.or_(
+                attrs.validators.and_(
+                    attrs.validators.min_len(2), attrs.validators.max_len(2), _check_that_both_true_and_false_occur
+                ),
+                attrs.validators.and_(
+                    attrs.validators.min_len(1), attrs.validators.max_len(1), _check_that_neither_true_nor_false_occur
+                ),
             ),
         ),
     )

unittests/test_ebd_table_models.py

@@ -158,6 +158,75 @@ def test_answer_code_astersik(self) -> None:
         assert isinstance(sub_row, EbdTableSubRow)
         assert sub_row.result_code == "A**"
 
+    def test_subrow_with_only_subsequent_step(self) -> None:
+        """
+        This is an example from E_0594 where there is no result code but only a subsequent step.
+        """
+        sub_row = EbdTableSubRow(
+            result_code=None,
+            check_result=EbdCheckResult(result=None, subsequent_step_number="110"),
+            note="Aufnahme von 0..n Treffern in die Trefferliste auf Basis eines Kriteriums",
+        )
+        assert isinstance(sub_row, EbdTableSubRow)
+
+    def test_subrow_not_both_must_be_null(self) -> None:
+        """
+        Check that the result code and the subsequent step are not both null.
+        """
+        with pytest.raises(ValueError):
+            _ = (EbdCheckResult(result=None, subsequent_step_number=None),)
+
+    def test_row_with_only_one_subrow(self) -> None:
+        """
+        This is an example from E_0594 where there is a step with only 1 subrow and no ja/nein distinction
+        """
+        row = EbdTableRow(
+            step_number="105",
+            # pylint:disable=line-too-long
+            description="[Adressprüfung] (Straße und PLZ oder geographische Koordinaten oder Flurstücknummer) Hinweis: Das Weglassen der Hausnummer, trägt dem Umstand Rechnung, dass einige NB eher die Adresse des Geräts und nicht die Lieferadresse hinterlegt haben. Wenn der Zähler im Doppelhaus nebenan zu finden ist, weiß der Kunde das ggf.",
+            sub_rows=[
+                EbdTableSubRow(
+                    result_code=None,
+                    check_result=EbdCheckResult(result=None, subsequent_step_number="110"),
+                    note="Aufnahme von 0..n Treffern in die Trefferliste auf Basis eines Kriteriums",
+                )
+            ],
+        )
+        assert isinstance(row, EbdTableRow)
+
+    def test_row_with_only_one_subrow_is_not_allowed_if_ja_nein_distinction(self) -> None:
+        with pytest.raises(ValueError):
+            _ = EbdTableRow(
+                step_number="105",
+                description="[Adressprüfung] (Straße und PLZ oder geographische Koordinaten oder Flurstücknummer) Hinweis: Das Weglassen der Hausnummer, trägt dem Umstand Rechnung, dass einige NB eher die Adresse des Geräts und nicht die Lieferadresse hinterlegt haben. Wenn der Zähler im Doppelhaus nebenan zu finden ist, weiß der Kunde das ggf.",
+                sub_rows=[
+                    EbdTableSubRow(
+                        result_code=None,
+                        check_result=EbdCheckResult(result=True, subsequent_step_number="110"),  # <--not allowed
+                        note="Aufnahme von 0..n Treffern in die Trefferliste auf Basis eines Kriteriums",
+                    )
+                ],
+            )
+
+    def test_row_with_two_subrows_does_not_allow_none_result(self) -> None:
+        with pytest.raises(ValueError):
+            _ = EbdTableRow(
+                step_number="105",
+                description="xyz.",
+                sub_rows=[
+                    EbdTableSubRow(
+                        result_code=None,
+                        check_result=EbdCheckResult(result=True, subsequent_step_number="110"),
+                        note="Foo",
+                    ),
+                    EbdTableSubRow(
+                        result_code=None,
+                        check_result=EbdCheckResult(result=None, subsequent_step_number="111"),  # <--not allowed
+                        note="Bar",
+                    ),
+                ],
+            )
+
     def test_2023_answer_code_regex(self) -> None:
         """
         This is an example from E_0406.