Unify SG and S lists for MIGs and AHBs (#73)

* update pre-commit

* modified data model for MIGs

* updated snapshot

* snapshots

* modified ahbs

* changed test

* update snapshots

Author: DeltaDaniel

.pre-commit-config.yaml

@@ -1,18 +1,18 @@
 # to update all repo revisions just run: pre-commit autoupdate
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 24.10.0
     hooks:
       - id: black
         language_version: python3
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         name: isort (python)

src/fundamend/models/anwendungshandbuch.py

@@ -4,6 +4,7 @@
 # the structures are similar, still we decided against inheritance, so there's naturally a little bit of duplication
 
 from datetime import date
+from typing import Union
 
 from ._dataclass_wrapper import dataclass
 
@@ -110,8 +111,7 @@ class SegmentGroup:
     id: str  #: e.g. 'SG6'
     name: str  #: e.g. 'Prüfidentifikator'
     ahb_status: str | None  #: e.g. 'Muss'
-    segments: list[Segment]
-    segment_groups: list["SegmentGroup"]
+    elements: list[Union[Segment, "SegmentGroup"]]
 
 
 @dataclass(kw_only=True, eq=True, frozen=True)
@@ -130,8 +130,7 @@ class Anwendungsfall:
     beschreibung: str  #: e.g. 'Berechnungsformel'
     kommunikation_von: str  #: e.g. 'NB an MSB / LF'
     format: str  #: e.g. 'UTILTS'
-    segments: list[Segment]
-    segment_groups: list[SegmentGroup]
+    elements: list[Union[Segment, SegmentGroup]]
 
 
 @dataclass(kw_only=True, eq=True, frozen=True)

src/fundamend/models/messageimplementationguide.py

@@ -2,6 +2,7 @@
 
 from datetime import date
 from enum import StrEnum
+from typing import Union
 
 from ._dataclass_wrapper import dataclass
 
@@ -154,8 +155,7 @@ class SegmentGroup:
     max_rep_specification: int  # e.g. 1
     status_std: MigStatus
     status_specification: MigStatus
-    segments: list[Segment]
-    segment_groups: list["SegmentGroup"]
+    elements: list[Union[Segment, "SegmentGroup"]]
 
 
 @dataclass(kw_only=True, eq=True)
@@ -175,5 +175,4 @@ class MessageImplementationGuide:
 
     format: str  #: e.g. 'UTILTS'
 
-    segments: list[Segment]
-    segment_groups: list[SegmentGroup]
+    elements: list[Union[Segment, "SegmentGroup"]]

src/fundamend/reader/ahbreader.py

@@ -148,8 +148,7 @@ def _to_segment_group(element: ET.Element) -> SegmentGroup:
         id=element.tag.lstrip("G_SG"),
         name=element.attrib["Name"],
         ahb_status=element.attrib["AHB_Status"],
-        segments=[s for s in segments_and_groups if isinstance(s, Segment)],
-        segment_groups=[sg for sg in segments_and_groups if isinstance(sg, SegmentGroup)],
+        elements=list(segments_and_groups),
     )
 
 
@@ -246,8 +245,7 @@ def _read_anwendungsfall(self, original_element: ET.Element) -> Anwendungsfall:
             beschreibung=original_element.attrib["Beschreibung"],
             kommunikation_von=original_element.attrib["Kommunikation_von"],
             format=format_element.tag.lstrip("M_"),
-            segments=[s for s in segments_and_groups if isinstance(s, Segment)],
-            segment_groups=[s for s in segments_and_groups if isinstance(s, SegmentGroup)],
+            elements=list(segments_and_groups),
         )
 
     def read(self) -> Anwendungshandbuch:

src/fundamend/reader/migreader.py

@@ -113,8 +113,7 @@ def _to_segment_group(element: ET.Element) -> SegmentGroup:
         level=int(element.attrib["Level"]),
         max_rep_std=int(element.attrib["MaxRep_Std"]),
         max_rep_specification=int(element.attrib["MaxRep_Specification"]),
-        segments=[s for s in segments_and_groups if isinstance(s, Segment)],
-        segment_groups=[sg for sg in segments_and_groups if isinstance(sg, SegmentGroup)],
+        elements=list(segments_and_groups),
     )
 
 
@@ -197,7 +196,6 @@ def read(self) -> MessageImplementationGuide:
             autor=self.get_author(),
             versionsnummer=self.get_version(),
             format=self.get_format(),
-            segments=[s for s in segments_and_groups if isinstance(s, Segment)],
-            segment_groups=[s for s in segments_and_groups if isinstance(s, SegmentGroup)],
+            elements=list(segments_and_groups),
         )
         return result

unittests/__snapshots__/test_ahbreader.ambr

@@ -170,6 +170,5 @@ def test_get_anwendungshandbuch(ahb_xml_file_path: Path, snapshot: SnapshotAsser
         "25009",
     }
     for awf in actual.anwendungsfaelle:
-        assert any(awf.segments)
-        assert any(awf.segment_groups)
+        assert any(awf.elements)
     snapshot.assert_match(actual)