feat: add ebd_names to TableMetaData and GraphMetaData; therefo…

…re remove `sub_chapter` (#286)
Hochfrequenz · Nov 7, 2024 · 58a999b · 58a999b
1 parent 5584e15
commit 58a999b
Show file tree

Hide file tree

Showing 16 changed files with 73 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -44,8 +44,9 @@ ebd_table: EbdTable  # this is the result of scraping the docx file
 ebd_table = EbdTable(  # this data shouldn't be handwritten
     metadata=EbdTableMetaData(
         ebd_code="E_0003",
-        chapter="7.39 AD: Bestellung der Aggregationsebene der Bilanzkreissummenzeitreihe auf Ebene der Regelzone",
-        sub_chapter="7.39.1 E_0003_Bestellung der Aggregationsebene RZ prüfen",
+        chapter="MaBiS",
+        section="7.39 AD: Bestellung der Aggregationsebene der Bilanzkreissummenzeitreihe auf Ebene der Regelzone",
+        ebd_name="Bestellung der Aggregationsebene RZ prüfen",
         role="ÜNB",
     ),
     rows=[

diff --git a/src/rebdhuhn/graph_conversion.py b/src/rebdhuhn/graph_conversion.py
@@ -160,7 +160,8 @@ def convert_table_to_graph(table: EbdTable) -> EbdGraph:
     graph_metadata = EbdGraphMetaData(
         ebd_code=table.metadata.ebd_code,
         chapter=table.metadata.chapter,
-        sub_chapter=table.metadata.sub_chapter,
+        section=table.metadata.section,
+        ebd_name=table.metadata.ebd_name,
         role=table.metadata.role,
     )
     return EbdGraph(metadata=graph_metadata, graph=graph, multi_step_instructions=table.multi_step_instructions)
diff --git a/src/rebdhuhn/graphviz.py b/src/rebdhuhn/graphviz.py
@@ -158,7 +158,7 @@ def convert_graph_to_dot(ebd_graph: EbdGraph) -> str:
     _mark_last_common_ancestors(nx_graph)
     header = (
         f'<B><FONT POINT-SIZE="18">{ebd_graph.metadata.chapter}</FONT></B><BR/><BR/>'
-        f'<B><FONT POINT-SIZE="16">{ebd_graph.metadata.sub_chapter}</FONT></B><BR/><BR/><BR/><BR/>'
+        f'<B><FONT POINT-SIZE="16">{ebd_graph.metadata.section}</FONT></B><BR/><BR/><BR/><BR/>'
     )
     dot_attributes: dict[str, str] = {f"'{ADD_INDENT}labelloc": '"t"', "label": f"<{header}>"}
     dot_code = "digraph D {\n"

diff --git a/src/rebdhuhn/models/ebd_graph.py b/src/rebdhuhn/models/ebd_graph.py
@@ -28,12 +28,17 @@ class EbdGraphMetaData:
     chapter: str = attrs.field(validator=attrs.validators.instance_of(str))
     """
     Chapter from the EDI@Energy Document
+    e.g. MaBis
+    """
+    section: str = attrs.field(validator=attrs.validators.instance_of(str))
+    """
+    Section from the EDI@Energy Document
     e.g. '7.24 AD:  Übermittlung Datenstatus für die Bilanzierungsgebietssummenzeitreihe vom BIKO an ÜNB und NB'
     """
-    sub_chapter: str = attrs.field(validator=attrs.validators.instance_of(str))
+    ebd_name: str = attrs.field(validator=attrs.validators.instance_of(str))
     """
-    Sub Chapter from the EDI@Energy Document
-    e.g. '7.24.1 Datenstatus nach erfolgter Bilanzkreisabrechnung vergeben'
+    EBD name from the EDI@Energy Document
+    e.g. 'E_0003_Bestellung der Aggregationsebene RZ prüfen'
     """
     role: str = attrs.field(validator=attrs.validators.instance_of(str))
     """

diff --git a/src/rebdhuhn/models/ebd_table.py b/src/rebdhuhn/models/ebd_table.py
@@ -23,17 +23,22 @@ class EbdTableMetaData:
     chapter: str = attrs.field(validator=attrs.validators.instance_of(str))
     """
     Chapter from the EDI@Energy Document
-    e.g. '7.24 AD:  Übermittlung Datenstatus für die Bilanzierungsgebietssummenzeitreihe vom BIKO an ÜNB und NB'
+    e.g. MaBiS
     """
-    sub_chapter: str = attrs.field(validator=attrs.validators.instance_of(str))
+    section: str = attrs.field(validator=attrs.validators.instance_of(str))
     """
-    Sub Chapter from the EDI@Energy Document
+    Section from the EDI@Energy Document
     e.g. '7.24.1 Datenstatus nach erfolgter Bilanzkreisabrechnung vergeben'
     """
     role: str = attrs.field(validator=attrs.validators.instance_of(str))
     """
     e.g. 'BIKO' for "Prüfende Rolle: 'BIKO'"
     """
+    ebd_name: str = attrs.field(validator=attrs.validators.instance_of(str))
+    """
+    EBD name from the EDI@Energy Document
+    e.g. 'E_0003_Bestellung der Aggregationsebene RZ prüfen'
+    """
     remark: Optional[str] = attrs.field(
         default=None, validator=attrs.validators.optional(attrs.validators.instance_of(str))
     )

diff --git a/src/rebdhuhn/plantuml.py b/src/rebdhuhn/plantuml.py
@@ -167,7 +167,7 @@ def convert_graph_to_plantuml(graph: EbdGraph) -> str:
         "title\n"
         f"{graph.metadata.chapter}\n"
         "\n"
-        f"{graph.metadata.sub_chapter}\n"
+        f"{graph.metadata.section}\n"
         "\n"
         "\n"
         "\n"

diff --git a/unittests/e0266.py b/unittests/e0266.py
@@ -9,7 +9,8 @@
     metadata=EbdTableMetaData(
         ebd_code="E_0266",
         chapter="WiM Strom",
-        sub_chapter="9.26.3: AD Abrechnung einer für den ESA erbrachten Leistung",
+        section="9.26.3: AD Abrechnung einer für den ESA erbrachten Leistung",
+        ebd_name="E_0266 Some Name",
         role="ESA",
     ),
     rows=[

diff --git a/unittests/e0401.py b/unittests/e0401.py
@@ -6,7 +6,11 @@
 
 e_0401 = EbdTable(
     metadata=EbdTableMetaData(
-        ebd_code="E_0401", chapter="GPKE", sub_chapter="6.2.1: AD: Lieferende LF an NB", role="NB"
+        ebd_code="E_0401",
+        chapter="GPKE",
+        section="6.2.1: AD: Lieferende LF an NB",
+        ebd_name="6.2.1	E_0401_Abmeldung prüfen",
+        role="NB",
     ),
     rows=[
         EbdTableRow(

diff --git a/unittests/e0404.py b/unittests/e0404.py
@@ -5,7 +5,13 @@
 from rebdhuhn.models import EbdCheckResult, EbdTable, EbdTableMetaData, EbdTableRow, EbdTableSubRow
 
 e_0404 = EbdTable(
-    metadata=EbdTableMetaData(ebd_code="E_0404", chapter="GPKE", sub_chapter="6.4.4: AD: Lieferbeginn", role="NB"),
+    metadata=EbdTableMetaData(
+        ebd_code="E_0404",
+        chapter="GPKE",
+        section="6.4.4: AD: Lieferbeginn",
+        ebd_name="E_0404_Lieferbeginn prüfen",
+        role="NB",
+    ),
     rows=[
         EbdTableRow(
             step_number="1",

diff --git a/unittests/e0454.py b/unittests/e0454.py
@@ -8,7 +8,8 @@
     metadata=EbdTableMetaData(
         ebd_code="E_0454",
         chapter="GPKE",
-        sub_chapter="6.27.2: AD: Information über die Zuordnung einer Marktlokation zur Datenaggregation durch den ÜNB",
+        section="6.27.2: AD: Information über die Zuordnung einer Marktlokation zur Datenaggregation durch den ÜNB",
+        ebd_name="E_0404_Information prüfen",
         role="ÜNB",
     ),
     rows=[

diff --git a/unittests/e0459.py b/unittests/e0459.py
@@ -6,7 +6,11 @@
 
 table_e0459 = EbdTable(
     metadata=EbdTableMetaData(
-        ebd_code="E_0459", chapter="GPKE", sub_chapter="6.7.4: AD: Netznutzungsabrechnung", role="LF"
+        ebd_code="E_0459",
+        chapter="GPKE",
+        section="6.7.4: AD: Netznutzungsabrechnung",
+        ebd_name="E_0459_Prüfen, ob Antwort auf Stornierung erforderlich",
+        role="LF",
     ),
     rows=[
         EbdTableRow(

diff --git a/unittests/e0462.py b/unittests/e0462.py
@@ -5,7 +5,13 @@
 from rebdhuhn.models import EbdCheckResult, EbdTable, EbdTableMetaData, EbdTableRow, EbdTableSubRow
 
 table_e0462 = EbdTable(
-    metadata=EbdTableMetaData(ebd_code="E_0462", chapter="GPKE", sub_chapter="6.4.1: AD: Lieferbeginn", role="NB"),
+    metadata=EbdTableMetaData(
+        ebd_code="E_0462",
+        chapter="GPKE",
+        section="6.4.1: AD: Lieferbeginn",
+        ebd_name="E_0462_Prüfen, ob Anmeldung direkt ablehnbar",
+        role="NB",
+    ),
     rows=[
         EbdTableRow(
             step_number="1",

diff --git a/unittests/e0529.py b/unittests/e0529.py
@@ -8,7 +8,8 @@
     metadata=EbdTableMetaData(
         ebd_code="E_0529",
         chapter="GPKE",
-        sub_chapter="6.36.6: AD Bestellung einer Konfiguration vom NB an MSB",
+        section="6.36.6: AD Bestellung einer Konfiguration vom NB an MSB",
+        ebd_name="E_0529_Some",
         role="MSB",
     ),
     rows=[

diff --git a/unittests/examples.py b/unittests/examples.py
@@ -15,7 +15,8 @@
     metadata=EbdTableMetaData(
         ebd_code="E_0003",
         chapter="7.39 AD: Bestellung der Aggregationsebene der Bilanzkreissummenzeitreihe auf Ebene der Regelzone",
-        sub_chapter="7.39.1 E_0003_Bestellung der Aggregationsebene RZ prüfen",
+        section="7.39.1 E_0003_Bestellung der Aggregationsebene RZ prüfen",
+        ebd_name="E_0003_Bestellung der Aggregationsebene RZ prüfen",
         role="ÜNB",
     ),
     rows=[
@@ -60,7 +61,8 @@
     metadata=EbdTableMetaData(
         ebd_code="E_0025",
         chapter="7.41 AD: Übermittlung Prüfmitteilung für die Bilanzkreissummenzeitreihe vom BKV an BIKO und ÜNB",
-        sub_chapter="7.41.2 E_0025_Prüfmitteilung prüfen",
+        section="7.41.2 E_0025_Prüfmitteilung prüfen",
+        ebd_name="E_0025_Prüfmitteilung prüfen",
         role="BIKO",
     ),
     rows=[
@@ -158,7 +160,8 @@
     metadata=EbdTableMetaData(
         ebd_code="E_0015",
         chapter="7.17 AD: Aktivierung eines MaBiS-ZP für Bilanzierungsgebietssummenzeitreihen vom ÜNB an BIKO und NB",
-        sub_chapter="7.17.1 E_0015_MaBiS-ZP Aktivierung prüfen",
+        section="7.17.1 E_0015_MaBiS-ZP Aktivierung prüfen",
+        ebd_name="E_0015_MaBiS-ZP Aktivierung prüfen",
         role="BIKO",
     ),
     rows=[
@@ -332,7 +335,8 @@
     metadata=EbdTableMetaData(
         ebd_code="E_0401",
         chapter="6.2 AD: Lieferende LF an NB",
-        sub_chapter="6.2.1 E_0401_Abmeldung prüfen",
+        section="6.2.1 E_0401_Abmeldung prüfen",
+        ebd_name="E_0401_Abmeldung prüfen",
         role="NB",  # NB=VNB
     ),
     rows=[

diff --git a/unittests/test_ebd_table_models.py b/unittests/test_ebd_table_models.py
@@ -20,7 +20,8 @@ class TestEbdTableModels:
                     metadata=EbdTableMetaData(
                         ebd_code="E_0015",
                         chapter="7.17 AD: AD: Aktivierung eines MaBiS-ZP für Bilanzierungsgebietssummenzeitreihen vom ÜNB an BIKO und NB",
-                        sub_chapter="7.17.1 E_0015_MaBiS-ZP Aktivierung prüfen",
+                        section="7.17.1 E_0015_MaBiS-ZP Aktivierung prüfen",
+                        ebd_name="E_0404_Lieferbeginn prüfen",
                         role="BIKO",
                     ),
                     rows=[
@@ -175,7 +176,8 @@ def test_collect_answer_codes_instruction(self) -> None:
             metadata=EbdTableMetaData(
                 ebd_code="E_0453",
                 chapter="6.18 AD: Stammdatensynchronisation",
-                sub_chapter="6.18.1 E_0453_Änderung prüfen",
+                section="6.18.1 E_0453_Änderung prüfen",
+                ebd_name="E_0404_Lieferbeginn prüfen",
                 role="ÜNB",
             ),
             multi_step_instructions=[

diff --git a/unittests/test_table_to_graph.py b/unittests/test_table_to_graph.py
@@ -417,7 +417,8 @@ def test_table_e0401_too_complex_for_plantuml(self) -> None:
                     metadata=EbdGraphMetaData(
                         ebd_code=table_e0003.metadata.ebd_code,
                         chapter=table_e0003.metadata.chapter,
-                        sub_chapter=table_e0003.metadata.sub_chapter,
+                        section=table_e0003.metadata.section,
+                        ebd_name=table_e0003.metadata.ebd_name,
                         role=table_e0003.metadata.role,
                     ),
                     graph=DiGraph(),
@@ -430,7 +431,8 @@ def test_table_e0401_too_complex_for_plantuml(self) -> None:
                     metadata=EbdGraphMetaData(
                         ebd_code=table_e0025.metadata.ebd_code,
                         chapter=table_e0025.metadata.chapter,
-                        sub_chapter=table_e0025.metadata.sub_chapter,
+                        section=table_e0025.metadata.section,
+                        ebd_name=table_e0025.metadata.ebd_name,
                         role=table_e0025.metadata.role,
                     ),
                     graph=DiGraph(),
@@ -443,7 +445,8 @@ def test_table_e0401_too_complex_for_plantuml(self) -> None:
                     metadata=EbdGraphMetaData(
                         ebd_code=table_e0015.metadata.ebd_code,
                         chapter=table_e0015.metadata.chapter,
-                        sub_chapter=table_e0015.metadata.sub_chapter,
+                        section=table_e0015.metadata.section,
+                        ebd_name=table_e0015.metadata.ebd_name,
                         role=table_e0015.metadata.role,
                     ),
                     graph=DiGraph(),
@@ -456,7 +459,8 @@ def test_table_e0401_too_complex_for_plantuml(self) -> None:
                     metadata=EbdGraphMetaData(
                         ebd_code=table_e0401.metadata.ebd_code,
                         chapter=table_e0401.metadata.chapter,
-                        sub_chapter=table_e0401.metadata.sub_chapter,
+                        section=table_e0401.metadata.section,
+                        ebd_name=table_e0401.metadata.ebd_name,
                         role=table_e0401.metadata.role,
                     ),
                     graph=DiGraph(),