feat: Add initial basic implementation for BO Fehler

and ENUM Vereinsmitglied

Author: Simon Blank

src/bo4e/__init__.py

@@ -15,6 +15,7 @@
     "Bilanzierung",
     "Buendelvertrag",
     "Energiemenge",
+    "Fehler",
     "Fremdkosten",
     "Geraet",
     "Geschaeftsobjekt",
@@ -189,6 +190,7 @@
     "BoTyp",
     "ComTyp",
     "Verbrauchsart",
+    "Vereinsmitglied",
     "Vertragsart",
     "Vertragsform",
     "Vertragsstatus",
@@ -216,6 +218,7 @@
 from .bo.bilanzierung import Bilanzierung
 from .bo.buendelvertrag import Buendelvertrag
 from .bo.energiemenge import Energiemenge
+from .bo.fehler import Fehler
 from .bo.fremdkosten import Fremdkosten
 from .bo.geraet import Geraet
 from .bo.geschaeftsobjekt import Geschaeftsobjekt
@@ -395,6 +398,7 @@
 from .enum.themengebiet import Themengebiet
 from .enum.titel import Titel
 from .enum.verbrauchsart import Verbrauchsart
+from .enum.vereinsmitglied import Vereinsmitglied
 from .enum.vertragsart import Vertragsart
 from .enum.vertragsform import Vertragsform
 from .enum.vertragsstatus import Vertragsstatus

src/bo4e/bo/fehler.py

@@ -0,0 +1,38 @@
+"""
+Contains Fehler class
+"""
+
+from typing import Annotated, Literal, Optional
+
+from pydantic import Field
+
+from ..enum.botyp import BoTyp
+from ..utils import postprocess_docstring
+from .geschaeftsobjekt import Geschaeftsobjekt
+
+
+@postprocess_docstring
+class Fehler(Geschaeftsobjekt):
+
+    """
+    Object containing information about a Fehler
+
+    .. raw:: html
+
+        <object data="../_static/images/bo4e/bo/Fehler.svg" type="image/svg+xml"></object>
+
+    .. HINT::
+        `Fehler JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/bo/Fehler.json>`_
+
+    """
+    typ: Annotated[Literal[BoTyp.FEHLER], Field(alias="_typ")] = BoTyp.FEHLER
+
+    code: Optional[int] = None
+    """Eindeutige Fehlernummer für einen Fehlerfall."""
+    meldung: Optional[str] = None
+    """Beschreibung des aufgetretenen Fehlers."""
+    spezifikation: Optional["Vereinsmitglied"] = None
+    """
+    Vereinsmitglied, welches den Fehlerfall spezifiziert.
+    Bei ALLGEMEIN handelt es sich um einen Fehlerfall im Standard.
+    """

src/bo4e/enum/botyp.py

@@ -16,6 +16,7 @@ class BoTyp(StrEnum):
     BILANZIERUNG = "BILANZIERUNG"
     BUENDELVERTRAG = "BUENDELVERTRAG"
     ENERGIEMENGE = "ENERGIEMENGE"
+    FEHLER = "FEHLER"
     FREMDKOSTEN = "FREMDKOSTEN"
     GERAET = "GERAET"
     # It is practical to use the BoTyp Enum as discriminator in the database.

src/bo4e/enum/vereinsmitglied.py

@@ -0,0 +1,27 @@
+# pylint:disable=missing-module-docstring
+from bo4e.enum.strenum import StrEnum
+
+
+class Vereinsmitglied(StrEnum):
+    """
+    Auflistung der BO4E Vereinsmitglieder
+    """
+
+    ALLGEMEIN = "ALLGEMEIN"
+    BRANDSEVEN = "BRANDSEVEN"
+    CONSCOO = "CONSCOO"
+    CONUTI = "CONUTI"
+    DIMATER = "DIMATER"
+    ENET = "ENET"
+    ENERKO = "ENERKO"
+    FICHTNER = "FICHTNER"
+    HOCHFREQUENZ = "HOCHFREQUENZ"
+    ITEMS = "ITEMS"
+    KISTERS = "KISTERS"
+    LYNQTECH = "LYNQTECH"
+    MUT_ZUM_WECHSELN = "MUT_ZUM_WECHSELN"
+    PREISENERGIE = "PREISENERGIE"
+    PROFIFORMS = "PROFIFORMS"
+    SIV = "SIV"
+    STADTWERKE_SCHWAEBISCH_HALL = "STADTWERKE_SCHWAEBISCH_HALL"
+    TAKTSOFT = "TAKTSOFT"