Add ENUM ComTyp And Rename ENUM Typ To BoTyp (#974)

* add typ_com

* rename typ to typ_bo

* fix imports for typ_bo

* Fix import for typbo

* fix import issues

* rename to botyp

* fix imports

* rename class to BoTyp

* rename to comtyp

* add missing coms

* add default types for coms

* add test to check default typ

* fix failing tests

* Fix typehint errors

* fix regionalepreisstaffel

* remove Union from RegionalePreisgarantie

* remove union in fremdkostenposition

* remove unused imports

* fix kostenposition

* fix preis and tarifpreis

* remove unused imports

* fix preisgarantie and regionalepreisgarantie

* fix preisstaffel and regionalepreisstaffel

* fix docstring

* Fix docstring in ComTyp

* add hint how to distinguish component and business object

Author: hf-krechan

docs/contributing_guide.rst

@@ -83,7 +83,7 @@ For data validation and de/serialization we use `pydantic <https://pydantic-docs
        Es kommt nur bei meinem Strom-Lieferanten zum Einsatz und beschreibt dort all die tollen Eigenschaften, die mein Verbrauchsverhalten hat.
        """
 
-       typ: Annotated[Optional[Typ], Field(alias="_typ")] = Typ.MEINBO
+       typ: Annotated[Optional[Typ], Field(alias="_typ")] = TypBo.MEINBO
 
        #: Der Lieferbeginn beschreibt den Zeitpunkt ab dem (inklusiv) mich ein Versorger seinen Kunden nennen darf
        lieferbeginn: Optional[datetime] = None

src/bo4e/__init__.py

@@ -186,7 +186,8 @@
     "TechnischeRessourceVerbrauchsart",
     "Themengebiet",
     "Titel",
-    "Typ",
+    "BoTyp",
+    "ComTyp",
     "Verbrauchsart",
     "Vertragsart",
     "Vertragsform",
@@ -328,6 +329,8 @@
 from .enum.befestigungsart import Befestigungsart
 from .enum.bemessungsgroesse import Bemessungsgroesse
 from .enum.bilanzierungsmethode import Bilanzierungsmethode
+from .enum.botyp import BoTyp
+from .enum.comtyp import ComTyp
 from .enum.dienstleistungstyp import Dienstleistungstyp
 from .enum.emobilitaetsart import EMobilitaetsart
 from .enum.energierichtung import Energierichtung
@@ -392,7 +395,6 @@
 from .enum.technischeressourceverbrauchsart import TechnischeRessourceVerbrauchsart
 from .enum.themengebiet import Themengebiet
 from .enum.titel import Titel
-from .enum.typ import Typ
 from .enum.verbrauchsart import Verbrauchsart
 from .enum.vertragsart import Vertragsart
 from .enum.vertragsform import Vertragsform

src/bo4e/bo/angebot.py

@@ -9,7 +9,7 @@
 import pydantic
 from pydantic import Field
 
-from ..enum.typ import Typ
+from ..enum.botyp import BoTyp
 from ..utils import postprocess_docstring
 from .geschaeftsobjekt import Geschaeftsobjekt
 
@@ -38,7 +38,7 @@ class Angebot(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Literal[Typ.ANGEBOT], Field(alias="_typ")] = Typ.ANGEBOT
+    typ: Annotated[Literal[BoTyp.ANGEBOT], Field(alias="_typ")] = BoTyp.ANGEBOT
     angebotsnummer: Optional[str] = None
     """Eindeutige Nummer des Angebotes"""
     angebotsdatum: Optional[pydantic.AwareDatetime] = None

src/bo4e/bo/ausschreibung.py

@@ -9,7 +9,7 @@
 import pydantic
 from pydantic import Field
 
-from ..enum.typ import Typ
+from ..enum.botyp import BoTyp
 from ..utils import postprocess_docstring
 from .geschaeftsobjekt import Geschaeftsobjekt
 
@@ -36,7 +36,7 @@ class Ausschreibung(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Literal[Typ.AUSSCHREIBUNG], Field(alias="_typ")] = Typ.AUSSCHREIBUNG
+    typ: Annotated[Literal[BoTyp.AUSSCHREIBUNG], Field(alias="_typ")] = BoTyp.AUSSCHREIBUNG
     ausschreibungsnummer: Optional[str] = None
     """Vom Herausgeber der Ausschreibung vergebene eindeutige Nummer"""
     ausschreibungstyp: Optional["Ausschreibungstyp"] = None

src/bo4e/bo/bilanzierung.py

@@ -19,7 +19,7 @@
 from bo4e.enum.zeitreihentyp import Zeitreihentyp
 
 from ..enum.abwicklungsmodell import Abwicklungsmodell
-from ..enum.typ import Typ
+from ..enum.botyp import BoTyp
 
 
 class Bilanzierung(Geschaeftsobjekt):
@@ -35,7 +35,7 @@ class Bilanzierung(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Optional[Typ], Field(alias="_typ")] = Typ.BILANZIERUNG
+    typ: Annotated[Optional[BoTyp], Field(alias="_typ")] = BoTyp.BILANZIERUNG
 
     marktlokations_id: Optional[str] = None  #:  ID der Marktlokation
     lastprofil: Optional[list[Lastprofil]] = None  #: Eine Liste der verwendeten Lastprofile (SLP, SLP/TLP, ALP etc.)

src/bo4e/bo/buendelvertrag.py

@@ -9,7 +9,7 @@
 import pydantic
 from pydantic import Field
 
-from ..enum.typ import Typ
+from ..enum.botyp import BoTyp
 from ..utils import postprocess_docstring
 from .geschaeftsobjekt import Geschaeftsobjekt
 
@@ -38,7 +38,7 @@ class Buendelvertrag(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Literal[Typ.BUENDELVERTRAG], Field(alias="_typ")] = Typ.BUENDELVERTRAG
+    typ: Annotated[Literal[BoTyp.BUENDELVERTRAG], Field(alias="_typ")] = BoTyp.BUENDELVERTRAG
 
     # pylint: disable=duplicate-code
     vertragsnummer: Optional[str] = None

src/bo4e/bo/energiemenge.py

@@ -6,7 +6,7 @@
 
 from pydantic import Field
 
-from ..enum.typ import Typ
+from ..enum.botyp import BoTyp
 from ..utils import postprocess_docstring
 from .geschaeftsobjekt import Geschaeftsobjekt
 
@@ -33,7 +33,7 @@ class Energiemenge(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Literal[Typ.ENERGIEMENGE], Field(alias="_typ")] = Typ.ENERGIEMENGE
+    typ: Annotated[Literal[BoTyp.ENERGIEMENGE], Field(alias="_typ")] = BoTyp.ENERGIEMENGE
     lokations_id: Optional[str] = None
     """Eindeutige Nummer der Marktlokation bzw. der Messlokation, zu der die Energiemenge gehört"""
     lokationstyp: Optional["Lokationstyp"] = None

src/bo4e/bo/fremdkosten.py

@@ -6,7 +6,7 @@
 
 from pydantic import Field
 
-from ..enum.typ import Typ
+from ..enum.botyp import BoTyp
 from ..utils import postprocess_docstring
 from .geschaeftsobjekt import Geschaeftsobjekt
 
@@ -35,7 +35,7 @@ class Fremdkosten(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Literal[Typ.FREMDKOSTEN], Field(alias="_typ")] = Typ.FREMDKOSTEN
+    typ: Annotated[Literal[BoTyp.FREMDKOSTEN], Field(alias="_typ")] = BoTyp.FREMDKOSTEN
     gueltigkeit: Optional["Zeitraum"] = None
     """Für diesen Zeitraum wurden die Kosten ermittelt"""
     summe_kosten: Optional["Betrag"] = None

src/bo4e/bo/geraet.py

@@ -6,7 +6,7 @@
 
 from pydantic import Field
 
-from ..enum.typ import Typ
+from ..enum.botyp import BoTyp
 from ..utils import postprocess_docstring
 from .geschaeftsobjekt import Geschaeftsobjekt
 
@@ -32,7 +32,7 @@ class Geraet(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Literal[Typ.GERAET], Field(alias="_typ")] = Typ.GERAET
+    typ: Annotated[Literal[BoTyp.GERAET], Field(alias="_typ")] = BoTyp.GERAET
 
     geraetenummer: Optional[str] = None
     """Die auf dem Gerät aufgedruckte Nummer, die vom MSB vergeben wird."""

src/bo4e/bo/geschaeftspartner.py

@@ -7,7 +7,7 @@
 
 from pydantic import Field
 
-from ..enum.typ import Typ
+from ..enum.botyp import BoTyp
 from ..utils import postprocess_docstring
 from .geschaeftsobjekt import Geschaeftsobjekt
 
@@ -38,7 +38,7 @@ class Geschaeftspartner(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Literal[Typ.GESCHAEFTSPARTNER], Field(alias="_typ")] = Typ.GESCHAEFTSPARTNER
+    typ: Annotated[Literal[BoTyp.GESCHAEFTSPARTNER], Field(alias="_typ")] = BoTyp.GESCHAEFTSPARTNER
     anrede: Optional["Anrede"] = None
     """Mögliche Anrede der Person"""
     individuelle_anrede: Optional[str] = None