From 75c8f213fc70270e3ba4c0238f6537dfc8b1d97f Mon Sep 17 00:00:00 2001 From: Leon Haffmans Date: Fri, 24 Jan 2025 16:09:44 +0100 Subject: [PATCH 1/4] Unify doc string style for `bo` and `com` --- src/bo4e/bo/angebot.py | 28 ++++---- src/bo4e/bo/ausschreibung.py | 16 ++--- src/bo4e/bo/buendelvertrag.py | 34 +++++---- src/bo4e/bo/energiemenge.py | 6 +- src/bo4e/bo/fremdkosten.py | 6 +- src/bo4e/bo/geraet.py | 8 +-- src/bo4e/bo/geschaeftsobjekt.py | 12 ++-- src/bo4e/bo/geschaeftspartner.py | 34 +++++---- src/bo4e/bo/kosten.py | 8 +-- src/bo4e/bo/lastgang.py | 10 +-- src/bo4e/bo/lokationszuordnung.py | 16 ++--- src/bo4e/bo/marktlokation.py | 44 ++++++------ src/bo4e/bo/marktteilnehmer.py | 12 ++-- src/bo4e/bo/messlokation.py | 20 +++--- src/bo4e/bo/netzlokation.py | 22 +++--- src/bo4e/bo/person.py | 18 ++--- src/bo4e/bo/preisblatt.py | 12 ++-- src/bo4e/bo/preisblattdienstleistung.py | 8 +-- src/bo4e/bo/preisblatthardware.py | 10 +-- src/bo4e/bo/preisblattkonzessionsabgabe.py | 2 +- src/bo4e/bo/preisblattmessung.py | 10 +-- src/bo4e/bo/preisblattnetznutzung.py | 4 +- src/bo4e/bo/rechnung.py | 48 ++++++------- src/bo4e/bo/region.py | 6 +- src/bo4e/bo/regionaltarif.py | 14 ++-- src/bo4e/bo/standorteigenschaften.py | 4 +- src/bo4e/bo/steuerbareressource.py | 14 ++-- src/bo4e/bo/tarif.py | 12 ++-- src/bo4e/bo/tarifinfo.py | 26 +++---- src/bo4e/bo/tarifpreisblatt.py | 12 ++-- src/bo4e/bo/technischeressource.py | 30 ++++---- src/bo4e/bo/vertrag.py | 20 +++--- src/bo4e/bo/zaehler.py | 49 ++++++++----- src/bo4e/bo/zeitreihe.py | 18 ++--- src/bo4e/com/adresse.py | 32 ++++++--- src/bo4e/com/angebotsposition.py | 8 +-- src/bo4e/com/angebotsteil.py | 10 +-- src/bo4e/com/angebotsvariante.py | 10 +-- src/bo4e/com/aufabschlag.py | 14 ++-- src/bo4e/com/aufabschlagproort.py | 8 +-- src/bo4e/com/aufabschlagregional.py | 20 +++--- src/bo4e/com/aufabschlagstaffelproort.py | 6 +- src/bo4e/com/ausschreibungsdetail.py | 28 ++++---- src/bo4e/com/ausschreibungslos.py | 32 ++++----- src/bo4e/com/betrag.py | 6 +- src/bo4e/com/com.py | 13 ++-- src/bo4e/com/dienstleistung.py | 4 +- src/bo4e/com/energieherkunft.py | 4 +- src/bo4e/com/energiemix.py | 24 +++---- src/bo4e/com/fremdkostenblock.py | 4 +- src/bo4e/com/fremdkostenposition.py | 8 +-- src/bo4e/com/kontaktweg.py | 8 +-- src/bo4e/com/konzessionsabgabe.py | 6 +- src/bo4e/com/kostenblock.py | 4 +- src/bo4e/com/kostenposition.py | 14 ++-- src/bo4e/com/kriteriumwert.py | 4 +- src/bo4e/com/marktgebietinfo.py | 6 +- src/bo4e/com/menge.py | 4 +- src/bo4e/com/positionsaufabschlag.py | 10 +-- src/bo4e/com/preis.py | 8 +-- src/bo4e/com/preisgarantie.py | 4 +- src/bo4e/com/preisposition.py | 20 +++--- src/bo4e/com/preisstaffel.py | 10 +-- src/bo4e/com/rechnungsposition.py | 30 ++++---- src/bo4e/com/regionalegueltigkeit.py | 10 ++- src/bo4e/com/regionalepreisgarantie.py | 2 +- src/bo4e/com/regionalepreisstaffel.py | 2 +- src/bo4e/com/regionaleraufabschlag.py | 22 +++--- src/bo4e/com/regionaletarifpreisposition.py | 10 +-- src/bo4e/com/regionskriterium.py | 10 ++- src/bo4e/com/sigmoidparameter.py | 12 ++-- src/bo4e/com/standorteigenschaftengas.py | 6 +- src/bo4e/com/standorteigenschaftenstrom.py | 6 +- src/bo4e/com/steuerbetrag.py | 8 +-- src/bo4e/com/tarifberechnungsparameter.py | 18 ++--- src/bo4e/com/tarifeinschraenkung.py | 4 +- src/bo4e/com/tarifpreis.py | 4 +- src/bo4e/com/tarifpreisposition.py | 10 +-- src/bo4e/com/tarifpreispositionproort.py | 6 +- src/bo4e/com/tarifpreisstaffelproort.py | 10 +-- src/bo4e/com/unterschrift.py | 8 ++- src/bo4e/com/verbrauch.py | 14 ++-- src/bo4e/com/vertragskonditionen.py | 14 ++-- src/bo4e/com/zaehlwerk.py | 80 ++++++++++++--------- src/bo4e/com/zaehlzeitregister.py | 9 ++- src/bo4e/com/zeitreihenwert.py | 12 ++-- src/bo4e/com/zeitspanne.py | 6 +- src/bo4e/com/zustaendigkeit.py | 6 +- 88 files changed, 650 insertions(+), 591 deletions(-) diff --git a/src/bo4e/bo/angebot.py b/src/bo4e/bo/angebot.py index 6eaac3380..8de11abc6 100644 --- a/src/bo4e/bo/angebot.py +++ b/src/bo4e/bo/angebot.py @@ -39,27 +39,31 @@ class Angebot(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.ANGEBOT], Field(alias="_typ")] = Typ.ANGEBOT - #: Eindeutige Nummer des Angebotes angebotsnummer: Optional[str] = None - #: Erstellungsdatum des Angebots + """Eindeutige Nummer des Angebotes""" angebotsdatum: Optional[pydantic.AwareDatetime] = None - #: Sparte, für die das Angebot abgegeben wird (Strom/Gas) + """Erstellungsdatum des Angebots""" sparte: Optional["Sparte"] = None - #: Ersteller des Angebots + """Sparte, für die das Angebot abgegeben wird (Strom/Gas)""" angebotsgeber: Optional["Geschaeftspartner"] = None - #: Empfänger des Angebots + """Ersteller des Angebots""" angebotsnehmer: Optional["Geschaeftspartner"] = None + """Empfänger des Angebots""" varianten: Optional[list["Angebotsvariante"]] = None - """ Eine oder mehrere Varianten des Angebots mit den Angebotsteilen; - Ein Angebot besteht mindestens aus einer Variante.""" + """ + Eine oder mehrere Varianten des Angebots mit den Angebotsteilen; + Ein Angebot besteht mindestens aus einer Variante. + """ anfragereferenz: Optional[str] = None - """ Referenz auf eine Anfrage oder Ausschreibung; - Kann dem Empfänger des Angebotes bei Zuordnung des Angebotes zur Anfrage bzw. Ausschreibung helfen.""" - #: Bis zu diesem Zeitpunkt (Tag/Uhrzeit) inklusive gilt das Angebot + """ + Referenz auf eine Anfrage oder Ausschreibung; + Kann dem Empfänger des Angebotes bei Zuordnung des Angebotes zur Anfrage bzw. Ausschreibung helfen. + """ bindefrist: Optional[pydantic.AwareDatetime] = None - #: Person, die als Angebotsnehmer das Angebot angenommen hat + """Bis zu diesem Zeitpunkt (Tag/Uhrzeit) inklusive gilt das Angebot""" unterzeichner_angebotsnehmer: Optional["Person"] = None - #: Person, die als Angebotsgeber das Angebots ausgestellt hat + """Person, die als Angebotsnehmer das Angebot angenommen hat""" unterzeichner_angebotsgeber: Optional["Person"] = None + """Person, die als Angebotsgeber das Angebots ausgestellt hat""" diff --git a/src/bo4e/bo/ausschreibung.py b/src/bo4e/bo/ausschreibung.py index 4c3b05524..e4d3b043e 100644 --- a/src/bo4e/bo/ausschreibung.py +++ b/src/bo4e/bo/ausschreibung.py @@ -37,16 +37,16 @@ class Ausschreibung(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.AUSSCHREIBUNG], Field(alias="_typ")] = Typ.AUSSCHREIBUNG - #: Vom Herausgeber der Ausschreibung vergebene eindeutige Nummer ausschreibungsnummer: Optional[str] = None - #: Aufzählung für die Typisierung von Ausschreibungen + """Vom Herausgeber der Ausschreibung vergebene eindeutige Nummer""" ausschreibungstyp: Optional["Ausschreibungstyp"] = None - #: Bezeichnungen für die Ausschreibungsphasen + """Aufzählung für die Typisierung von Ausschreibungen""" ausschreibungsstatus: Optional["Ausschreibungsstatus"] = None - #: Kennzeichen, ob die Ausschreibung kostenpflichtig ist + """Bezeichnungen für die Ausschreibungsphasen""" ist_kostenpflichtig: Optional[bool] = None - #: Gibt den Veröffentlichungszeitpunkt der Ausschreibung an + """Kennzeichen, ob die Ausschreibung kostenpflichtig ist""" veroeffentlichungszeitpunkt: Optional[pydantic.AwareDatetime] = None + """Gibt den Veröffentlichungszeitpunkt der Ausschreibung an""" ausschreibender: Optional["Geschaeftspartner"] = None """ Mit diesem Objekt können Geschäftspartner übertragen werden. @@ -62,10 +62,10 @@ class Ausschreibung(Geschaeftsobjekt): Diese Komponente wird zur Abbildung von Zeiträumen in Form von Dauern oder der Angabe von Start und Ende verwendet. Es muss daher entweder eine Dauer oder ein Zeitraum in Form von Start und Ende angegeben sein """ - #: Die einzelnen Lose, aus denen sich die Ausschreibung zusammensetzt lose: Optional[list["Ausschreibungslos"]] = None + """Die einzelnen Lose, aus denen sich die Ausschreibung zusammensetzt""" - #: Aufzählung der unterstützten Ausschreibungsportale ausschreibungportal: Optional["Ausschreibungsportal"] = None - #: Internetseite, auf der die Ausschreibung veröffentlicht wurde (falls vorhanden) + """Aufzählung der unterstützten Ausschreibungsportale""" webseite: Optional[str] = None + """Internetseite, auf der die Ausschreibung veröffentlicht wurde (falls vorhanden)""" diff --git a/src/bo4e/bo/buendelvertrag.py b/src/bo4e/bo/buendelvertrag.py index 20747b66d..96767ab57 100644 --- a/src/bo4e/bo/buendelvertrag.py +++ b/src/bo4e/bo/buendelvertrag.py @@ -41,32 +41,36 @@ class Buendelvertrag(Geschaeftsobjekt): typ: Annotated[Literal[Typ.BUENDELVERTRAG], Field(alias="_typ")] = Typ.BUENDELVERTRAG # pylint: disable=duplicate-code - #: Eine im Verwendungskontext eindeutige Nummer für den Vertrag vertragsnummer: Optional[str] = None - #: Hier ist festgelegt, um welche Art von Vertrag es sich handelt. Z.B. Netznutzungvertrag + """Eine im Verwendungskontext eindeutige Nummer für den Vertrag""" vertragsart: Optional["Vertragsart"] = None - #: Gibt den Status des Vertrages an + """Hier ist festgelegt, um welche Art von Vertrag es sich handelt. Z.B. Netznutzungvertrag""" vertragsstatus: Optional["Vertragsstatus"] = None - #: Unterscheidungsmöglichkeiten für die Sparte + """Gibt den Status des Vertrages an""" sparte: Optional["Sparte"] = None - #: Gibt an, wann der Vertrag beginnt (inklusiv) + """Unterscheidungsmöglichkeiten für die Sparte""" vertragsbeginn: Optional[pydantic.AwareDatetime] = None - #: Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv) + """Gibt an, wann der Vertrag beginnt (inklusiv)""" vertragsende: Optional[pydantic.AwareDatetime] = None - #: Der "erstgenannte" Vertragspartner. In der Regel der Aussteller des Vertrags. - #: Beispiel: "Vertrag zwischen Vertagspartner 1 ..." + """Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv)""" vertragspartner1: Optional["Geschaeftspartner"] = None - #: Der "zweitgenannte" Vertragspartner. In der Regel der Empfänger des Vertrags. - #: Beispiel "Vertrag zwischen Vertagspartner 1 und Vertragspartner 2" + """ + Der "erstgenannte" Vertragspartner. In der Regel der Aussteller des Vertrags. + Beispiel: "Vertrag zwischen Vertagspartner 1 ..." + """ vertragspartner2: Optional["Geschaeftspartner"] = None + """ + Der "zweitgenannte" Vertragspartner. In der Regel der Empfänger des Vertrags. + Beispiel "Vertrag zwischen Vertagspartner 1 und Vertragspartner 2" + """ - #: Die Liste mit den Einzelverträgen zu den Abnahmestellen einzelvertraege: Optional[list["Vertrag"]] = None - #: Festlegungen zu Laufzeiten und Kündigungsfristen + """Die Liste mit den Einzelverträgen zu den Abnahmestellen""" vertragskonditionen: Optional[list["Vertragskonditionen"]] = None - #: Unterzeichner des Vertragspartners1 + """Festlegungen zu Laufzeiten und Kündigungsfristen""" unterzeichnervp1: Optional[list["Unterschrift"]] = None - #: Unterzeichner des Vertragspartners2 + """Unterzeichner des Vertragspartners1""" unterzeichnervp2: Optional[list["Unterschrift"]] = None - #: Beschreibung zum Vertrag + """Unterzeichner des Vertragspartners2""" beschreibung: Optional[str] = None + """Beschreibung zum Vertrag""" diff --git a/src/bo4e/bo/energiemenge.py b/src/bo4e/bo/energiemenge.py index 712ee59f2..ed1043ea1 100644 --- a/src/bo4e/bo/energiemenge.py +++ b/src/bo4e/bo/energiemenge.py @@ -35,12 +35,12 @@ class Energiemenge(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.ENERGIEMENGE], Field(alias="_typ")] = Typ.ENERGIEMENGE - #: Eindeutige Nummer der Marktlokation bzw. der Messlokation, zu der die Energiemenge gehört lokations_id: Optional[str] = None + """Eindeutige Nummer der Marktlokation bzw. der Messlokation, zu der die Energiemenge gehört""" # todo: add validator such that only mess- or marktlokations IDs are accepted + cross check with lokationstyp - #: Gibt an, ob es sich um eine Markt- oder Messlokation handelt lokationstyp: Optional["Lokationstyp"] = None + """Gibt an, ob es sich um eine Markt- oder Messlokation handelt""" - #: Gibt den Verbrauch in einer Zeiteinheit an energieverbrauch: Optional[list["Verbrauch"]] = None + """Gibt den Verbrauch in einer Zeiteinheit an""" # there are no optional attributes diff --git a/src/bo4e/bo/fremdkosten.py b/src/bo4e/bo/fremdkosten.py index 322877bb8..5c94223c8 100644 --- a/src/bo4e/bo/fremdkosten.py +++ b/src/bo4e/bo/fremdkosten.py @@ -36,9 +36,9 @@ class Fremdkosten(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.FREMDKOSTEN], Field(alias="_typ")] = Typ.FREMDKOSTEN - #: Für diesen Zeitraum wurden die Kosten ermittelt gueltigkeit: Optional["Zeitraum"] = None - #: Die Gesamtsumme über alle Kostenblöcke und -positionen + """Für diesen Zeitraum wurden die Kosten ermittelt""" summe_kosten: Optional["Betrag"] = None - #: In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele: Netzkosten, Umlagen, Steuern etc + """Die Gesamtsumme über alle Kostenblöcke und -positionen""" kostenbloecke: Optional[list["Fremdkostenblock"]] = None + """In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele: Netzkosten, Umlagen, Steuern etc""" diff --git a/src/bo4e/bo/geraet.py b/src/bo4e/bo/geraet.py index 54cf4cfc3..a0c50f3b6 100644 --- a/src/bo4e/bo/geraet.py +++ b/src/bo4e/bo/geraet.py @@ -35,11 +35,11 @@ class Geraet(Geschaeftsobjekt): typ: Annotated[Literal[Typ.GERAET], Field(alias="_typ")] = Typ.GERAET - #: Die auf dem Gerät aufgedruckte Nummer, die vom MSB vergeben wird. geraetenummer: Optional[str] = None - #: Bezeichnung des Geräts + """Die auf dem Gerät aufgedruckte Nummer, die vom MSB vergeben wird.""" bezeichnung: Optional[str] = None - #: Die übergreifende Klasse eines Geräts, beispielsweise Wandler + """Bezeichnung des Geräts""" geraeteklasse: Optional["Geraeteklasse"] = None - #: Der speziellere Typ eines Gerätes, beispielsweise Stromwandler + """Die übergreifende Klasse eines Geräts, beispielsweise Wandler""" geraetetyp: Optional["Geraetetyp"] = None + """Der speziellere Typ eines Gerätes, beispielsweise Stromwandler""" diff --git a/src/bo4e/bo/geschaeftsobjekt.py b/src/bo4e/bo/geschaeftsobjekt.py index 780d52ca7..728b956c6 100644 --- a/src/bo4e/bo/geschaeftsobjekt.py +++ b/src/bo4e/bo/geschaeftsobjekt.py @@ -31,9 +31,10 @@ class Geschaeftsobjekt(BaseModel): # pragma: no cover """ # required attributes - version: Annotated[Optional[str], Field(alias="_version")] = ( - __version__ #: Version der BO-Struktur aka "fachliche Versionierung" - ) + version: Annotated[Optional[str], Field(alias="_version")] = __version__ + """ + Version der BO-Struktur aka "fachliche Versionierung" + """ zusatz_attribute: Optional[list["ZusatzAttribut"]] = None # zusatz_attribute is a list of ZusatzAttribut objects which are used to store additional information @@ -46,8 +47,8 @@ class Geschaeftsobjekt(BaseModel): # pragma: no cover Z.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System. """ - #: Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID) # pylint: disable=duplicate-code + # basic configuration for pydantic's behaviour model_config = ConfigDict( alias_generator=camelize, populate_by_name=True, @@ -57,6 +58,3 @@ class Geschaeftsobjekt(BaseModel): # pragma: no cover # See this issue for more info: https://github.com/pydantic/pydantic/issues/6375 json_encoders={Decimal: str}, ) - """ - basic configuration for pydantic's behaviour - """ diff --git a/src/bo4e/bo/geschaeftspartner.py b/src/bo4e/bo/geschaeftspartner.py index 0efad7b58..034c13abc 100644 --- a/src/bo4e/bo/geschaeftspartner.py +++ b/src/bo4e/bo/geschaeftspartner.py @@ -40,19 +40,19 @@ class Geschaeftspartner(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.GESCHAEFTSPARTNER], Field(alias="_typ")] = Typ.GESCHAEFTSPARTNER - #: Mögliche Anrede der Person anrede: Optional["Anrede"] = None + """Mögliche Anrede der Person""" individuelle_anrede: Optional[str] = None """ Im Falle einer nicht standardisierten Anrede kann hier eine frei definierbare Anrede vorgegeben werden. Beispiel: "Vereinsgemeinschaft", "Pfarrer", "Hochwürdigster Herr Abt". """ - #: Möglicher Titel der Person titel: Optional["Titel"] = None - #: Vorname der Person + """Möglicher Titel der Person""" vorname: Optional[str] = None - #: Nachname (Familienname) der Person + """Vorname der Person""" nachname: Optional[str] = None + """Nachname (Familienname) der Person""" ansprechpartner: Optional[list["Person"]] = None organisationstyp: Optional["Organisationstyp"] = None @@ -63,22 +63,26 @@ class Geschaeftspartner(Geschaeftsobjekt): """ Name der Firma, wenn Gewerbe oder andere Organisation. """ - #: Kontaktwege des Geschäftspartners kontaktwege: Optional[list["Kontaktweg"]] = None - #: Rollen, die die Geschäftspartner inne haben (z.B. Interessent, Kunde) + """Kontaktwege des Geschäftspartners""" geschaeftspartnerrollen: Optional[list["Geschaeftspartnerrolle"]] = None - #: Handelsregisternummer des Geschäftspartners + """Rollen, die die Geschäftspartner inne haben (z.B. Interessent, Kunde)""" handelsregisternummer: Optional[str] = None - #: Amtsgericht bzw Handelsregistergericht, das die Handelsregisternummer herausgegeben hat + """Handelsregisternummer des Geschäftspartners""" amtsgericht: Optional[str] = None - #: Die Steuer-ID des Geschäftspartners; Beispiel: "DE 813281825" + """Amtsgericht bzw Handelsregistergericht, das die Handelsregisternummer herausgegeben hat""" umsatzsteuer_id: Optional[str] = None - #: Die Gläubiger-ID welche im Zahlungsverkehr verwendet wird; Z.B. "DE 47116789" + """ + Die Steuer-ID des Geschäftspartners; Beispiel: "DE 813281825" + """ glaeubiger_id: Optional[str] = None - #: Internetseite des Marktpartners + """ + Die Gläubiger-ID welche im Zahlungsverkehr verwendet wird; Z.B. "DE 47116789" + """ website: Optional[str] = None - #: Adresse des Geschäftspartners + """Internetseite des Marktpartners""" adresse: Optional["Adresse"] = None - #: Todo: Add optional connection to marktteilnehmer as discussed in workshop - #: not clear what is the best solution here - circular import marktteilnehmer? - #: discussed in workshop on Feb 6 2024: yes we need the bidirectional option, let's figure out a solution somehow. + """Adresse des Geschäftspartners""" + # Todo: Add optional connection to marktteilnehmer as discussed in workshop + # not clear what is the best solution here - circular import marktteilnehmer? + # discussed in workshop on Feb 6 2024: yes we need the bidirectional option, let's figure out a solution somehow. diff --git a/src/bo4e/bo/kosten.py b/src/bo4e/bo/kosten.py index 29e3a48a0..4fd2a6ea3 100644 --- a/src/bo4e/bo/kosten.py +++ b/src/bo4e/bo/kosten.py @@ -37,12 +37,12 @@ class Kosten(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.KOSTEN], Field(alias="_typ")] = Typ.KOSTEN - #: Klasse der Kosten, beispielsweise Fremdkosten kostenklasse: Optional["Kostenklasse"] = None - #: Für diesen Zeitraum wurden die Kosten ermittelt + """Klasse der Kosten, beispielsweise Fremdkosten""" gueltigkeit: Optional["Zeitraum"] = None - #: In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele: Netzkosten, Umlagen, Steuern etc + """Für diesen Zeitraum wurden die Kosten ermittelt""" kostenbloecke: Optional[list["Kostenblock"]] = None + """In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele: Netzkosten, Umlagen, Steuern etc""" - #: Die Gesamtsumme über alle Kostenblöcke und -positionen summe_kosten: Optional[list["Betrag"]] = None + """Die Gesamtsumme über alle Kostenblöcke und -positionen""" diff --git a/src/bo4e/bo/lastgang.py b/src/bo4e/bo/lastgang.py index f334cec1a..083ca1bf5 100644 --- a/src/bo4e/bo/lastgang.py +++ b/src/bo4e/bo/lastgang.py @@ -41,18 +41,18 @@ class Lastgang(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.LASTGANG], Field(alias="_typ")] = Typ.LASTGANG - #: Angabe, ob es sich um einen Gas- oder Stromlastgang handelt sparte: Optional["Sparte"] = None - #: Definition der gemessenen Größe anhand ihrer Einheit + """Angabe, ob es sich um einen Gas- oder Stromlastgang handelt""" messgroesse: Optional["Mengeneinheit"] = None + """Definition der gemessenen Größe anhand ihrer Einheit""" #:Marktlokation, zu der der Lastgang gehört marktlokation: Optional["Marktlokation"] = None #:Marktlokation, zu der der Lastgang gehört messlokation: Optional["Messlokation"] = None - #: Die im Lastgang enthaltenen Messwerte werte: Optional[list["Zeitreihenwert"]] = None - #: Versionsnummer des Lastgangs + """Die im Lastgang enthaltenen Messwerte""" version: Optional[str] = None - #: Die OBIS-Kennzahl für den Wert, die festlegt, welche Größe mit dem Stand gemeldet wird, z.B. '1-0:1.8.1' + """Versionsnummer des Lastgangs""" obis_kennzahl: Optional[str] = None + """Die OBIS-Kennzahl für den Wert, die festlegt, welche Größe mit dem Stand gemeldet wird, z.B. '1-0:1.8.1'""" zeit_intervall_laenge: Optional["Menge"] diff --git a/src/bo4e/bo/lokationszuordnung.py b/src/bo4e/bo/lokationszuordnung.py index 1aecf8008..4e2c08065 100644 --- a/src/bo4e/bo/lokationszuordnung.py +++ b/src/bo4e/bo/lokationszuordnung.py @@ -35,19 +35,19 @@ class Lokationszuordnung(Geschaeftsobjekt): typ: Annotated[Literal[Typ.LOKATIONSZUORDNUNG], Field(alias="_typ")] = Typ.LOKATIONSZUORDNUNG - #: Liste mit referenzierten Marktlokationen marktlokationen: Optional[list["Marktlokation"]] = None - #: Liste mit referenzierten Messlokationen + """Liste mit referenzierten Marktlokationen""" messlokationen: Optional[list["Messlokation"]] = None - #: Liste mit referenzierten Netzlokationen + """Liste mit referenzierten Messlokationen""" netzlokationen: Optional[list["Netzlokation"]] = None - #: Liste mit referenzierten technischen Ressourcen + """Liste mit referenzierten Netzlokationen""" technische_ressourcen: Optional[list["TechnischeRessource"]] = None - #: Liste mit referenzierten steuerbaren Ressourcen + """Liste mit referenzierten technischen Ressourcen""" steuerbare_ressourcen: Optional[list["SteuerbareRessource"]] = None - #: Zeitspanne der Gültigkeit + """Liste mit referenzierten steuerbaren Ressourcen""" gueltigkeit: Optional["Zeitspanne"] = None - #: Verknüpfungsrichtung z.B. Malo-Melo [TODO: Eventuell anderer Datentyp] + """Zeitspanne der Gültigkeit""" zuordnungstyp: Optional[str] = None - #: Code, der angibt wie die Lokationsbündelstruktur zusammengesetzt ist (zu finden unter "Codeliste der Lokationsbündelstrukturen" auf https://www.edi-energy.de/index.php?id=38) + """Verknüpfungsrichtung z.B. Malo-Melo [TODO: Eventuell anderer Datentyp]""" lokationsbuendelcode: Optional[str] = None + """Code, der angibt wie die Lokationsbündelstruktur zusammengesetzt ist (zu finden unter "Codeliste der Lokationsbündelstrukturen" auf https://www.edi-energy.de/index.php?id=38)""" diff --git a/src/bo4e/bo/marktlokation.py b/src/bo4e/bo/marktlokation.py index 9724bac98..01b896160 100644 --- a/src/bo4e/bo/marktlokation.py +++ b/src/bo4e/bo/marktlokation.py @@ -48,14 +48,14 @@ class Marktlokation(Geschaeftsobjekt): typ: Annotated[Literal[Typ.MARKTLOKATION], Field(alias="_typ")] = Typ.MARKTLOKATION - #: Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird. marktlokations_id: Optional[str] = None - #: Sparte der Marktlokation, z.B. Gas oder Strom + """Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird.""" sparte: Optional["Sparte"] = None - #: Kennzeichnung, ob Energie eingespeist oder entnommen (ausgespeist) wird + """Sparte der Marktlokation, z.B. Gas oder Strom""" energierichtung: Optional["Energierichtung"] = None - #: Die Bilanzierungsmethode, RLM oder SLP + """Kennzeichnung, ob Energie eingespeist oder entnommen (ausgespeist) wird""" bilanzierungsmethode: Optional["Bilanzierungsmethode"] = None + """Die Bilanzierungsmethode, RLM oder SLP""" netzebene: Optional["Netzebene"] = None """ Netzebene, in der der Bezug der Energie erfolgt. @@ -63,28 +63,28 @@ class Marktlokation(Geschaeftsobjekt): Beispiel Strom: Niederspannung Beispiel Gas: Niederdruck. """ - #: Verbrauchsart der Marktlokation. verbrauchsart: Optional["Verbrauchsart"] = None - #: Gibt an, ob es sich um eine unterbrechbare Belieferung handelt + """Verbrauchsart der Marktlokation.""" ist_unterbrechbar: Optional[bool] = None - #: Codenummer des Netzbetreibers, an dessen Netz diese Marktlokation angeschlossen ist. + """Gibt an, ob es sich um eine unterbrechbare Belieferung handelt""" netzbetreibercodenr: Optional[str] = None - #: Typ des Netzgebietes, z.B. Verteilnetz + """Codenummer des Netzbetreibers, an dessen Netz diese Marktlokation angeschlossen ist.""" gebietstyp: Optional["Gebiettyp"] = None - #: Die ID des Gebietes in der ene't-Datenbank - netzgebietsnr: Optional[str] = None # todo: rename to "id" (see 2021-12-15 update) - #: Bilanzierungsgebiet, dem das Netzgebiet zugeordnet ist - im Falle eines Strom Netzes + """Typ des Netzgebietes, z.B. Verteilnetz""" + netzgebietsnr: Optional[str] = None + """Die ID des Gebietes in der ene't-Datenbank""" # todo: rename to "id" (see 2021-12-15 update) bilanzierungsgebiet: Optional[str] = None - #: Codenummer des Grundversorgers, der für diese Marktlokation zuständig ist + """Bilanzierungsgebiet, dem das Netzgebiet zugeordnet ist - im Falle eines Strom Netzes""" grundversorgercodenr: Optional[str] = None - #: Die Gasqualität in diesem Netzgebiet. H-Gas oder L-Gas. Im Falle eines Gas-Netzes + """Codenummer des Grundversorgers, der für diese Marktlokation zuständig ist""" gasqualitaet: Optional["Gasqualitaet"] = None - #: Geschäftspartner, dem diese Marktlokation gehört + """Die Gasqualität in diesem Netzgebiet. H-Gas oder L-Gas. Im Falle eines Gas-Netzes""" endkunde: Optional["Geschaeftspartner"] = None + """Geschäftspartner, dem diese Marktlokation gehört""" # only one of the following three optional attributes can be set - #: Die Adresse, an der die Energie-Lieferung oder -Einspeisung erfolgt lokationsadresse: Optional["Adresse"] = None + """Die Adresse, an der die Energie-Lieferung oder -Einspeisung erfolgt""" geoadresse: Optional["Geokoordinaten"] = None """ Alternativ zu einer postalischen Adresse kann hier ein Ort mittels Geokoordinaten angegeben werden @@ -97,17 +97,17 @@ class Marktlokation(Geschaeftsobjekt): """ kundengruppen: Optional[list["Kundentyp"]] = None - #: Kundengruppen der Marktlokation + """Kundengruppen der Marktlokation""" - regelzone: Optional[str] = ( - None #: für Strom. Code vom EIC, https://www.entsoe.eu/data/energy-identification-codes-eic/eic-approved-codes/ - ) - marktgebiet: Optional[str] = None #: für Gas. Code vom EIC, https://www.entsog.eu/data/data-portal/codes-list + regelzone: Optional[str] = None + """für Strom. Code vom EIC, https://www.entsoe.eu/data/energy-identification-codes-eic/eic-approved-codes/""" + marktgebiet: Optional[str] = None + """für Gas. Code vom EIC, https://www.entsog.eu/data/data-portal/codes-list""" zaehlwerke: Optional[list["Zaehlwerk"]] = None verbrauchsmengen: Optional[list["Verbrauch"]] = None zaehlwerke_der_beteiligten_marktrolle: Optional[list["Zaehlwerk"]] = None - #: Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben lokationszuordnungen: Optional[list["Lokationszuordnung"]] = None - #: Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt. + """Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben""" lokationsbuendel_objektcode: Optional[str] = None + """Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.""" diff --git a/src/bo4e/bo/marktteilnehmer.py b/src/bo4e/bo/marktteilnehmer.py index 6474acfd9..b207d0a3f 100644 --- a/src/bo4e/bo/marktteilnehmer.py +++ b/src/bo4e/bo/marktteilnehmer.py @@ -35,15 +35,15 @@ class Marktteilnehmer(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.MARKTTEILNEHMER], Field(alias="_typ")] = Typ.MARKTTEILNEHMER - #: Gibt im Klartext die Bezeichnung der Marktrolle an marktrolle: Optional["Marktrolle"] = None - #: Gibt die Codenummer der Marktrolle an + """Gibt im Klartext die Bezeichnung der Marktrolle an""" rollencodenummer: Optional[str] = None - #: Gibt den Typ des Codes an + """Gibt die Codenummer der Marktrolle an""" rollencodetyp: Optional["Rollencodetyp"] = None - #: Sparte des Marktteilnehmers, z.B. Gas oder Strom + """Gibt den Typ des Codes an""" sparte: Optional["Sparte"] = None - #: Die 1:1-Kommunikationsadresse des Marktteilnehmers. Diese wird in der Marktkommunikation verwendet. Konkret kann dies eine eMail-Adresse oder ein AS4-Endpunkt sein. + """Sparte des Marktteilnehmers, z.B. Gas oder Strom""" makoadresse: Optional[list[str]] = None - #: Der zu diesem Marktteilnehmer gehörende Geschäftspartner + """Die 1:1-Kommunikationsadresse des Marktteilnehmers. Diese wird in der Marktkommunikation verwendet. Konkret kann dies eine eMail-Adresse oder ein AS4-Endpunkt sein.""" geschaeftspartner: Optional["Geschaeftspartner"] = None + """Der zu diesem Marktteilnehmer gehörende Geschäftspartner""" diff --git a/src/bo4e/bo/messlokation.py b/src/bo4e/bo/messlokation.py index 8c6705b80..0c447501f 100644 --- a/src/bo4e/bo/messlokation.py +++ b/src/bo4e/bo/messlokation.py @@ -41,21 +41,21 @@ class Messlokation(Geschaeftsobjekt): typ: Annotated[Literal[Typ.MESSLOKATION], Field(alias="_typ")] = Typ.MESSLOKATION - #: Die Messlokations-Identifikation; Das ist die frühere Zählpunktbezeichnung messlokations_id: Optional[str] = None - #: Sparte der Messlokation, z.B. Gas oder Strom + """Die Messlokations-Identifikation; Das ist die frühere Zählpunktbezeichnung""" sparte: Optional["Sparte"] = None + """Sparte der Messlokation, z.B. Gas oder Strom""" - #: Spannungsebene der Messung netzebene_messung: Optional["Netzebene"] = None - #: Die Nummer des Messgebietes in der ene't-Datenbank + """Spannungsebene der Messung""" messgebietnr: Optional[str] = None - #: Liste der Geräte, die zu dieser Messstelle gehört + """Die Nummer des Messgebietes in der ene't-Datenbank""" geraete: Optional[list["Geraet"]] = None - #: Liste der Messdienstleistungen, die zu dieser Messstelle gehört - messdienstleistung: Optional[list["Dienstleistung"]] = None # todo: rename to plural - #: Zähler, die zu dieser Messlokation gehören + """Liste der Geräte, die zu dieser Messstelle gehört""" + messdienstleistung: Optional[list["Dienstleistung"]] = None + """Liste der Messdienstleistungen, die zu dieser Messstelle gehört""" # todo: rename to plural messlokationszaehler: Optional[list["Zaehler"]] = None + """Zähler, die zu dieser Messlokation gehören""" # only one of the following two optional codenr attributes can be set grundzustaendiger_msb_codenr: Optional[str] = None @@ -85,7 +85,7 @@ class Messlokation(Geschaeftsobjekt): Alternativ zu einer postalischen Adresse und Geokoordinaten kann hier eine Ortsangabe mittels Gemarkung und Flurstück erfolgen. """ - #: Lokationszuordnung, um bspw. die zugehörigen Marktlokationen anzugeben lokationszuordnungen: Optional[list["Lokationszuordnung"]] = None - #: Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt. + """Lokationszuordnung, um bspw. die zugehörigen Marktlokationen anzugeben""" lokationsbuendel_objektcode: Optional[str] = None + """Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.""" diff --git a/src/bo4e/bo/netzlokation.py b/src/bo4e/bo/netzlokation.py index 034f88741..3411247d5 100644 --- a/src/bo4e/bo/netzlokation.py +++ b/src/bo4e/bo/netzlokation.py @@ -39,25 +39,25 @@ class Netzlokation(Geschaeftsobjekt): typ: Annotated[Literal[Typ.NETZLOKATION], Field(alias="_typ")] = Typ.NETZLOKATION - #: Identifikationsnummer einer Netzlokation, an der Energie entweder verbraucht, oder erzeugt wird netzlokations_id: Optional[str] = None - #: Sparte der Netzlokation, z.B. Gas oder Strom. + """Identifikationsnummer einer Netzlokation, an der Energie entweder verbraucht, oder erzeugt wird""" sparte: Optional["Sparte"] = None - #: Netzanschlussleistungsmenge der Netzlokation + """Sparte der Netzlokation, z.B. Gas oder Strom.""" netzanschlussleistung: Optional["Menge"] = None - #: Codenummer des grundzuständigen Messstellenbetreibers, der für diese Netzlokation zuständig ist. + """Netzanschlussleistungsmenge der Netzlokation""" grundzustaendiger_msb_codenr: Optional[str] = None - #: Ob ein Steuerkanal der Netzlokation zugeordnet ist und somit die Netzlokation gesteuert werden kann. + """Codenummer des grundzuständigen Messstellenbetreibers, der für diese Netzlokation zuständig ist.""" steuerkanal: Optional[bool] = None - #: Die OBIS-Kennzahl für die Netzlokation + """Ob ein Steuerkanal der Netzlokation zugeordnet ist und somit die Netzlokation gesteuert werden kann.""" obiskennzahl: Optional[str] = None - #: Verwendungungszweck der Werte Netzlokation + """Die OBIS-Kennzahl für die Netzlokation""" verwendungszweck: Optional["VerwendungszweckProMarktrolle"] = None - #: Produkt-Daten der Netzlokation + """Verwendungungszweck der Werte Netzlokation""" konfigurationsprodukte: Optional[list["Konfigurationsprodukt"]] = None - #: Eigenschaft des Messstellenbetreibers an der Lokation + """Produkt-Daten der Netzlokation""" eigenschaft_msb_lokation: Optional["Marktrolle"] = None - #: Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben + """Eigenschaft des Messstellenbetreibers an der Lokation""" lokationszuordnungen: Optional[list["Lokationszuordnung"]] = None - #: Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt. + """Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben""" lokationsbuendel_objektcode: Optional[str] = None + """Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.""" diff --git a/src/bo4e/bo/person.py b/src/bo4e/bo/person.py index 0a4b17e65..5b69754d6 100644 --- a/src/bo4e/bo/person.py +++ b/src/bo4e/bo/person.py @@ -38,26 +38,26 @@ class Person(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.PERSON], Field(alias="_typ")] = Typ.PERSON - #: Mögliche Anrede der Person anrede: Optional["Anrede"] = None + """Mögliche Anrede der Person""" individuelle_anrede: Optional[str] = None """ Im Falle einer nicht standardisierten Anrede kann hier eine frei definierbare Anrede vorgegeben werden. Beispiel: "Vereinsgemeinschaft", "Pfarrer", "Hochwürdigster Herr Abt". """ - #: Möglicher Titel der Person titel: Optional["Titel"] = None - #: Vorname der Person + """Möglicher Titel der Person""" vorname: Optional[str] = None - #: Nachname (Familienname) der Person + """Vorname der Person""" nachname: Optional[str] = None - #: Kontaktwege der Person + """Nachname (Familienname) der Person""" kontaktwege: Optional[list["Kontaktweg"]] = None - #: Geburtsdatum der Person + """Kontaktwege der Person""" geburtsdatum: Optional[pydantic.AwareDatetime] = None - #: Weitere Informationen zur Person + """Geburtsdatum der Person""" kommentar: Optional[str] = None - #: Liste der Abteilungen und Zuständigkeiten der Person + """Weitere Informationen zur Person""" zustaendigkeiten: Optional[list["Zustaendigkeit"]] = None - #: Adresse der Person, falls diese von der Adresse des Geschäftspartners abweicht + """Liste der Abteilungen und Zuständigkeiten der Person""" adresse: Optional["Adresse"] = None + """Adresse der Person, falls diese von der Adresse des Geschäftspartners abweicht""" diff --git a/src/bo4e/bo/preisblatt.py b/src/bo4e/bo/preisblatt.py index fcb8a7809..8927ff322 100644 --- a/src/bo4e/bo/preisblatt.py +++ b/src/bo4e/bo/preisblatt.py @@ -41,15 +41,15 @@ class Preisblatt(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.PREISBLATT], Field(alias="_typ")] = Typ.PREISBLATT - #: Eine Bezeichnung für das Preisblatt bezeichnung: Optional[str] = None - #: Preisblatt gilt für angegebene Sparte + """Eine Bezeichnung für das Preisblatt""" sparte: Optional["Sparte"] = None - #: Merkmal, das anzeigt, ob es sich um vorläufige oder endgültige Preise handelt + """Preisblatt gilt für angegebene Sparte""" preisstatus: Optional["Preisstatus"] = None - #: Der Zeitraum für den der Preis festgelegt ist + """Merkmal, das anzeigt, ob es sich um vorläufige oder endgültige Preise handelt""" gueltigkeit: Optional["Zeitraum"] = None - #: Die einzelnen Positionen, die mit dem Preisblatt abgerechnet werden können. Z.B. Arbeitspreis, Grundpreis etc + """Der Zeitraum für den der Preis festgelegt ist""" preispositionen: Optional[list["Preisposition"]] = None - #: Der Netzbetreiber, der die Preise veröffentlicht hat + """Die einzelnen Positionen, die mit dem Preisblatt abgerechnet werden können. Z.B. Arbeitspreis, Grundpreis etc""" herausgeber: Optional["Marktteilnehmer"] = None + """Der Netzbetreiber, der die Preise veröffentlicht hat""" diff --git a/src/bo4e/bo/preisblattdienstleistung.py b/src/bo4e/bo/preisblattdienstleistung.py index b61142e78..b13b8971f 100644 --- a/src/bo4e/bo/preisblattdienstleistung.py +++ b/src/bo4e/bo/preisblattdienstleistung.py @@ -37,13 +37,13 @@ class PreisblattDienstleistung(Preisblatt): Typ.PREISBLATTDIENSTLEISTUNG # type: ignore[assignment] ) # required attributes (additional to those of Preisblatt) - #: Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode bilanzierungsmethode: Optional["Bilanzierungsmethode"] = None - #: Dienstleistung, für die der Preis abgebildet wird, z.B. Sperrung/Entsperrung + """Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode""" basisdienstleistung: Optional["Dienstleistungstyp"] = None + """Dienstleistung, für die der Preis abgebildet wird, z.B. Sperrung/Entsperrung""" - #: Hier kann der Preis auf bestimmte Geräte eingegrenzt werden. Z.B. auf die Zählergröße geraetedetails: Optional["Geraet"] = None + """Hier kann der Preis auf bestimmte Geräte eingegrenzt werden. Z.B. auf die Zählergröße""" - #: Weitere Dienstleistungen, die im Preis enthalten sind inklusive_dienstleistungen: Optional[list["Dienstleistungstyp"]] = None + """Weitere Dienstleistungen, die im Preis enthalten sind""" diff --git a/src/bo4e/bo/preisblatthardware.py b/src/bo4e/bo/preisblatthardware.py index f18261307..f7f7361c1 100644 --- a/src/bo4e/bo/preisblatthardware.py +++ b/src/bo4e/bo/preisblatthardware.py @@ -38,16 +38,16 @@ class PreisblattHardware(Preisblatt): Typ.PREISBLATTHARDWARE # type: ignore[assignment] ) # required attributes (additional to those of Preisblatt) - #: Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode bilanzierungsmethode: Optional["Bilanzierungsmethode"] = None - #: Die Preise gelten für Messlokationen in der angebebenen Netzebene + """Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode""" messebene: Optional["Netzebene"] = None + """Die Preise gelten für Messlokationen in der angebebenen Netzebene""" - #: Der Preis betriftt das hier angegebene Gerät, z.B. ein Tarifschaltgerät basisgeraet: Optional["Geraet"] = None + """Der Preis betriftt das hier angegebene Gerät, z.B. ein Tarifschaltgerät""" - #: Im Preis sind die hier angegebenen Dienstleistungen enthalten, z.B. Jährliche Ablesung inklusive_dienstleistungen: Optional[list["Dienstleistungstyp"]] = None + """Im Preis sind die hier angegebenen Dienstleistungen enthalten, z.B. Jährliche Ablesung""" - #: Im Preis sind die hier angegebenen Geräte mit enthalten, z.B. ein Wandler inklusive_geraete: Optional[list["Geraet"]] = None + """Im Preis sind die hier angegebenen Geräte mit enthalten, z.B. ein Wandler""" diff --git a/src/bo4e/bo/preisblattkonzessionsabgabe.py b/src/bo4e/bo/preisblattkonzessionsabgabe.py index d98b6c44e..63b5975b6 100644 --- a/src/bo4e/bo/preisblattkonzessionsabgabe.py +++ b/src/bo4e/bo/preisblattkonzessionsabgabe.py @@ -35,7 +35,7 @@ class PreisblattKonzessionsabgabe(Preisblatt): Typ.PREISBLATTKONZESSIONSABGABE # type: ignore[assignment] ) # required attributes (additional to those of Preisblatt) - #: Kundegruppe anhand derer die Höhe der Konzessionabgabe festgelegt ist kundengruppe_k_a: Optional["KundengruppeKA"] = None + """Kundegruppe anhand derer die Höhe der Konzessionabgabe festgelegt ist""" # there are no optional attributes (additionally to those of Preisblatt) diff --git a/src/bo4e/bo/preisblattmessung.py b/src/bo4e/bo/preisblattmessung.py index f0cb7a871..426cead9c 100644 --- a/src/bo4e/bo/preisblattmessung.py +++ b/src/bo4e/bo/preisblattmessung.py @@ -39,16 +39,16 @@ class PreisblattMessung(Preisblatt): Typ.PREISBLATTMESSUNG # type: ignore[assignment] ) # required attributes (additional to those of Preisblatt) - #: Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode bilanzierungsmethode: Optional["Bilanzierungsmethode"] = None - #: Die Preise gelten für Messlokationen in der angebebenen Netzebene + """Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode""" messebene: Optional["Netzebene"] = None + """Die Preise gelten für Messlokationen in der angebebenen Netzebene""" - #: Der Preis betrifft den hier angegebenen Zähler, z.B. einen Drehstromzähler zaehler: Optional["Zaehler"] = None + """Der Preis betrifft den hier angegebenen Zähler, z.B. einen Drehstromzähler""" - #: Im Preis sind die hier angegebenen Dienstleistungen enthalten, z.B. Jährliche Ablesung inklusive_dienstleistungen: Optional[list["Dienstleistungstyp"]] = None + """Im Preis sind die hier angegebenen Dienstleistungen enthalten, z.B. Jährliche Ablesung""" - #: Im Preis sind die hier angegebenen Geräte mit enthalten, z.B. ein Wandler inklusive_geraete: Optional[list["Geraet"]] = None + """Im Preis sind die hier angegebenen Geräte mit enthalten, z.B. ein Wandler""" diff --git a/src/bo4e/bo/preisblattnetznutzung.py b/src/bo4e/bo/preisblattnetznutzung.py index 74521e585..52ef2f58f 100644 --- a/src/bo4e/bo/preisblattnetznutzung.py +++ b/src/bo4e/bo/preisblattnetznutzung.py @@ -37,10 +37,10 @@ class PreisblattNetznutzung(Preisblatt): Typ.PREISBLATTNETZNUTZUNG # type: ignore[assignment] ) # required attributes (additional to those of Preisblatt) - #: Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode bilanzierungsmethode: Optional["Bilanzierungsmethode"] = None - #: Die Preise gelten für Marktlokationen in der angebebenen Netzebene + """Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode""" netzebene: Optional["Netzebene"] = None + """Die Preise gelten für Marktlokationen in der angebebenen Netzebene""" kundengruppe: Optional["Kundengruppe"] = None # there are no optional attributes (additionally to those of Preisblatt) diff --git a/src/bo4e/bo/rechnung.py b/src/bo4e/bo/rechnung.py index 2d17f7c05..6d5502d1d 100644 --- a/src/bo4e/bo/rechnung.py +++ b/src/bo4e/bo/rechnung.py @@ -49,56 +49,56 @@ class Rechnung(Geschaeftsobjekt): Kennzeichnung, ob es sich um eine Stornorechnung handelt; im Falle "true" findet sich im Attribut "originalrechnungsnummer" die Nummer der Originalrechnung. """ - #: Eine im Verwendungskontext eindeutige Nummer für die Rechnung rechnungsnummer: Optional[str] = None - #: Ausstellungsdatum der Rechnung + """Eine im Verwendungskontext eindeutige Nummer für die Rechnung""" rechnungsdatum: Optional[pydantic.AwareDatetime] = None - #: Zu diesem Datum ist die Zahlung fällig + """Ausstellungsdatum der Rechnung""" faelligkeitsdatum: Optional[pydantic.AwareDatetime] = None - #: Ein kontextbezogender Rechnungstyp, z.B. Netznutzungsrechnung + """Zu diesem Datum ist die Zahlung fällig""" rechnungstyp: Optional["Rechnungstyp"] = None - #: Der Zeitraum der zugrunde liegenden Lieferung zur Rechnung + """Ein kontextbezogender Rechnungstyp, z.B. Netznutzungsrechnung""" rechnungsperiode: Optional["Zeitraum"] = None - #: Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer + """Der Zeitraum der zugrunde liegenden Lieferung zur Rechnung""" rechnungsersteller: Optional["Geschaeftspartner"] = None - #: Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer + """Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer""" rechnungsempfaenger: Optional["Geschaeftspartner"] = None - #: Die Summe der Nettobeträge der Rechnungsteile + """Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer""" gesamtnetto: Optional["Betrag"] = None - #: Die Summe der Steuerbeträge der Rechnungsteile + """Die Summe der Nettobeträge der Rechnungsteile""" gesamtsteuer: Optional["Betrag"] = None - #: Die Summe aus Netto- und Steuerbetrag + """Die Summe der Steuerbeträge der Rechnungsteile""" gesamtbrutto: Optional["Betrag"] = None - #: Der zu zahlende Betrag, der sich aus (gesamtbrutto - vorausbezahlt - rabattBrutto) ergibt + """Die Summe aus Netto- und Steuerbetrag""" zu_zahlen: Optional["Betrag"] = None - #: Die Rechnungspositionen + """Der zu zahlende Betrag, der sich aus (gesamtbrutto - vorausbezahlt - rabattBrutto) ergibt""" rechnungspositionen: Optional[list["Rechnungsposition"]] = None - #: Bezeichnung für die vorliegende Rechnung + """Die Rechnungspositionen""" rechnungstitel: Optional[str] = None - #: Status der Rechnung zur Kennzeichnung des Bearbeitungsstandes + """Bezeichnung für die vorliegende Rechnung""" rechnungsstatus: Optional["Rechnungsstatus"] = None - #: Im Falle einer Stornorechnung (storno = true) steht hier die Rechnungsnummer der stornierten Rechnung + """Status der Rechnung zur Kennzeichnung des Bearbeitungsstandes""" original_rechnungsnummer: Optional[str] = None - #: Die Summe evtl. vorausgezahlter Beträge, z.B. Abschläge. Angabe als Bruttowert + """Im Falle einer Stornorechnung (storno = true) steht hier die Rechnungsnummer der stornierten Rechnung""" vorausgezahlt: Optional["Betrag"] = None - #: Gesamtrabatt auf den Bruttobetrag + """Die Summe evtl. vorausgezahlter Beträge, z.B. Abschläge. Angabe als Bruttowert""" rabatt_brutto: Optional["Betrag"] = None + """Gesamtrabatt auf den Bruttobetrag""" steuerbetraege: Optional[list["Steuerbetrag"]] = None """ Eine Liste mit Steuerbeträgen pro Steuerkennzeichen/Steuersatz; die Summe dieser Beträge ergibt den Wert für gesamtsteuer. """ - #: Sparte (Strom, Gas ...) für die die Rechnung ausgestellt ist sparte: Optional["Sparte"] = None - #: Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt + """Sparte (Strom, Gas ...) für die die Rechnung ausgestellt ist""" netznutzungrechnungsart: Optional["NetznutzungRechnungsart"] = None - #: Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt + """Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt""" netznutzungrechnungstyp: Optional["NetznutzungRechnungstyp"] = None - #: Kennzeichen, ob es sich um ein Original (true) oder eine Kopie handelt (false) + """Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt""" ist_original: Optional[bool] = None - #: Kennzeichen, ob es sich um eine simulierte Rechnung, z.B. zur Rechnungsprüfung handelt + """Kennzeichen, ob es sich um ein Original (true) oder eine Kopie handelt (false)""" ist_simuliert: Optional[bool] = None - #: Marktlokation, auf die sich die Rechnung bezieht + """Kennzeichen, ob es sich um eine simulierte Rechnung, z.B. zur Rechnungsprüfung handelt""" marktlokation: Optional["Marktlokation"] = None - #: Messlokation, auf die sich die Rechnung bezieht + """Marktlokation, auf die sich die Rechnung bezieht""" messlokation: Optional["Messlokation"] = None + """Messlokation, auf die sich die Rechnung bezieht""" diff --git a/src/bo4e/bo/region.py b/src/bo4e/bo/region.py index 85637068e..b757f8cd3 100644 --- a/src/bo4e/bo/region.py +++ b/src/bo4e/bo/region.py @@ -33,11 +33,11 @@ class Region(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.REGION], Field(alias="_typ")] = Typ.REGION - #: Bezeichnung der Region bezeichnung: Optional[str] = None + """Bezeichnung der Region""" - #: Positivliste der Kriterien zur Definition der Region positiv_liste: Optional[list["Regionskriterium"]] = None + """Positivliste der Kriterien zur Definition der Region""" - #: Negativliste der Kriterien zur Definition der Region negativ_liste: Optional[list["Regionskriterium"]] = None + """Negativliste der Kriterien zur Definition der Region""" diff --git a/src/bo4e/bo/regionaltarif.py b/src/bo4e/bo/regionaltarif.py index ad5dd9ce4..5deb10346 100644 --- a/src/bo4e/bo/regionaltarif.py +++ b/src/bo4e/bo/regionaltarif.py @@ -23,8 +23,8 @@ class Regionaltarif(Tarifinfo): - #: Abbildung eines Tarifs mit regionaler Zuordnung von Preisen und Auf- und Abschlägen. """ + Abbildung eines Tarifs mit regionaler Zuordnung von Preisen und Auf- und Abschlägen. .. raw:: html @@ -36,16 +36,16 @@ class Regionaltarif(Tarifinfo): """ typ: Annotated[Literal[Typ.REGIONALTARIF], Field(alias="_typ")] = Typ.REGIONALTARIF # type: ignore[assignment] - #: Gibt an, wann der Preis zuletzt angepasst wurde preisstand: Optional[pydantic.AwareDatetime] = None - #: Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen + """Gibt an, wann der Preis zuletzt angepasst wurde""" berechnungsparameter: Optional["Tarifberechnungsparameter"] = None - #: Die festgelegten Preise mit regionaler Eingrenzung, z.B. für Arbeitspreis, Grundpreis etc. + """Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen""" tarifpreise: Optional[list["RegionaleTarifpreisposition"]] = None + """Die festgelegten Preise mit regionaler Eingrenzung, z.B. für Arbeitspreis, Grundpreis etc.""" - #: Auf- und Abschläge auf die Preise oder Kosten mit regionaler Eingrenzung tarif_auf_abschlaege: Optional[list["RegionalerAufAbschlag"]] = None - #: Festlegung von Garantien für bestimmte Preisanteile + """Auf- und Abschläge auf die Preise oder Kosten mit regionaler Eingrenzung""" preisgarantien: Optional[list["RegionalePreisgarantie"]] = None - #: Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann + """Festlegung von Garantien für bestimmte Preisanteile""" tarifeinschraenkung: Optional["Tarifeinschraenkung"] = None + """Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann""" diff --git a/src/bo4e/bo/standorteigenschaften.py b/src/bo4e/bo/standorteigenschaften.py index 632eb8ca8..31835f7c6 100644 --- a/src/bo4e/bo/standorteigenschaften.py +++ b/src/bo4e/bo/standorteigenschaften.py @@ -33,8 +33,8 @@ class Standorteigenschaften(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.STANDORTEIGENSCHAFTEN], Field(alias="_typ")] = Typ.STANDORTEIGENSCHAFTEN - #: Eigenschaften zur Sparte Strom eigenschaften_strom: Optional[list["StandorteigenschaftenStrom"]] = None + """Eigenschaften zur Sparte Strom""" - #: Eigenschaften zur Sparte Gas eigenschaften_gas: Optional["StandorteigenschaftenGas"] = None + """Eigenschaften zur Sparte Gas""" diff --git a/src/bo4e/bo/steuerbareressource.py b/src/bo4e/bo/steuerbareressource.py index ae35f7ec0..a42ba4c15 100644 --- a/src/bo4e/bo/steuerbareressource.py +++ b/src/bo4e/bo/steuerbareressource.py @@ -36,17 +36,17 @@ class SteuerbareRessource(Geschaeftsobjekt): typ: Annotated[Literal[Typ.STEUERBARERESSOURCE], Field(alias="_typ")] = Typ.STEUERBARERESSOURCE - #: Id der steuerbaren Ressource steuerbare_ressource_id: Optional[str] = None - #: Leistungsbeschreibung des Steuerkanals + """Id der steuerbaren Ressource""" steuerkanal_leistungsbeschreibung: Optional["SteuerkanalLeistungsbeschreibung"] = None - #: Angabe des Messstellenbetreibers, der der Steuerbaren Ressource zugeordnet ist. + """Leistungsbeschreibung des Steuerkanals""" zugeordnete_msb_codenummer: Optional[str] = None - #: Produkt-Daten der Steuerbaren Ressource + """Angabe des Messstellenbetreibers, der der Steuerbaren Ressource zugeordnet ist.""" konfigurationsprodukte: Optional[list["Konfigurationsprodukt"]] = None - #: Eigenschaft des Messstellenbetreibers an der Lokation + """Produkt-Daten der Steuerbaren Ressource""" eigenschaft_msb_lokation: Optional["Marktrolle"] = None - #: Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben + """Eigenschaft des Messstellenbetreibers an der Lokation""" lokationszuordnungen: Optional[list["Lokationszuordnung"]] = None - #: Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt. + """Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben""" lokationsbuendel_objektcode: Optional[str] = None + """Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.""" diff --git a/src/bo4e/bo/tarif.py b/src/bo4e/bo/tarif.py index 4abb523ec..f1c6746c7 100644 --- a/src/bo4e/bo/tarif.py +++ b/src/bo4e/bo/tarif.py @@ -38,20 +38,20 @@ class Tarif(Tarifinfo): """ typ: Annotated[Literal[Typ.TARIF], Field(alias="_typ")] = Typ.TARIF # type: ignore[assignment] - #: Gibt an, wann der Preis zuletzt angepasst wurde preisstand: Optional[pydantic.AwareDatetime] = None - #: Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen + """Gibt an, wann der Preis zuletzt angepasst wurde""" berechnungsparameter: Optional["Tarifberechnungsparameter"] = None - #: Die festgelegten Preise mit regionaler Eingrenzung z.B. für Arbeitspreis, Grundpreis etc. + """Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen""" tarifpreise: Optional[list["TarifpreispositionProOrt"]] = None + """Die festgelegten Preise mit regionaler Eingrenzung z.B. für Arbeitspreis, Grundpreis etc.""" - #: Auf- und Abschläge auf die Preise oder Kosten mit regionaler Eingrenzung tarif_auf_abschlaege: Optional[list["AufAbschlagRegional"]] = None + """Auf- und Abschläge auf die Preise oder Kosten mit regionaler Eingrenzung""" # todo: fix inconsistency: RegionalerAufAbschlag vs. AufAbschlagRegional # https://github.com/Hochfrequenz/BO4E-python/issues/345 - #: Preisgarantie für diesen Tarif preisgarantie: Optional["Preisgarantie"] = None + """Preisgarantie für diesen Tarif""" # todo: fix inconsistency with regionaltarif https://github.com/Hochfrequenz/BO4E-python/issues/346 - #: Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann tarifeinschraenkung: Optional["Tarifeinschraenkung"] = None + """Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann""" diff --git a/src/bo4e/bo/tarifinfo.py b/src/bo4e/bo/tarifinfo.py index ddb22c44c..aa01724e4 100644 --- a/src/bo4e/bo/tarifinfo.py +++ b/src/bo4e/bo/tarifinfo.py @@ -42,34 +42,34 @@ class Tarifinfo(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.TARIFINFO], Field(alias="_typ")] = Typ.TARIFINFO - #: Name des Tarifs bezeichnung: Optional[str] = None - #: Der Name des Marktpartners, der den Tarif anbietet + """Name des Tarifs""" anbietername: Optional[str] = None - #: Strom oder Gas, etc. + """Der Name des Marktpartners, der den Tarif anbietet""" sparte: Optional["Sparte"] = None - #: Kundentypen für den der Tarif gilt, z.B. Privatkunden + """Strom oder Gas, etc.""" kundentypen: Optional[list["Kundentyp"]] = None - #: Die Art des Tarifes, z.B. Eintarif oder Mehrtarif + """Kundentypen für den der Tarif gilt, z.B. Privatkunden""" registeranzahl: Optional["Registeranzahl"] = None - #: Hinweis auf den Tariftyp, z.B. Grundversorgung oder Sondertarif + """Die Art des Tarifes, z.B. Eintarif oder Mehrtarif""" tariftyp: Optional["Tariftyp"] = None - #: Weitere Merkmale des Tarifs, z.B. Festpreis oder Vorkasse + """Hinweis auf den Tariftyp, z.B. Grundversorgung oder Sondertarif""" tarifmerkmale: Optional[list["Tarifmerkmal"]] = None - #: Der Marktteilnehmer (Lieferant), der diesen Tarif anbietet + """Weitere Merkmale des Tarifs, z.B. Festpreis oder Vorkasse""" anbieter: Optional["Marktteilnehmer"] = None + """Der Marktteilnehmer (Lieferant), der diesen Tarif anbietet""" - #: Internetseite auf dem der Tarif zu finden ist website: Optional[str] = None - #: Freitext + """Internetseite auf dem der Tarif zu finden ist""" bemerkung: Optional[str] = None + """Freitext""" - #: Angabe, in welchem Zeitraum der Tarif gültig ist zeitliche_gueltigkeit: Optional["Zeitraum"] = None - #: Der Energiemix, der für diesen Tarif gilt + """Angabe, in welchem Zeitraum der Tarif gültig ist""" energiemix: Optional["Energiemix"] = None - #: Mindestlaufzeiten und Kündigungsfristen zusammengefasst + """Der Energiemix, der für diesen Tarif gilt""" vertragskonditionen: Optional["Vertragskonditionen"] = None + """Mindestlaufzeiten und Kündigungsfristen zusammengefasst""" anwendung_von: Optional[pydantic.AwareDatetime] = None """ Angabe des inklusiven Zeitpunkts, ab dem der Tarif bzw. der Preis angewendet und abgerechnet wird, diff --git a/src/bo4e/bo/tarifpreisblatt.py b/src/bo4e/bo/tarifpreisblatt.py index c1337839b..46198194b 100644 --- a/src/bo4e/bo/tarifpreisblatt.py +++ b/src/bo4e/bo/tarifpreisblatt.py @@ -39,16 +39,16 @@ class Tarifpreisblatt(Tarifinfo): typ: Annotated[Literal[Typ.TARIFPREISBLATT], Field(alias="_typ")] = Typ.TARIFPREISBLATT # type: ignore[assignment] # required attributes (additional to those of Tarifinfo) - #: Gibt an, wann der Preis zuletzt angepasst wurde preisstand: Optional[pydantic.AwareDatetime] = None - #: Die festgelegten Preise, z.B. für Arbeitspreis, Grundpreis etc. + """Gibt an, wann der Preis zuletzt angepasst wurde""" tarifpreise: Optional[list["Tarifpreisposition"]] = None - #: Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen + """Die festgelegten Preise, z.B. für Arbeitspreis, Grundpreis etc.""" berechnungsparameter: Optional["Tarifberechnungsparameter"] = None + """Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen""" - #: Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann tarifeinschraenkung: Optional["Tarifeinschraenkung"] = None - #: Festlegung von Garantien für bestimmte Preisanteile + """Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann""" preisgarantie: Optional["Preisgarantie"] = None - #: Auf- und Abschläge auf die Preise oder Kosten + """Festlegung von Garantien für bestimmte Preisanteile""" tarif_auf_abschlaege: Optional[list["AufAbschlag"]] = None + """Auf- und Abschläge auf die Preise oder Kosten""" diff --git a/src/bo4e/bo/technischeressource.py b/src/bo4e/bo/technischeressource.py index 1d304967a..59618b983 100644 --- a/src/bo4e/bo/technischeressource.py +++ b/src/bo4e/bo/technischeressource.py @@ -40,33 +40,33 @@ class TechnischeRessource(Geschaeftsobjekt): typ: Annotated[Literal[Typ.TECHNISCHERESSOURCE], Field(alias="_typ")] = Typ.TECHNISCHERESSOURCE - #: Identifikationsnummer einer technischen Ressource technische_ressource_id: Optional[str] = None - #: Vorgelagerte Messlokation ID + """Identifikationsnummer einer technischen Ressource""" vorgelagerte_messlokation_id: Optional[str] = None - #: Referenz auf die der technischen Ressource zugeordneten Marktlokation + """Vorgelagerte Messlokation ID""" zugeordnete_marktlokation_id: Optional[str] = None - #: Referenz auf die der technischen Ressource zugeordneten Steuerbaren Ressource + """Referenz auf die der technischen Ressource zugeordneten Marktlokation""" zugeordnete_steuerbare_ressource_id: Optional[str] = None - #: Nennleistung (Aufnahme) + """Referenz auf die der technischen Ressource zugeordneten Steuerbaren Ressource""" nennleistungaufnahme: Optional["Menge"] = None - #: Nennleistung (Abgabe) + """Nennleistung (Aufnahme)""" nennleistungabgabe: Optional["Menge"] = None - #: Speicherkapazität + """Nennleistung (Abgabe)""" speicherkapazitaet: Optional["Menge"] = None - #: Art und Nutzung der technischen Ressource + """Speicherkapazität""" technische_ressource_nutzung: Optional["TechnischeRessourceNutzung"] = None - #: Verbrauchsart der technischen Ressource + """Art und Nutzung der technischen Ressource""" technische_ressource_verbrauchsart: Optional["TechnischeRessourceVerbrauchsart"] = None - #: Wärmenutzung + """Verbrauchsart der technischen Ressource""" waermenutzung: Optional["Waermenutzung"] = None - #: Art der E-Mobilität + """Wärmenutzung""" emobilitaetsart: Optional["EMobilitaetsart"] = None - #: Art der Erzeugung der Energie + """Art der E-Mobilität""" erzeugungsart: Optional["Erzeugungsart"] = None - #: Art des Speichers + """Art der Erzeugung der Energie""" speicherart: Optional["Speicherart"] = None - #: Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben + """Art des Speichers""" lokationszuordnungen: Optional[list["Lokationszuordnung"]] = None - #: Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt. + """Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben""" lokationsbuendel_objektcode: Optional[str] = None + """Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.""" diff --git a/src/bo4e/bo/vertrag.py b/src/bo4e/bo/vertrag.py index 3407c72fd..a48dde0af 100644 --- a/src/bo4e/bo/vertrag.py +++ b/src/bo4e/bo/vertrag.py @@ -44,18 +44,18 @@ class Vertrag(Geschaeftsobjekt): typ: Annotated[Literal[Typ.VERTRAG], Field(alias="_typ")] = Typ.VERTRAG # pylint: disable=duplicate-code - #: Eine im Verwendungskontext eindeutige Nummer für den Vertrag vertragsnummer: Optional[str] = None - #: Hier ist festgelegt, um welche Art von Vertrag es sich handelt. + """Eine im Verwendungskontext eindeutige Nummer für den Vertrag""" vertragsart: Optional["Vertragsart"] = None - #: Gibt den Status des Vertrags an + """Hier ist festgelegt, um welche Art von Vertrag es sich handelt.""" vertragsstatus: Optional["Vertragsstatus"] = None - #: Unterscheidungsmöglichkeiten für die Sparte + """Gibt den Status des Vertrags an""" sparte: Optional["Sparte"] = None - #: Gibt an, wann der Vertrag beginnt (inklusiv) + """Unterscheidungsmöglichkeiten für die Sparte""" vertragsbeginn: Optional[pydantic.AwareDatetime] = None - #: Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv) + """Gibt an, wann der Vertrag beginnt (inklusiv)""" vertragsende: Optional[pydantic.AwareDatetime] = None + """Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv)""" # todo: add von/bis validator vertragspartner1: Optional["Geschaeftspartner"] = None """ @@ -75,11 +75,11 @@ class Vertrag(Geschaeftsobjekt): (Markt- oder Messlokation) festzulegen. """ - #: Beschreibung zum Vertrag beschreibung: Optional[str] = None - #: Festlegungen zu Laufzeiten und Kündigungsfristen + """Beschreibung zum Vertrag""" vertragskonditionen: Optional["Vertragskonditionen"] = None - #: Unterzeichner des Vertragspartners 1 + """Festlegungen zu Laufzeiten und Kündigungsfristen""" unterzeichnervp1: Optional[list["Unterschrift"]] = None - #: Unterzeichner des Vertragspartners 2 + """Unterzeichner des Vertragspartners 1""" unterzeichnervp2: Optional[list["Unterschrift"]] = None + """Unterzeichner des Vertragspartners 2""" diff --git a/src/bo4e/bo/zaehler.py b/src/bo4e/bo/zaehler.py index ef82244e4..188c8e294 100644 --- a/src/bo4e/bo/zaehler.py +++ b/src/bo4e/bo/zaehler.py @@ -47,23 +47,34 @@ class Zaehler(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.ZAEHLER], Field(alias="_typ")] = Typ.ZAEHLER - zaehlernummer: Optional[str] = None #: Nummerierung des Zählers,vergeben durch den Messstellenbetreiber - sparte: Optional["Sparte"] = None #: Strom oder Gas - zaehlerauspraegung: Optional["Zaehlerauspraegung"] = None #: Spezifikation die Richtung des Zählers betreffend - zaehlertyp: Optional["Zaehlertyp"] = None #: Typisierung des Zählers + zaehlernummer: Optional[str] = None + """Nummerierung des Zählers,vergeben durch den Messstellenbetreiber""" + sparte: Optional["Sparte"] = None + """Strom oder Gas""" + zaehlerauspraegung: Optional["Zaehlerauspraegung"] = None + """Spezifikation die Richtung des Zählers betreffend""" + zaehlertyp: Optional["Zaehlertyp"] = None + """Typisierung des Zählers""" zaehlwerke: Optional[list["Zaehlwerk"]] = None - registeranzahl: Optional["Registeranzahl"] = None #: Spezifikation bezüglich unterstützter Tarif - zaehlerkonstante: Optional[Decimal] = None #: Zählerkonstante auf dem Zähler - eichung_bis: Optional[pydantic.AwareDatetime] = None #: Bis zu diesem Datum (exklusiv) ist der Zähler geeicht. - letzte_eichung: Optional[pydantic.AwareDatetime] = ( - None #: Zu diesem Datum fand die letzte Eichprüfung des Zählers statt. - ) - zaehlerhersteller: Optional["Geschaeftspartner"] = None #: Der Hersteller des Zählers - ist_fernschaltbar: Optional[bool] = None #: Fernschaltung - messwerterfassung: Optional["Messwerterfassung"] = None #: Messwerterfassung des Zählers - zaehlertypSpezifikation: Optional["ZaehlertypSpezifikation"] = None #: Besondere Spezifikation des Zählers - befestigungsart: Optional["Befestigungsart"] = None #: Befestigungsart - zaehlergroesse: Optional["Zaehlergroesse"] = None #: Größe des Zählers - geraete: Optional[list["Geraet"]] = ( - None #: Liste der Geräte, die zu diesem Zähler gehören, bspw. Smartmeter-Gateway - ) + registeranzahl: Optional["Registeranzahl"] = None + """Spezifikation bezüglich unterstützter Tarif""" + zaehlerkonstante: Optional[Decimal] = None + """Zählerkonstante auf dem Zähler""" + eichung_bis: Optional[pydantic.AwareDatetime] = None + """Bis zu diesem Datum (exklusiv) ist der Zähler geeicht.""" + letzte_eichung: Optional[pydantic.AwareDatetime] = None + """Zu diesem Datum fand die letzte Eichprüfung des Zählers statt.""" + zaehlerhersteller: Optional["Geschaeftspartner"] = None + """Der Hersteller des Zählers""" + ist_fernschaltbar: Optional[bool] = None + """Fernschaltung""" + messwerterfassung: Optional["Messwerterfassung"] = None + """Messwerterfassung des Zählers""" + zaehlertypSpezifikation: Optional["ZaehlertypSpezifikation"] = None + """Besondere Spezifikation des Zählers""" + befestigungsart: Optional["Befestigungsart"] = None + """Befestigungsart""" + zaehlergroesse: Optional["Zaehlergroesse"] = None + """Größe des Zählers""" + geraete: Optional[list["Geraet"]] = None + """Liste der Geräte, die zu diesem Zähler gehören, bspw. Smartmeter-Gateway""" diff --git a/src/bo4e/bo/zeitreihe.py b/src/bo4e/bo/zeitreihe.py index 4b224e459..4793bb5f1 100644 --- a/src/bo4e/bo/zeitreihe.py +++ b/src/bo4e/bo/zeitreihe.py @@ -37,22 +37,22 @@ class Zeitreihe(Geschaeftsobjekt): """ typ: Annotated[Literal[Typ.ZEITREIHE], Field(alias="_typ")] = Typ.ZEITREIHE - #: Bezeichnung für die Zeitreihe bezeichnung: Optional[str] = None - #: Beschreibt, was gemessen wurde (z.B. Strom, Spannung, Wirkleistung, Scheinleistung) + """Bezeichnung für die Zeitreihe""" messgroesse: Optional["Messgroesse"] = None - #: Beschreibt die Art der Messung (z.B. aktueller Wert, mittlerer Wert, maximaler Wert) + """Beschreibt, was gemessen wurde (z.B. Strom, Spannung, Wirkleistung, Scheinleistung)""" messart: Optional["Messart"] = None - #: Medium, das gemessen wurde (z.B. Wasser, Dampf, Strom, Gas) + """Beschreibt die Art der Messung (z.B. aktueller Wert, mittlerer Wert, maximaler Wert)""" medium: Optional["Medium"] = None - #: Alle Werte in der Tabelle haben die Einheit, die hier angegeben ist + """Medium, das gemessen wurde (z.B. Wasser, Dampf, Strom, Gas)""" einheit: Optional["Mengeneinheit"] = None - #: Hier liegen jeweils die Werte + """Alle Werte in der Tabelle haben die Einheit, die hier angegeben ist""" werte: Optional[list["Zeitreihenwert"]] = None + """Hier liegen jeweils die Werte""" - #: Beschreibt die Verwendung der Zeitreihe beschreibung: Optional[str] = None - #: Version der Zeitreihe + """Beschreibt die Verwendung der Zeitreihe""" version: Optional[str] = None - #: Kennzeichnung, wie die Werte entstanden sind, z.B. durch Messung + """Version der Zeitreihe""" wertherkunft: Optional["Wertermittlungsverfahren"] = None + """Kennzeichnung, wie die Werte entstanden sind, z.B. durch Messung""" diff --git a/src/bo4e/com/adresse.py b/src/bo4e/com/adresse.py index e750115e9..43b5d09a3 100644 --- a/src/bo4e/com/adresse.py +++ b/src/bo4e/com/adresse.py @@ -26,22 +26,36 @@ class Adresse(COM): """ - #: Die Postleitzahl; z.B: "41836" postleitzahl: Optional[str] = None - #: Bezeichnung der Stadt; z.B. "Hückelhoven" + """ + Die Postleitzahl; z.B: "41836" + """ ort: Optional[str] = None + """ + Bezeichnung der Stadt; z.B. "Hückelhoven" + """ - #: Bezeichnung des Ortsteils; z.B. "Mitte" ortsteil: Optional[str] = None - #: Bezeichnung der Straße; z.B. "Weserstraße" + """ + Bezeichnung des Ortsteils; z.B. "Mitte" + """ strasse: Optional[str] = None - #: Hausnummer inkl. Zusatz; z.B. "3", "4a" + """ + Bezeichnung der Straße; z.B. "Weserstraße" + """ hausnummer: Optional[str] = None - #: Im Falle einer Postfachadresse das Postfach; Damit werden Straße und Hausnummer nicht berücksichtigt + """ + Hausnummer inkl. Zusatz; z.B. "3", "4a" + """ postfach: Optional[str] = None - #: Zusatzhinweis zum Auffinden der Adresse, z.B. "3. Stock linke Wohnung" + """Im Falle einer Postfachadresse das Postfach; Damit werden Straße und Hausnummer nicht berücksichtigt""" adresszusatz: Optional[str] = None - #: Im Falle einer c/o-Adresse steht in diesem Attribut die Anrede. Z.B. "c/o Veronica Hauptmieterin" + """ + Zusatzhinweis zum Auffinden der Adresse, z.B. "3. Stock linke Wohnung" + """ co_ergaenzung: Optional[str] = None - #: Offizieller ISO-Landescode + """ + Im Falle einer c/o-Adresse steht in diesem Attribut die Anrede. Z.B. "c/o Veronica Hauptmieterin" + """ landescode: Optional["Landescode"] = Landescode.DE # type:ignore + """Offizieller ISO-Landescode""" diff --git a/src/bo4e/com/angebotsposition.py b/src/bo4e/com/angebotsposition.py index 5e34bc8e6..67fcf5a1b 100644 --- a/src/bo4e/com/angebotsposition.py +++ b/src/bo4e/com/angebotsposition.py @@ -35,15 +35,15 @@ class Angebotsposition(COM): """ - #: Bezeichnung der jeweiligen Position des Angebotsteils positionsbezeichnung: Optional[str] = None - #: Preis pro Einheit/Stückpreis des angebotenen Artikels. + """Bezeichnung der jeweiligen Position des Angebotsteils""" positionspreis: Optional["Preis"] = None + """Preis pro Einheit/Stückpreis des angebotenen Artikels.""" - #: Menge des angebotenen Artikels (z.B. Wirkarbeit in kWh), in dieser Angebotsposition positionsmenge: Optional["Menge"] = None - #: Kosten (positionspreis * positionsmenge) für diese Angebotsposition + """Menge des angebotenen Artikels (z.B. Wirkarbeit in kWh), in dieser Angebotsposition""" positionskosten: Optional["Betrag"] = None + """Kosten (positionspreis * positionsmenge) für diese Angebotsposition""" # for a preis = menge*times validation we first need to resolve # https://github.com/Hochfrequenz/BO4E-python/issues/126 diff --git a/src/bo4e/com/angebotsteil.py b/src/bo4e/com/angebotsteil.py index ee7658e5d..2a0649506 100644 --- a/src/bo4e/com/angebotsteil.py +++ b/src/bo4e/com/angebotsteil.py @@ -37,19 +37,19 @@ class Angebotsteil(COM): """ - #: Einzelne Positionen, die zu diesem Angebotsteil gehören positionen: Optional[list["Angebotsposition"]] = None + """Einzelne Positionen, die zu diesem Angebotsteil gehören""" - #: Identifizierung eines Subkapitels einer Anfrage, beispielsweise das Los einer Ausschreibung anfrage_subreferenz: Optional[str] = None + """Identifizierung eines Subkapitels einer Anfrage, beispielsweise das Los einer Ausschreibung""" lieferstellenangebotsteil: Optional[list["Marktlokation"]] = None """ Marktlokationen, für die dieses Angebotsteil gilt, falls vorhanden. Durch die Marktlokation ist auch die Lieferadresse festgelegt """ - #: Summe der Verbräuche aller in diesem Angebotsteil eingeschlossenen Lieferstellen gesamtmengeangebotsteil: Optional["Menge"] = None - #: Summe der Jahresenergiekosten aller in diesem Angebotsteil enthaltenen Lieferstellen + """Summe der Verbräuche aller in diesem Angebotsteil eingeschlossenen Lieferstellen""" gesamtkostenangebotsteil: Optional["Betrag"] = None - #: Hier kann der Belieferungszeitraum angegeben werden, für den dieser Angebotsteil gilt + """Summe der Jahresenergiekosten aller in diesem Angebotsteil enthaltenen Lieferstellen""" lieferzeitraum: Optional["Zeitraum"] = None + """Hier kann der Belieferungszeitraum angegeben werden, für den dieser Angebotsteil gilt""" diff --git a/src/bo4e/com/angebotsvariante.py b/src/bo4e/com/angebotsvariante.py index 486531500..90505df34 100644 --- a/src/bo4e/com/angebotsvariante.py +++ b/src/bo4e/com/angebotsvariante.py @@ -32,14 +32,14 @@ class Angebotsvariante(COM): """ - #: Gibt den Status eines Angebotes an. angebotsstatus: Optional["Angebotsstatus"] = None + """Gibt den Status eines Angebotes an.""" - #: Datum der Erstellung der Angebotsvariante erstellungsdatum: Optional[pydantic.AwareDatetime] = None + """Datum der Erstellung der Angebotsvariante""" - #: Bis zu diesem Zeitpunkt gilt die Angebotsvariante bindefrist: Optional[pydantic.AwareDatetime] = None + """Bis zu diesem Zeitpunkt gilt die Angebotsvariante""" teile: Optional[list["Angebotsteil"]] = None """ @@ -48,8 +48,8 @@ class Angebotsvariante(COM): Eine Variante besteht mindestens aus einem Angebotsteil. """ - #: Aufsummierte Wirkarbeitsmenge aller Angebotsteile gesamtmenge: Optional["Menge"] = None + """Aufsummierte Wirkarbeitsmenge aller Angebotsteile""" # todo: write a validator for this: https://github.com/Hochfrequenz/BO4E-python/issues/320 - #: Aufsummierte Kosten aller Angebotsteile gesamtkosten: Optional["Betrag"] = None + """Aufsummierte Kosten aller Angebotsteile""" diff --git a/src/bo4e/com/aufabschlag.py b/src/bo4e/com/aufabschlag.py index c5006a6d5..2187164f0 100644 --- a/src/bo4e/com/aufabschlag.py +++ b/src/bo4e/com/aufabschlag.py @@ -33,21 +33,21 @@ class AufAbschlag(COM): """ - #: Bezeichnung des Auf-/Abschlags bezeichnung: Optional[str] = None - #: Werte für die gestaffelten Auf/Abschläge. + """Bezeichnung des Auf-/Abschlags""" staffeln: Optional[list["Preisstaffel"]] = None + """Werte für die gestaffelten Auf/Abschläge.""" - #: Beschreibung zum Auf-/Abschlag beschreibung: Optional[str] = None - #: Typ des Aufabschlages (z.B. absolut oder prozentual). + """Beschreibung zum Auf-/Abschlag""" auf_abschlagstyp: Optional["AufAbschlagstyp"] = None - #: Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc.. + """Typ des Aufabschlages (z.B. absolut oder prozentual).""" auf_abschlagsziel: Optional["AufAbschlagsziel"] = None + """Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc..""" einheit: Optional["Waehrungseinheit"] = None """ Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird. Euro oder Ct.. (Nur im Falle absoluter Aufschlagstypen). """ - #: Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind. website: Optional[str] = None - #: Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind. + """Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind.""" gueltigkeitszeitraum: Optional["Zeitraum"] = None + """Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind.""" diff --git a/src/bo4e/com/aufabschlagproort.py b/src/bo4e/com/aufabschlagproort.py index be6a59ab0..632140286 100644 --- a/src/bo4e/com/aufabschlagproort.py +++ b/src/bo4e/com/aufabschlagproort.py @@ -32,11 +32,11 @@ class AufAbschlagProOrt(COM): """ - #: Die Postleitzahl des Ortes für den der Aufschlag gilt. postleitzahl: Optional[str] = None - #: Der Ort für den der Aufschlag gilt. + """Die Postleitzahl des Ortes für den der Aufschlag gilt.""" ort: Optional[str] = None - #: Die ene't-Netznummer des Netzes in dem der Aufschlag gilt. + """Der Ort für den der Aufschlag gilt.""" netznr: Optional[str] = None - #: Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung. + """Die ene't-Netznummer des Netzes in dem der Aufschlag gilt.""" staffeln: Optional[list["AufAbschlagstaffelProOrt"]] = None + """Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung.""" diff --git a/src/bo4e/com/aufabschlagregional.py b/src/bo4e/com/aufabschlagregional.py index 0a97ad4fc..3511acaf1 100644 --- a/src/bo4e/com/aufabschlagregional.py +++ b/src/bo4e/com/aufabschlagregional.py @@ -42,29 +42,29 @@ class AufAbschlagRegional(COM): """ # required attributess - #: Bezeichnung des Auf-/Abschlags bezeichnung: Optional[str] = None - #: Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung + """Bezeichnung des Auf-/Abschlags""" betraege: Optional[list["AufAbschlagProOrt"]] = None + """Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung""" - #: Beschreibung zum Auf-/Abschlag beschreibung: Optional[str] = None + """Beschreibung zum Auf-/Abschlag""" #:Typ des Aufabschlages (z.B. absolut oder prozentual) auf_abschlagstyp: Optional["AufAbschlagstyp"] = None - #: Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc. auf_abschlagsziel: Optional["AufAbschlagsziel"] = None - #: Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird. Euro oder Ct. + """Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc.""" einheit: Optional["Waehrungseinheit"] = None - #: Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind + """Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird. Euro oder Ct.""" website: Optional[str] = None - #: Zusatzprodukte, die nur in Kombination mit diesem AufAbschlag erhältlich sind + """Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind""" zusatzprodukte: Optional[list[str]] = None - #: Voraussetzungen, die erfüllt sein müssen, damit dieser AufAbschlag zur Anwendung kommen kann + """Zusatzprodukte, die nur in Kombination mit diesem AufAbschlag erhältlich sind""" voraussetzungen: Optional[list[str]] = None - #: Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten. + """Voraussetzungen, die erfüllt sein müssen, damit dieser AufAbschlag zur Anwendung kommen kann""" tarifnamensaenderungen: Optional[str] = None - #: Zeitraum, in dem der Abschlag zur Anwendung kommen kann + """Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten.""" gueltigkeitszeitraum: Optional["Zeitraum"] = None + """Zeitraum, in dem der Abschlag zur Anwendung kommen kann""" energiemixaenderung: Optional["Energiemix"] = None """ Der Energiemix kann sich durch einen AufAbschlag ändern (z.B. zwei Cent Aufschlag für Ökostrom: Sollte dies der Fall sein, wird hier die neue Zusammensetzung des Energiemix angegeben.""" diff --git a/src/bo4e/com/aufabschlagstaffelproort.py b/src/bo4e/com/aufabschlagstaffelproort.py index 412d07d39..dedb7854d 100644 --- a/src/bo4e/com/aufabschlagstaffelproort.py +++ b/src/bo4e/com/aufabschlagstaffelproort.py @@ -26,9 +26,9 @@ class AufAbschlagstaffelProOrt(COM): """ - #: Der Wert für den Auf- oder Abschlag. wert: Optional[Decimal] = None - #: Unterer Wert, ab dem die Staffel gilt. + """Der Wert für den Auf- oder Abschlag.""" staffelgrenze_von: Optional[Decimal] = None - #: Oberer Wert, bis zu dem die Staffel gilt. + """Unterer Wert, ab dem die Staffel gilt.""" staffelgrenze_bis: Optional[Decimal] = None + """Oberer Wert, bis zu dem die Staffel gilt.""" diff --git a/src/bo4e/com/ausschreibungsdetail.py b/src/bo4e/com/ausschreibungsdetail.py index c7b3481b3..3f158c41e 100644 --- a/src/bo4e/com/ausschreibungsdetail.py +++ b/src/bo4e/com/ausschreibungsdetail.py @@ -31,39 +31,39 @@ class Ausschreibungsdetail(COM): """ - #: Identifikation einer ausgeschriebenen Marktlokation marktlokations_id: Optional[str] = None - #: In der angegebenen Netzebene wird die Marktlokation versorgt, z.B. MSP für Mittelspannung + """Identifikation einer ausgeschriebenen Marktlokation""" netzebene_lieferung: Optional[str] = None - #: In der angegebenen Netzebene wird die Lokation gemessen, z.B. NSP für Niederspannung + """In der angegebenen Netzebene wird die Marktlokation versorgt, z.B. MSP für Mittelspannung""" netzebene_messung: Optional[str] = None - #: Die Adresse an der die Marktlokation sich befindet + """In der angegebenen Netzebene wird die Lokation gemessen, z.B. NSP für Niederspannung""" marktlokationsadresse: Optional["Adresse"] = None - #: Angefragter Zeitraum für die ausgeschriebene Belieferung + """Die Adresse an der die Marktlokation sich befindet""" lieferzeitraum: Optional["Zeitraum"] = None + """Angefragter Zeitraum für die ausgeschriebene Belieferung""" - #: Bezeichnung des zuständigen Netzbetreibers, z.B. 'Stromnetz Hamburg GmbH' netzbetreiber: Optional[str] = None - #: Bezeichnung des Kunden, der die Marktlokation nutzt + """Bezeichnung des zuständigen Netzbetreibers, z.B. 'Stromnetz Hamburg GmbH'""" kunde: Optional[str] = None - #: Die Bezeichnung des Zählers an der Marktlokation + """Bezeichnung des Kunden, der die Marktlokation nutzt""" zaehlernummer: Optional[str] = None - #: Bezeichnung für die Lokation, z.B. 'Zentraler Einkauf, Hamburg' + """Die Bezeichnung des Zählers an der Marktlokation""" marktlokationsbezeichnung: Optional[str] = None + """Bezeichnung für die Lokation, z.B. 'Zentraler Einkauf, Hamburg'""" - #: Spezifikation, um welche Zählertechnik es sich im vorliegenden Fall handelt, z.B. Leistungsmessung zaehlertechnik: Optional["Zaehlertyp"] = None + """Spezifikation, um welche Zählertechnik es sich im vorliegenden Fall handelt, z.B. Leistungsmessung""" ist_lastgang_vorhanden: Optional[bool] = None """ Zeigt an, ob es zu der Marktlokation einen Lastgang gibt. Falls ja, kann dieser abgerufen werden und daraus die Verbrauchswerte ermittelt werden """ - #: Prognosewert für die Jahresarbeit der ausgeschriebenen Lokation prognose_jahresarbeit: Optional["Menge"] = None - #: Ein Prognosewert für die Arbeit innerhalb des angefragten Lieferzeitraums der ausgeschriebenen Lokation + """Prognosewert für die Jahresarbeit der ausgeschriebenen Lokation""" prognose_arbeit_lieferzeitraum: Optional["Menge"] = None - #: Prognosewert für die abgenommene maximale Leistung der ausgeschriebenen Lokation + """Ein Prognosewert für die Arbeit innerhalb des angefragten Lieferzeitraums der ausgeschriebenen Lokation""" prognose_leistung: Optional["Menge"] = None - #: Die (evtl. abweichende) Rechnungsadresse + """Prognosewert für die abgenommene maximale Leistung der ausgeschriebenen Lokation""" rechnungsadresse: Optional["Adresse"] = None + """Die (evtl. abweichende) Rechnungsadresse""" diff --git a/src/bo4e/com/ausschreibungslos.py b/src/bo4e/com/ausschreibungslos.py index e42906f08..8e700ca4b 100644 --- a/src/bo4e/com/ausschreibungslos.py +++ b/src/bo4e/com/ausschreibungslos.py @@ -33,38 +33,38 @@ class Ausschreibungslos(COM): """ - #: Laufende Nummer des Loses losnummer: Optional[str] = None - #: Bezeichnung der Ausschreibung + """Laufende Nummer des Loses""" bezeichnung: Optional[str] = None - #: Bezeichnung der Preismodelle in Ausschreibungen für die Energielieferung + """Bezeichnung der Ausschreibung""" preismodell: Optional["Preismodell"] = None + """Bezeichnung der Preismodelle in Ausschreibungen für die Energielieferung""" - #: Unterscheidungsmöglichkeiten für die Sparte energieart: Optional["Sparte"] = None - #: Aufzählung der Möglichkeiten zur Rechnungslegung in Ausschreibungen + """Unterscheidungsmöglichkeiten für die Sparte""" wunsch_rechnungslegung: Optional["Rechnungslegung"] = None - #: Aufzählung der Möglichkeiten zu Vertragsformen in Ausschreibungen + """Aufzählung der Möglichkeiten zur Rechnungslegung in Ausschreibungen""" wunsch_vertragsform: Optional["Vertragsform"] = None - #: Name des Lizenzpartners + """Aufzählung der Möglichkeiten zu Vertragsformen in Ausschreibungen""" betreut_durch: Optional[str] = None - #: Anzahl der Lieferstellen in dieser Ausschreibung + """Name des Lizenzpartners""" anzahl_lieferstellen: Optional[int] = None + """Anzahl der Lieferstellen in dieser Ausschreibung""" - #: Die ausgeschriebenen Lieferstellen lieferstellen: Optional[list["Ausschreibungsdetail"]] = None + """Die ausgeschriebenen Lieferstellen""" - #: Zeitraum, für den die in diesem Los enthaltenen Lieferstellen beliefert werden sollen lieferzeitraum: Optional["Zeitraum"] = None + """Zeitraum, für den die in diesem Los enthaltenen Lieferstellen beliefert werden sollen""" - #: Bemerkung des Kunden zum Los bemerkung: Optional[str] = None - #: Gibt den Gesamtjahresverbrauch (z.B. in kWh) aller in diesem Los enthaltenen Lieferstellen an + """Bemerkung des Kunden zum Los""" gesamt_menge: Optional["Menge"] = None - #: Mindesmenge Toleranzband (kWh, %) + """Gibt den Gesamtjahresverbrauch (z.B. in kWh) aller in diesem Los enthaltenen Lieferstellen an""" wunsch_mindestmenge: Optional["Menge"] = None - #: Maximalmenge Toleranzband (kWh, %) + """Mindesmenge Toleranzband (kWh, %)""" wunsch_maximalmenge: Optional["Menge"] = None + """Maximalmenge Toleranzband (kWh, %)""" wiederholungsintervall: Optional["Zeitraum"] = None """ @@ -72,7 +72,7 @@ class Ausschreibungslos(COM): Angabe nur gesetzt für die 2. Phase bei öffentlich-rechtlichen Ausschreibungen """ - #: Kundenwunsch zur Kündigungsfrist in der Ausschreibung wunsch_kuendingungsfrist: Optional["Zeitraum"] = None - #: Kundenwunsch zum Zahlungsziel in der Ausschreibung + """Kundenwunsch zur Kündigungsfrist in der Ausschreibung""" wunsch_zahlungsziel: Optional["Zeitraum"] = None + """Kundenwunsch zum Zahlungsziel in der Ausschreibung""" diff --git a/src/bo4e/com/betrag.py b/src/bo4e/com/betrag.py index cc6241a87..6bd2eb4ab 100644 --- a/src/bo4e/com/betrag.py +++ b/src/bo4e/com/betrag.py @@ -31,5 +31,7 @@ class Betrag(COM): """ - wert: Optional[Decimal] = None #: Gibt den Betrag des Preises an. - waehrung: Optional["Waehrungscode"] = None #: Die entsprechende Waehrung + wert: Optional[Decimal] = None + """Gibt den Betrag des Preises an.""" + waehrung: Optional["Waehrungscode"] = None + """Die entsprechende Waehrung""" diff --git a/src/bo4e/com/com.py b/src/bo4e/com/com.py index b18f97833..030285616 100644 --- a/src/bo4e/com/com.py +++ b/src/bo4e/com/com.py @@ -32,9 +32,10 @@ class COM(BaseModel): """ - version: Annotated[Optional[str], Field(alias="_version")] = ( - __version__ #: Version der BO-Struktur aka "fachliche Versionierung" - ) + version: Annotated[Optional[str], Field(alias="_version")] = __version__ + """ + Version der COM-Struktur aka "fachliche Versionierung" + """ # Python internal: The field is not named '_id' because leading underscores are not allowed in pydantic field names. # NameError: Fields must not use names with leading underscores; e.g., use 'id' instead of '_id'. @@ -47,6 +48,7 @@ class COM(BaseModel): zusatz_attribute: Optional[list["ZusatzAttribut"]] = None # pylint: disable=duplicate-code + # basic configuration for pydantic's behaviour model_config = ConfigDict( alias_generator=camelize, populate_by_name=True, @@ -57,13 +59,10 @@ class COM(BaseModel): json_encoders={Decimal: str}, use_attribute_docstrings=True, ) - """ - basic configuration for pydantic's behaviour - """ # pylint: disable=invalid-name -#: Any type derived from COM including those that do not directly inherit from COM +# Any type derived from COM including those that do not directly inherit from COM TCom = TypeVar("TCom", bound=Type[COM]) diff --git a/src/bo4e/com/dienstleistung.py b/src/bo4e/com/dienstleistung.py index 3896e341f..a91286744 100644 --- a/src/bo4e/com/dienstleistung.py +++ b/src/bo4e/com/dienstleistung.py @@ -29,7 +29,7 @@ class Dienstleistung(COM): """ - #: Kennzeichnung der Dienstleistung dienstleistungstyp: Optional["Dienstleistungstyp"] = None - #: Bezeichnung der Dienstleistung + """Kennzeichnung der Dienstleistung""" bezeichnung: Optional[str] = None + """Bezeichnung der Dienstleistung""" diff --git a/src/bo4e/com/energieherkunft.py b/src/bo4e/com/energieherkunft.py index a0f04197d..7e14a642e 100644 --- a/src/bo4e/com/energieherkunft.py +++ b/src/bo4e/com/energieherkunft.py @@ -33,7 +33,7 @@ class Energieherkunft(COM): """ - #: Art der Erzeugung der Energie. erzeugungsart: Optional["Erzeugungsart"] = None - #: Prozentualer Anteil der jeweiligen Erzeugungsart. + """Art der Erzeugung der Energie.""" anteil_prozent: Optional[Decimal] = None + """Prozentualer Anteil der jeweiligen Erzeugungsart.""" diff --git a/src/bo4e/com/energiemix.py b/src/bo4e/com/energiemix.py index 2695e6523..f6ebaf8a7 100644 --- a/src/bo4e/com/energiemix.py +++ b/src/bo4e/com/energiemix.py @@ -33,28 +33,28 @@ class Energiemix(COM): """ - #: Eindeutige Nummer zur Identifizierung des Energiemixes energiemixnummer: Optional[int] = None - #: Strom oder Gas etc. + """Eindeutige Nummer zur Identifizierung des Energiemixes""" energieart: Optional["Sparte"] = None - #: Bezeichnung des Energiemix + """Strom oder Gas etc.""" bezeichnung: Optional[str] = None - #: Jahr, für das der Energiemix gilt + """Bezeichnung des Energiemix""" gueltigkeitsjahr: Optional[int] = None - #: Anteile der jeweiligen Erzeugungsart + """Jahr, für das der Energiemix gilt""" anteil: Optional[list["Energieherkunft"]] = None + """Anteile der jeweiligen Erzeugungsart""" - #: Bemerkung zum Energiemix bemerkung: Optional[str] = None - #: Höhe des erzeugten CO2-Ausstosses in g/kWh + """Bemerkung zum Energiemix""" co2_emission: Optional[Decimal] = None - #: Höhe des erzeugten Atommülls in g/kWh + """Höhe des erzeugten CO2-Ausstosses in g/kWh""" atommuell: Optional[Decimal] = None - #: Zertifikate für den Energiemix + """Höhe des erzeugten Atommülls in g/kWh""" oekozertifikate: Optional[list["Oekozertifikat"]] = None - #: Ökolabel für den Energiemix + """Zertifikate für den Energiemix""" oekolabel: Optional[list["Oekolabel"]] = None - #: Kennzeichen, ob der Versorger zu den Öko Top Ten gehört + """Ökolabel für den Energiemix""" ist_in_oeko_top_ten: Optional[bool] = None - #: Internetseite, auf der die Strommixdaten veröffentlicht sind + """Kennzeichen, ob der Versorger zu den Öko Top Ten gehört""" website: Optional[str] = None + """Internetseite, auf der die Strommixdaten veröffentlicht sind""" diff --git a/src/bo4e/com/fremdkostenblock.py b/src/bo4e/com/fremdkostenblock.py index 19384d121..293ea751f 100644 --- a/src/bo4e/com/fremdkostenblock.py +++ b/src/bo4e/com/fremdkostenblock.py @@ -30,8 +30,8 @@ class Fremdkostenblock(COM): """ - #: Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc. kostenblockbezeichnung: Optional[str] = None + """Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc.""" kostenpositionen: Optional[list["Fremdkostenposition"]] = None """ @@ -40,6 +40,6 @@ class Fremdkostenblock(COM): 5,8200 ct/kWh, 213,01 € """ - #: Die Summe aller Kostenpositionen dieses Blocks summe_kostenblock: Optional["Betrag"] = None + """Die Summe aller Kostenpositionen dieses Blocks""" # todo: write validator fo this sum, see https://github.com/Hochfrequenz/BO4E-python/issues/324 diff --git a/src/bo4e/com/fremdkostenposition.py b/src/bo4e/com/fremdkostenposition.py index 6af7ff073..00831b80f 100644 --- a/src/bo4e/com/fremdkostenposition.py +++ b/src/bo4e/com/fremdkostenposition.py @@ -25,15 +25,15 @@ class Fremdkostenposition(Kostenposition): """ # optional attributes (additional to those from Kostenposition) - #: Der Name des Marktpartners, der die Preise festlegt, bzw. die Kosten in Rechnung stellt marktpartnername: Optional[str] = None + """Der Name des Marktpartners, der die Preise festlegt, bzw. die Kosten in Rechnung stellt""" - #: Die Codenummer (z.B. BDEW-Codenummer) des Marktpartners, der die Preise festlegt / die Kosten in Rechnung stellt marktpartnercode: Optional[str] = None + """Die Codenummer (z.B. BDEW-Codenummer) des Marktpartners, der die Preise festlegt / die Kosten in Rechnung stellt""" - #: EIC-Code des Regel- oder Marktgebietes eingetragen. Z.B. '10YDE-EON------1' für die Regelzone TenneT gebietcode_eic: Optional[str] = None + """EIC-Code des Regel- oder Marktgebietes eingetragen. Z.B. '10YDE-EON------1' für die Regelzone TenneT""" # todo: see issue https://github.com/Hochfrequenz/BO4E-python/issues/147 for EIC validation - #: Link zum veröffentlichten Preisblatt link_preisblatt: Optional[str] = None + """Link zum veröffentlichten Preisblatt""" diff --git a/src/bo4e/com/kontaktweg.py b/src/bo4e/com/kontaktweg.py index c72678db1..12b6d444d 100644 --- a/src/bo4e/com/kontaktweg.py +++ b/src/bo4e/com/kontaktweg.py @@ -29,11 +29,11 @@ class Kontaktweg(COM): """ - #: Gibt die Kontaktart des Kontaktes an. kontaktart: Optional["Kontaktart"] = None - #: Spezifikation, beispielsweise "Durchwahl", "Sammelnummer" etc. + """Gibt die Kontaktart des Kontaktes an.""" beschreibung: Optional[str] = None - #: Die Nummer oder E-Mail-Adresse. + """Spezifikation, beispielsweise "Durchwahl", "Sammelnummer" etc.""" kontaktwert: Optional[str] = None - #: Gibt an, ob es sich um den bevorzugten Kontaktweg handelt. + """Die Nummer oder E-Mail-Adresse.""" ist_bevorzugter_kontaktweg: Optional[bool] = None + """Gibt an, ob es sich um den bevorzugten Kontaktweg handelt.""" diff --git a/src/bo4e/com/konzessionsabgabe.py b/src/bo4e/com/konzessionsabgabe.py index 5bf8bfdfd..679df6db8 100644 --- a/src/bo4e/com/konzessionsabgabe.py +++ b/src/bo4e/com/konzessionsabgabe.py @@ -29,11 +29,11 @@ class Konzessionsabgabe(COM): """ - #: Art der Abgabe satz: Optional["AbgabeArt"] = None + """Art der Abgabe""" - #: Konzessionsabgabe in E/kWh kosten: Optional[Decimal] = None + """Konzessionsabgabe in E/kWh""" - #: Gebührenkategorie der Konzessionsabgabe kategorie: Optional[str] = None + """Gebührenkategorie der Konzessionsabgabe""" diff --git a/src/bo4e/com/kostenblock.py b/src/bo4e/com/kostenblock.py index 1f1a2ed13..eeff9ce7a 100644 --- a/src/bo4e/com/kostenblock.py +++ b/src/bo4e/com/kostenblock.py @@ -29,11 +29,11 @@ class Kostenblock(COM): """ - #: Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc. kostenblockbezeichnung: Optional[str] = None + """Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc.""" - #: Die Summe aller Kostenpositionen dieses Blocks summe_kostenblock: Optional["Betrag"] = None + """Die Summe aller Kostenpositionen dieses Blocks""" kostenpositionen: Optional[list["Kostenposition"]] = None """ diff --git a/src/bo4e/com/kostenposition.py b/src/bo4e/com/kostenposition.py index 9dc62d207..ab92eab54 100644 --- a/src/bo4e/com/kostenposition.py +++ b/src/bo4e/com/kostenposition.py @@ -32,27 +32,27 @@ class Kostenposition(COM): """ - #: Ein Titel für die Zeile. Hier kann z.B. der Netzbetreiber eingetragen werden, wenn es sich um Netzkosten handelt. positionstitel: Optional[str] = None + """Ein Titel für die Zeile. Hier kann z.B. der Netzbetreiber eingetragen werden, wenn es sich um Netzkosten handelt.""" betrag_kostenposition: Optional["Betrag"] = None """Der errechnete Gesamtbetrag der Position als Ergebnis der Berechnung oder """ # todo: validate above calculation, see https://github.com/Hochfrequenz/BO4E-python/issues/282 - #: Bezeichnung für den Artikel für den die Kosten ermittelt wurden. Beispiel: Arbeitspreis HT artikelbezeichnung: Optional[str] = None + """Bezeichnung für den Artikel für den die Kosten ermittelt wurden. Beispiel: Arbeitspreis HT""" - #: Der Preis für eine Einheit. Beispiele: 5,8200 ct/kWh oder 55 €/Jahr. einzelpreis: Optional["Preis"] = None + """Der Preis für eine Einheit. Beispiele: 5,8200 ct/kWh oder 55 €/Jahr.""" - #: inklusiver von-Zeitpunkt der Kostenzeitscheibe von: Optional[pydantic.AwareDatetime] = None - #: exklusiver bis-Zeitpunkt der Kostenzeitscheibe + """inklusiver von-Zeitpunkt der Kostenzeitscheibe""" bis: Optional[pydantic.AwareDatetime] = None + """exklusiver bis-Zeitpunkt der Kostenzeitscheibe""" - #: Die Menge, die in die Kostenberechnung eingeflossen ist. Beispiel: 3.660 kWh menge: Optional["Menge"] = None + """Die Menge, die in die Kostenberechnung eingeflossen ist. Beispiel: 3.660 kWh""" zeitmenge: Optional["Menge"] = None """ @@ -60,5 +60,5 @@ class Kostenposition(COM): wurden. Z.B. 138 Tage. """ - #: Detaillierung des Artikels (optional). Beispiel: 'Drehstromzähler' artikeldetail: Optional[str] = None + """Detaillierung des Artikels (optional). Beispiel: 'Drehstromzähler'""" diff --git a/src/bo4e/com/kriteriumwert.py b/src/bo4e/com/kriteriumwert.py index 3cee963a1..d11eb0732 100644 --- a/src/bo4e/com/kriteriumwert.py +++ b/src/bo4e/com/kriteriumwert.py @@ -27,7 +27,7 @@ class KriteriumWert(COM): """ - #: Hier steht, für welches Kriterium der Wert gilt. Z.B. Postleitzahlen kriterium: Optional["Tarifregionskriterium"] = None - #: Ein Wert, passend zum Kriterium. Z.B. eine Postleitzahl. + """Hier steht, für welches Kriterium der Wert gilt. Z.B. Postleitzahlen""" wert: Optional[str] = None + """Ein Wert, passend zum Kriterium. Z.B. eine Postleitzahl.""" diff --git a/src/bo4e/com/marktgebietinfo.py b/src/bo4e/com/marktgebietinfo.py index e2054a63c..1dcf43dbf 100644 --- a/src/bo4e/com/marktgebietinfo.py +++ b/src/bo4e/com/marktgebietinfo.py @@ -25,5 +25,7 @@ class MarktgebietInfo(COM): """ - marktgebiet: Optional[str] = None #: Der Name des Marktgebietes - marktgebietcode: Optional[str] = None #: Die standardisierte Codenummer des Marktgebietes + marktgebiet: Optional[str] = None + """Der Name des Marktgebietes""" + marktgebietcode: Optional[str] = None + """Die standardisierte Codenummer des Marktgebietes""" diff --git a/src/bo4e/com/menge.py b/src/bo4e/com/menge.py index 32bf19da8..1d30574e9 100644 --- a/src/bo4e/com/menge.py +++ b/src/bo4e/com/menge.py @@ -30,7 +30,7 @@ class Menge(COM): """ - #: Gibt den absoluten Wert der Menge an wert: Optional[Decimal] = None - #: Gibt die Einheit zum jeweiligen Wert an + """Gibt den absoluten Wert der Menge an""" einheit: Optional["Mengeneinheit"] = None + """Gibt die Einheit zum jeweiligen Wert an""" diff --git a/src/bo4e/com/positionsaufabschlag.py b/src/bo4e/com/positionsaufabschlag.py index aa1b76725..a58e53f92 100644 --- a/src/bo4e/com/positionsaufabschlag.py +++ b/src/bo4e/com/positionsaufabschlag.py @@ -32,13 +32,13 @@ class PositionsAufAbschlag(COM): """ - #: Bezeichnung des Auf-/Abschlags bezeichnung: Optional[str] = None - #: Beschreibung zum Auf-/Abschlag + """Bezeichnung des Auf-/Abschlags""" beschreibung: Optional[str] = None - #: Typ des AufAbschlages + """Beschreibung zum Auf-/Abschlag""" auf_abschlagstyp: Optional["AufAbschlagstyp"] = None - #: Höhe des Auf-/Abschlages + """Typ des AufAbschlages""" auf_abschlagswert: Optional[Decimal] = None - #: Einheit, in der der Auf-/Abschlag angegeben ist (z.B. ct/kWh). + """Höhe des Auf-/Abschlages""" auf_abschlagswaehrung: Optional["Waehrungseinheit"] = None + """Einheit, in der der Auf-/Abschlag angegeben ist (z.B. ct/kWh).""" diff --git a/src/bo4e/com/preis.py b/src/bo4e/com/preis.py index f2d9fbb2a..0474149c4 100644 --- a/src/bo4e/com/preis.py +++ b/src/bo4e/com/preis.py @@ -32,12 +32,12 @@ class Preis(COM): """ - #: Gibt die nominale Höhe des Preises an. wert: Optional[Decimal] = None - #: Währungseinheit für den Preis, z.B. Euro oder Ct. + """Gibt die nominale Höhe des Preises an.""" einheit: Optional["Waehrungseinheit"] = None - #: Angabe, für welche Bezugsgröße der Preis gilt. Z.B. kWh. + """Währungseinheit für den Preis, z.B. Euro oder Ct.""" bezugswert: Optional["Mengeneinheit"] = None + """Angabe, für welche Bezugsgröße der Preis gilt. Z.B. kWh.""" - #: Gibt den Status des veröffentlichten Preises an status: Optional["Preisstatus"] = None + """Gibt den Status des veröffentlichten Preises an""" diff --git a/src/bo4e/com/preisgarantie.py b/src/bo4e/com/preisgarantie.py index 0d9839724..baf82e15b 100644 --- a/src/bo4e/com/preisgarantie.py +++ b/src/bo4e/com/preisgarantie.py @@ -29,12 +29,12 @@ class Preisgarantie(COM): """ - #: Festlegung, auf welche Preisbestandteile die Garantie gewährt wird. preisgarantietyp: Optional["Preisgarantietyp"] = None + """Festlegung, auf welche Preisbestandteile die Garantie gewährt wird.""" zeitliche_gueltigkeit: Optional["Zeitraum"] = None """ Zeitraum, bis zu dem die Preisgarantie gilt, z.B. bis zu einem absolutem / fixem Datum oder als Laufzeit in Monaten. """ # optionale attributes - #: Freitext zur Beschreibung der Preisgarantie. beschreibung: Optional[str] = None + """Freitext zur Beschreibung der Preisgarantie.""" diff --git a/src/bo4e/com/preisposition.py b/src/bo4e/com/preisposition.py index 0e8434b98..824950a1f 100644 --- a/src/bo4e/com/preisposition.py +++ b/src/bo4e/com/preisposition.py @@ -37,35 +37,35 @@ class Preisposition(COM): """ - #: Das Modell, das der Preisbildung zugrunde liegt berechnungsmethode: Optional["Kalkulationsmethode"] = None - #: Standardisierte Bezeichnung für die abgerechnete Leistungserbringung - leistungstyp: Optional["Leistungstyp"] = None # - #: Bezeichnung für die in der Position abgebildete Leistungserbringung + """Das Modell, das der Preisbildung zugrunde liegt""" + leistungstyp: Optional["Leistungstyp"] = None + """Standardisierte Bezeichnung für die abgerechnete Leistungserbringung""" # leistungsbezeichnung: Optional[str] = None - #: Festlegung, mit welcher Preiseinheit abgerechnet wird, z.B. Ct. oder € + """Bezeichnung für die in der Position abgebildete Leistungserbringung""" preiseinheit: Optional["Waehrungseinheit"] = None - #: Hier wird festgelegt, auf welche Bezugsgrösse sich der Preis bezieht, z.B. kWh oder Stück + """Festlegung, mit welcher Preiseinheit abgerechnet wird, z.B. Ct. oder €""" bezugsgroesse: Optional["Mengeneinheit"] = None - #: Preisstaffeln, die zu dieser Preisposition gehören + """Hier wird festgelegt, auf welche Bezugsgrösse sich der Preis bezieht, z.B. kWh oder Stück""" preisstaffeln: Optional[list["Preisstaffel"]] = None + """Preisstaffeln, die zu dieser Preisposition gehören""" zeitbasis: Optional["Mengeneinheit"] = None """ Die Zeit(dauer) auf die sich der Preis bezieht. Z.B. ein Jahr für einen Leistungspreis der in €/kW/Jahr ausgegeben wird """ - #: Festlegung, für welche Tarifzeit der Preis hier festgelegt ist tarifzeit: Optional["Tarifzeit"] = None + """Festlegung, für welche Tarifzeit der Preis hier festgelegt ist""" bdew_artikelnummer: Optional["BDEWArtikelnummer"] = None """ Eine vom BDEW standardisierte Bezeichnug für die abgerechnete Leistungserbringung; Diese Artikelnummer wird auch im Rechnungsteil der INVOIC verwendet. """ - #: Mit der Menge der hier angegebenen Größe wird die Staffelung/Zonung durchgeführt. Z.B. Vollbenutzungsstunden zonungsgroesse: Optional["Bemessungsgroesse"] = None - #: Der Anteil der Menge der Blindarbeit in Prozent von der Wirkarbeit, für die keine Abrechnung erfolgt + """Mit der Menge der hier angegebenen Größe wird die Staffelung/Zonung durchgeführt. Z.B. Vollbenutzungsstunden""" freimenge_blindarbeit: Optional[Decimal] = None + """Der Anteil der Menge der Blindarbeit in Prozent von der Wirkarbeit, für die keine Abrechnung erfolgt""" freimenge_leistungsfaktor: Optional[Decimal] = None """ Der cos phi (Verhältnis Wirkleistung/Scheinleistung) aus dem die Freimenge für die Blindarbeit berechnet wird als diff --git a/src/bo4e/com/preisstaffel.py b/src/bo4e/com/preisstaffel.py index 607bd922d..4ba539fa2 100644 --- a/src/bo4e/com/preisstaffel.py +++ b/src/bo4e/com/preisstaffel.py @@ -29,15 +29,15 @@ class Preisstaffel(COM): """ - #: Preis pro abgerechneter Mengeneinheit einheitspreis: Optional[Decimal] = None - #: Inklusiver unterer Wert, ab dem die Staffel gilt + """Preis pro abgerechneter Mengeneinheit""" staffelgrenze_von: Optional[Decimal] = None - #: Exklusiver oberer Wert, bis zu dem die Staffel gilt + """Inklusiver unterer Wert, ab dem die Staffel gilt""" staffelgrenze_bis: Optional[Decimal] = None + """Exklusiver oberer Wert, bis zu dem die Staffel gilt""" - #: Parameter zur Berechnung des Preises anhand der Jahresmenge und weiterer netzbezogener Parameter sigmoidparameter: Optional["Sigmoidparameter"] = None + """Parameter zur Berechnung des Preises anhand der Jahresmenge und weiterer netzbezogener Parameter""" - #: Standardisierte vom BDEW herausgegebene Liste, welche im Strommarkt die BDEW-Artikelnummer ablöst artikel_id: Optional[str] = None + """Standardisierte vom BDEW herausgegebene Liste, welche im Strommarkt die BDEW-Artikelnummer ablöst""" diff --git a/src/bo4e/com/rechnungsposition.py b/src/bo4e/com/rechnungsposition.py index 9320f4ff2..33f79981d 100644 --- a/src/bo4e/com/rechnungsposition.py +++ b/src/bo4e/com/rechnungsposition.py @@ -34,23 +34,21 @@ class Rechnungsposition(COM): """ - #: Fortlaufende Nummer für die Rechnungsposition positionsnummer: Optional[int] = None + """Fortlaufende Nummer für die Rechnungsposition""" - lieferung_von: Optional[pydantic.AwareDatetime] = ( - None #: Start der Lieferung für die abgerechnete Leistung (inklusiv) - ) - lieferung_bis: Optional[pydantic.AwareDatetime] = ( - None #: Ende der Lieferung für die abgerechnete Leistung (exklusiv) - ) + lieferung_von: Optional[pydantic.AwareDatetime] = None + """Start der Lieferung für die abgerechnete Leistung (inklusiv)""" + lieferung_bis: Optional[pydantic.AwareDatetime] = None + """Ende der Lieferung für die abgerechnete Leistung (exklusiv)""" - #: Bezeichung für die abgerechnete Position positionstext: Optional[str] = None + """Bezeichung für die abgerechnete Position""" - #: Die abgerechnete Menge mit Einheit positions_menge: Optional["Menge"] = None - #: Der Preis für eine Einheit der energetischen Menge + """Die abgerechnete Menge mit Einheit""" einzelpreis: Optional["Preis"] = None + """Der Preis für eine Einheit der energetischen Menge""" teilsumme_netto: Optional["Betrag"] = None """ @@ -60,16 +58,16 @@ class Rechnungsposition(COM): # the cross check in general doesn't work because Betrag and Preis use different enums to describe the currency # see https://github.com/Hochfrequenz/BO4E-python/issues/126 - #: Auf die Position entfallende Steuer, bestehend aus Steuersatz und Betrag teilsumme_steuer: Optional["Steuerbetrag"] = None + """Auf die Position entfallende Steuer, bestehend aus Steuersatz und Betrag""" - #: Falls sich der Preis auf eine Zeit bezieht, steht hier die Einheit zeiteinheit: Optional["Mengeneinheit"] = None + """Falls sich der Preis auf eine Zeit bezieht, steht hier die Einheit""" - #: Kennzeichnung der Rechnungsposition mit der Standard-Artikelnummer des BDEW artikelnummer: Optional["BDEWArtikelnummer"] = None - #: Marktlokation, die zu dieser Position gehört + """Kennzeichnung der Rechnungsposition mit der Standard-Artikelnummer des BDEW""" lokations_id: Optional[str] = None + """Marktlokation, die zu dieser Position gehört""" zeitbezogene_menge: Optional["Menge"] = None """ @@ -77,8 +75,8 @@ class Rechnungsposition(COM): Z.B. bei einem Jahrespreis, 3 Monate oder 146 Tage. Basierend darauf wird der Preis aufgeteilt. """ - #: Nettobetrag für den Rabatt dieser Position teilrabatt_netto: Optional["Betrag"] = None + """Nettobetrag für den Rabatt dieser Position""" - #: Standardisierte vom BDEW herausgegebene Liste, welche im Strommarkt die BDEW-Artikelnummer ablöst artikel_id: Optional[str] = None + """Standardisierte vom BDEW herausgegebene Liste, welche im Strommarkt die BDEW-Artikelnummer ablöst""" diff --git a/src/bo4e/com/regionalegueltigkeit.py b/src/bo4e/com/regionalegueltigkeit.py index 408698d03..d54005afd 100644 --- a/src/bo4e/com/regionalegueltigkeit.py +++ b/src/bo4e/com/regionalegueltigkeit.py @@ -30,9 +30,7 @@ class RegionaleGueltigkeit(COM): """ - gueltigkeitstyp: Optional["Gueltigkeitstyp"] = ( - None #: Unterscheidung ob Positivliste oder Negativliste übertragen wird - ) - kriteriums_werte: Optional[list["KriteriumWert"]] = ( - None #: Hier stehen die Kriterien, die die regionale Gültigkeit festlegen - ) + gueltigkeitstyp: Optional["Gueltigkeitstyp"] = None + """Unterscheidung ob Positivliste oder Negativliste übertragen wird""" + kriteriums_werte: Optional[list["KriteriumWert"]] = None + """Hier stehen die Kriterien, die die regionale Gültigkeit festlegen""" diff --git a/src/bo4e/com/regionalepreisgarantie.py b/src/bo4e/com/regionalepreisgarantie.py index 6a42a2ac3..3262752b8 100644 --- a/src/bo4e/com/regionalepreisgarantie.py +++ b/src/bo4e/com/regionalepreisgarantie.py @@ -28,5 +28,5 @@ class RegionalePreisgarantie(Preisgarantie): """ - #: Regionale Eingrenzung der Preisgarantie. regionale_gueltigkeit: Optional["RegionaleGueltigkeit"] = None + """Regionale Eingrenzung der Preisgarantie.""" diff --git a/src/bo4e/com/regionalepreisstaffel.py b/src/bo4e/com/regionalepreisstaffel.py index bcec02da1..46cc7d24d 100644 --- a/src/bo4e/com/regionalepreisstaffel.py +++ b/src/bo4e/com/regionalepreisstaffel.py @@ -27,5 +27,5 @@ class RegionalePreisstaffel(Preisstaffel): """ - #: Regionale Eingrenzung der Preisstaffel regionale_gueltigkeit: Optional["RegionaleGueltigkeit"] = None + """Regionale Eingrenzung der Preisstaffel""" diff --git a/src/bo4e/com/regionaleraufabschlag.py b/src/bo4e/com/regionaleraufabschlag.py index be98031ea..b17d19ff7 100644 --- a/src/bo4e/com/regionaleraufabschlag.py +++ b/src/bo4e/com/regionaleraufabschlag.py @@ -40,38 +40,38 @@ class RegionalerAufAbschlag(COM): """ - #: Bezeichnung des Auf-/Abschlags bezeichnung: Optional[str] = None + """Bezeichnung des Auf-/Abschlags""" - #: Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung staffeln: Optional[list["RegionalePreisstaffel"]] = None + """Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung""" - #: Beschreibung des Auf-/Abschlags beschreibung: Optional[str] = None + """Beschreibung des Auf-/Abschlags""" - #: Typ des Aufabschlages (z.B. absolut oder prozentual) auf_abschlagstyp: Optional["AufAbschlagstyp"] = None + """Typ des Aufabschlages (z.B. absolut oder prozentual)""" - #: Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc. auf_abschlagsziel: Optional["AufAbschlagsziel"] = None + """Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc.""" - #: Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird (nur im Falle absoluter Aufschlagstypen). einheit: Optional["Waehrungseinheit"] = None + """Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird (nur im Falle absoluter Aufschlagstypen).""" - #: Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind website: Optional[str] = None + """Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind""" - #: Zusatzprodukte, die nur in Kombination mit diesem AufAbschlag erhältlich sind zusatzprodukte: Optional[list[str]] = None + """Zusatzprodukte, die nur in Kombination mit diesem AufAbschlag erhältlich sind""" - #: Voraussetzungen, die erfüllt sein müssen, damit dieser AufAbschlag zur Anwendung kommen kann voraussetzungen: Optional[list[str]] = None + """Voraussetzungen, die erfüllt sein müssen, damit dieser AufAbschlag zur Anwendung kommen kann""" - #: Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten tarifnamensaenderungen: Optional[str] = None + """Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten""" - #: Zeitraum, in dem der Abschlag zur Anwendung kommen kann gueltigkeitszeitraum: Optional["Zeitraum"] = None + """Zeitraum, in dem der Abschlag zur Anwendung kommen kann""" energiemixaenderung: Optional["Energiemix"] = None """ diff --git a/src/bo4e/com/regionaletarifpreisposition.py b/src/bo4e/com/regionaletarifpreisposition.py index 0bb6b8a15..cc0733437 100644 --- a/src/bo4e/com/regionaletarifpreisposition.py +++ b/src/bo4e/com/regionaletarifpreisposition.py @@ -31,14 +31,14 @@ class RegionaleTarifpreisposition(COM): """ - #: Angabe des Preistypes (z.B. Grundpreis) preistyp: Optional["Preistyp"] = None - #: Einheit des Preises (z.B. EURO) + """Angabe des Preistypes (z.B. Grundpreis)""" einheit: Optional["Waehrungseinheit"] = None - #: Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr + """Einheit des Preises (z.B. EURO)""" bezugseinheit: Optional["Mengeneinheit"] = None - #: Hier sind die Staffeln mit ihren Preisangaben und regionalen Gültigkeiten definiert + """Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr""" preisstaffeln: Optional[list["RegionalePreisstaffel"]] = None + """Hier sind die Staffeln mit ihren Preisangaben und regionalen Gültigkeiten definiert""" - #: Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh) mengeneinheitstaffel: Optional["Mengeneinheit"] = None + """Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh)""" diff --git a/src/bo4e/com/regionskriterium.py b/src/bo4e/com/regionskriterium.py index ecacc73c5..c400b18b5 100644 --- a/src/bo4e/com/regionskriterium.py +++ b/src/bo4e/com/regionskriterium.py @@ -29,12 +29,10 @@ class Regionskriterium(COM): """ - gueltigkeitstyp: Optional["Gueltigkeitstyp"] = ( - None #: Hier wird festgelegt, ob es sich um ein einschließendes oder ausschließendes Kriterium handelt. - ) - regionskriteriumtyp: Optional["Regionskriteriumtyp"] = ( - None #: Hier wird das Kriterium selbst angegeben, z.B. Bundesland. - ) + gueltigkeitstyp: Optional["Gueltigkeitstyp"] = None + """Hier wird festgelegt, ob es sich um ein einschließendes oder ausschließendes Kriterium handelt.""" + regionskriteriumtyp: Optional["Regionskriteriumtyp"] = None + """Hier wird das Kriterium selbst angegeben, z.B. Bundesland.""" wert: Optional[str] = None """ Der Wert, den das Kriterium annehmen kann, z.B. NRW. diff --git a/src/bo4e/com/sigmoidparameter.py b/src/bo4e/com/sigmoidparameter.py index 53b2078c6..e22101b37 100644 --- a/src/bo4e/com/sigmoidparameter.py +++ b/src/bo4e/com/sigmoidparameter.py @@ -26,7 +26,11 @@ class Sigmoidparameter(COM): """ - A: Optional[Decimal] = None #: Briefmarke Ortsverteilnetz (EUR/kWh) - B: Optional[Decimal] = None #: Wendepunkt für die bepreiste Menge (kW) - C: Optional[Decimal] = None #: Exponent (einheitenlos) - D: Optional[Decimal] = None #: Briefmarke Transportnetz (EUR/kWh) + A: Optional[Decimal] = None + """Briefmarke Ortsverteilnetz (EUR/kWh)""" + B: Optional[Decimal] = None + """Wendepunkt für die bepreiste Menge (kW)""" + C: Optional[Decimal] = None + """Exponent (einheitenlos)""" + D: Optional[Decimal] = None + """Briefmarke Transportnetz (EUR/kWh)""" diff --git a/src/bo4e/com/standorteigenschaftengas.py b/src/bo4e/com/standorteigenschaftengas.py index e7511e066..bf8b2ec32 100644 --- a/src/bo4e/com/standorteigenschaftengas.py +++ b/src/bo4e/com/standorteigenschaftengas.py @@ -30,5 +30,7 @@ class StandorteigenschaftenGas(COM): """ - netzkontonummern: Optional[list[str]] = None #: Netzkontonummern der Gasnetze - marktgebiete: Optional[list["MarktgebietInfo"]] = None #: Die Informationen zu Marktgebieten in dem Netz. + netzkontonummern: Optional[list[str]] = None + """Netzkontonummern der Gasnetze""" + marktgebiete: Optional[list["MarktgebietInfo"]] = None + """Die Informationen zu Marktgebieten in dem Netz.""" diff --git a/src/bo4e/com/standorteigenschaftenstrom.py b/src/bo4e/com/standorteigenschaftenstrom.py index 3f14de86b..a871cf891 100644 --- a/src/bo4e/com/standorteigenschaftenstrom.py +++ b/src/bo4e/com/standorteigenschaftenstrom.py @@ -25,13 +25,13 @@ class StandorteigenschaftenStrom(COM): """ - #: Die EIC-Nummer des Bilanzierungsgebietes bilanzierungsgebiet_eic: Optional[str] = None + """Die EIC-Nummer des Bilanzierungsgebietes""" # todo: use EIC validation: https://github.com/Hochfrequenz/BO4E-python/issues/147 - #: Der Name der Regelzone regelzone: Optional[str] = None + """Der Name der Regelzone""" - #: De EIC-Nummer der Regelzone regelzone_eic: Optional[str] = None + """De EIC-Nummer der Regelzone""" # todo: use EIC validation: https://github.com/Hochfrequenz/BO4E-python/issues/147 diff --git a/src/bo4e/com/steuerbetrag.py b/src/bo4e/com/steuerbetrag.py index 108495399..40d316396 100644 --- a/src/bo4e/com/steuerbetrag.py +++ b/src/bo4e/com/steuerbetrag.py @@ -31,11 +31,11 @@ class Steuerbetrag(COM): """ - #: Kennzeichnung des Steuersatzes, bzw. Verfahrens. steuerkennzeichen: Optional["Steuerkennzeichen"] = None - #: Nettobetrag für den die Steuer berechnet wurde. Z.B. 100 + """Kennzeichnung des Steuersatzes, bzw. Verfahrens.""" basiswert: Optional[Decimal] = None - #: Aus dem Basiswert berechnete Steuer. Z.B. 19 (bei UST_19) + """Nettobetrag für den die Steuer berechnet wurde. Z.B. 100""" steuerwert: Optional[Decimal] = None - #: Währung. Z.B. Euro. + """Aus dem Basiswert berechnete Steuer. Z.B. 19 (bei UST_19)""" waehrung: Optional["Waehrungscode"] = None + """Währung. Z.B. Euro.""" diff --git a/src/bo4e/com/tarifberechnungsparameter.py b/src/bo4e/com/tarifberechnungsparameter.py index 0979a50f2..aaefbc8ed 100644 --- a/src/bo4e/com/tarifberechnungsparameter.py +++ b/src/bo4e/com/tarifberechnungsparameter.py @@ -37,10 +37,10 @@ class Tarifberechnungsparameter(COM): # there are no required attributes - #: Gibt an, wie die Einzelpreise des Tarifes zu verarbeiten sind berechnungsmethode: Optional["Tarifkalkulationsmethode"] = None - #: True, falls der Messpreis im Grundpreis (GP) enthalten ist + """Gibt an, wie die Einzelpreise des Tarifes zu verarbeiten sind""" ist_messpreis_in_grundpreis_enthalten: Optional[bool] = None + """True, falls der Messpreis im Grundpreis (GP) enthalten ist""" ist_messpreis_zu_beruecksichtigen: Optional[bool] = None """ @@ -48,22 +48,22 @@ class Tarifberechnungsparameter(COM): berücksichtigt wird """ - #: Typ des Messpreises messpreistyp: Optional["Messpreistyp"] = None + """Typ des Messpreises""" - #: Im Preis bereits eingeschlossene Leistung (für Gas) kw_inklusive: Optional[Decimal] = None + """Im Preis bereits eingeschlossene Leistung (für Gas)""" # todo: type decimal is most likely wrong: https://github.com/Hochfrequenz/BO4E-python/issues/327 - #: Intervall, indem die über "kwInklusive" hinaus abgenommene Leistung kostenpflichtig wird (z.B. je 5 kW 20 EURO) kw_weitere_mengen: Optional[Decimal] = None + """Intervall, indem die über "kwInklusive" hinaus abgenommene Leistung kostenpflichtig wird (z.B. je 5 kW 20 EURO)""" # todo: type decimal is most likely wrong: https://github.com/Hochfrequenz/BO4E-python/issues/327 - #: Höchstpreis für den Durchschnitts-Arbeitspreis NT hoechstpreis_n_t: Optional["Preis"] = None - #: Höchstpreis für den Durchschnitts-Arbeitspreis HT + """Höchstpreis für den Durchschnitts-Arbeitspreis NT""" hoechstpreis_h_t: Optional["Preis"] = None - #: Mindestpreis für den Durchschnitts-Arbeitspreis + """Höchstpreis für den Durchschnitts-Arbeitspreis HT""" mindestpreis: Optional["Preis"] = None - #: Liste mit zusätzlichen Preisen, beispielsweise Messpreise und/oder Leistungspreise + """Mindestpreis für den Durchschnitts-Arbeitspreis""" zusatzpreise: Optional[list["Tarifpreis"]] = None + """Liste mit zusätzlichen Preisen, beispielsweise Messpreise und/oder Leistungspreise""" diff --git a/src/bo4e/com/tarifeinschraenkung.py b/src/bo4e/com/tarifeinschraenkung.py index c08eb842d..f44740313 100644 --- a/src/bo4e/com/tarifeinschraenkung.py +++ b/src/bo4e/com/tarifeinschraenkung.py @@ -29,10 +29,10 @@ class Tarifeinschraenkung(COM): """ - #: Weitere Produkte, die gemeinsam mit diesem Tarif bestellt werden können zusatzprodukte: Optional[list[str]] = None - #: Voraussetzungen, die erfüllt sein müssen, damit dieser Tarif zur Anwendung kommen kann + """Weitere Produkte, die gemeinsam mit diesem Tarif bestellt werden können""" voraussetzungen: Optional[list["Voraussetzungen"]] = None + """Voraussetzungen, die erfüllt sein müssen, damit dieser Tarif zur Anwendung kommen kann""" einschraenkungzaehler: Optional[list["Geraet"]] = None """ Liste der Zähler/Geräte, die erforderlich sind, damit dieser Tarif zur Anwendung gelangen kann. (Falls keine Zähler angegeben sind, ist der Tarif nicht an das Vorhandensein bestimmter Zähler gebunden.) """ diff --git a/src/bo4e/com/tarifpreis.py b/src/bo4e/com/tarifpreis.py index ea27d8b90..be8e7d4bb 100644 --- a/src/bo4e/com/tarifpreis.py +++ b/src/bo4e/com/tarifpreis.py @@ -29,8 +29,8 @@ class Tarifpreis(Preis): """ - #: Angabe des Preistypes (z.B. Grundpreis) preistyp: Optional["Preistyp"] = None + """ Angabe des Preistypes (z.B. Grundpreis)""" - #: Beschreibung des Preises. Hier können z.B. Preisdetails angegeben sein, beispielsweise "Drehstromzähler". beschreibung: Optional[str] = None + """ Beschreibung des Preises. Hier können z.B. Preisdetails angegeben sein, beispielsweise "Drehstromzähler".""" diff --git a/src/bo4e/com/tarifpreisposition.py b/src/bo4e/com/tarifpreisposition.py index f31a86625..780610df7 100644 --- a/src/bo4e/com/tarifpreisposition.py +++ b/src/bo4e/com/tarifpreisposition.py @@ -31,14 +31,14 @@ class Tarifpreisposition(COM): """ - #: Angabe des Preistypes (z.B. Grundpreis) preistyp: Optional["Preistyp"] = None - #: Einheit des Preises (z.B. EURO) + """Angabe des Preistypes (z.B. Grundpreis)""" einheit: Optional["Waehrungseinheit"] = None - #: Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr + """Einheit des Preises (z.B. EURO)""" bezugseinheit: Optional["Mengeneinheit"] = None - #: Hier sind die Staffeln mit ihren Preisenangaben definiert + """Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr""" preisstaffeln: Optional[list["Preisstaffel"]] = None + """Hier sind die Staffeln mit ihren Preisenangaben definiert""" - #: Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh) mengeneinheitstaffel: Optional["Mengeneinheit"] = None + """Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh)""" diff --git a/src/bo4e/com/tarifpreispositionproort.py b/src/bo4e/com/tarifpreispositionproort.py index 803be04f8..8291a96ea 100644 --- a/src/bo4e/com/tarifpreispositionproort.py +++ b/src/bo4e/com/tarifpreispositionproort.py @@ -30,12 +30,12 @@ class TarifpreispositionProOrt(COM): """ - #: Postleitzahl des Ortes für den der Preis gilt postleitzahl: Optional[str] = None - #: Ort für den der Preis gilt + """Postleitzahl des Ortes für den der Preis gilt""" ort: Optional[str] = None - #: ene't-Netznummer des Netzes in dem der Preis gilt + """Ort für den der Preis gilt""" netznr: Optional[str] = None + """ene't-Netznummer des Netzes in dem der Preis gilt""" # Hier sind die Staffeln mit ihren Preisenangaben definiert preisstaffeln: Optional[list["TarifpreisstaffelProOrt"]] = None # there are no optional attributes diff --git a/src/bo4e/com/tarifpreisstaffelproort.py b/src/bo4e/com/tarifpreisstaffelproort.py index 66feab854..9335e6a71 100644 --- a/src/bo4e/com/tarifpreisstaffelproort.py +++ b/src/bo4e/com/tarifpreisstaffelproort.py @@ -29,15 +29,15 @@ class TarifpreisstaffelProOrt(COM): # todo: decimal doesn't make sense here imo # https://github.com/Hochfrequenz/BO4E-python/issues/344 - #: Der Arbeitspreis in ct/kWh arbeitspreis: Optional[Decimal] = None - #: Der Arbeitspreis für Verbräuche in der Niedertarifzeit in ct/kWh + """Der Arbeitspreis in ct/kWh""" arbeitspreis_n_t: Optional[Decimal] = None - #: Der Grundpreis in Euro/Jahr + """Der Arbeitspreis für Verbräuche in der Niedertarifzeit in ct/kWh""" grundpreis: Optional[Decimal] = None - #: Unterer Wert, ab dem die Staffel gilt (inklusive) + """Der Grundpreis in Euro/Jahr""" staffelgrenze_von: Optional[Decimal] = None - #: Oberer Wert, bis zu dem die Staffel gilt (exklusive) + """Unterer Wert, ab dem die Staffel gilt (inklusive)""" staffelgrenze_bis: Optional[Decimal] = None + """Oberer Wert, bis zu dem die Staffel gilt (exklusive)""" # there are no optional attributes diff --git a/src/bo4e/com/unterschrift.py b/src/bo4e/com/unterschrift.py index e4e9a78b4..073d67cc8 100644 --- a/src/bo4e/com/unterschrift.py +++ b/src/bo4e/com/unterschrift.py @@ -27,8 +27,10 @@ class Unterschrift(COM): """ - #: Name des Unterschreibers name: Optional[str] = None + """Name des Unterschreibers""" - ort: Optional[str] = None #: Ort, an dem die Unterschrift geleistet wird - datum: Optional[pydantic.AwareDatetime] = None #: Datum der Unterschrift + ort: Optional[str] = None + """Ort, an dem die Unterschrift geleistet wird""" + datum: Optional[pydantic.AwareDatetime] = None + """Datum der Unterschrift""" diff --git a/src/bo4e/com/verbrauch.py b/src/bo4e/com/verbrauch.py index f39ebbf28..6c6c8aac5 100644 --- a/src/bo4e/com/verbrauch.py +++ b/src/bo4e/com/verbrauch.py @@ -34,18 +34,18 @@ class Verbrauch(COM): """ - #: Gibt an, ob es sich um eine PROGNOSE oder eine MESSUNG handelt wertermittlungsverfahren: Optional["Wertermittlungsverfahren"] = None - #: Die OBIS-Kennzahl für den Wert, die festlegt, welche Größe mit dem Stand gemeldet wird, z.B. '1-0: + """Gibt an, ob es sich um eine PROGNOSE oder eine MESSUNG handelt""" obis_kennzahl: Optional[str] = None - #: Gibt den absoluten Wert der Menge an + """Die OBIS-Kennzahl für den Wert, die festlegt, welche Größe mit dem Stand gemeldet wird, z.B. '1-0:""" wert: Optional[Decimal] = None - #: Gibt die Einheit zum jeweiligen Wert an + """Gibt den absoluten Wert der Menge an""" einheit: Optional["Mengeneinheit"] = None + """Gibt die Einheit zum jeweiligen Wert an""" - #: Inklusiver Beginn des Zeitraumes, für den der Verbrauch angegeben wird startdatum: Optional[pydantic.AwareDatetime] = None - #: Exklusives Ende des Zeitraumes, für den der Verbrauch angegeben wird + """Inklusiver Beginn des Zeitraumes, für den der Verbrauch angegeben wird""" enddatum: Optional[pydantic.AwareDatetime] = None - #: Messwertstatus includes the plausibility of the value + """Exklusives Ende des Zeitraumes, für den der Verbrauch angegeben wird""" messwertstatus: Optional["Messwertstatus"] = None + """Messwertstatus includes the plausibility of the value""" diff --git a/src/bo4e/com/vertragskonditionen.py b/src/bo4e/com/vertragskonditionen.py index f3156812d..9f9284e09 100644 --- a/src/bo4e/com/vertragskonditionen.py +++ b/src/bo4e/com/vertragskonditionen.py @@ -30,15 +30,17 @@ class Vertragskonditionen(COM): """ - #: Freitext zur Beschreibung der Konditionen, z.B. "Standardkonditionen Gas" beschreibung: Optional[str] = None - #: Anzahl der vereinbarten Abschläge pro Jahr, z.B. 12 + """ + Freitext zur Beschreibung der Konditionen, z.B. "Standardkonditionen Gas" + """ anzahl_abschlaege: Optional[Decimal] = None - #: Über diesen Zeitraum läuft der Vertrag + """Anzahl der vereinbarten Abschläge pro Jahr, z.B. 12""" vertragslaufzeit: Optional["Zeitraum"] = None - #: Innerhalb dieser Frist kann der Vertrag gekündigt werden + """Über diesen Zeitraum läuft der Vertrag""" kuendigungsfrist: Optional["Zeitraum"] = None - #: Falls der Vertrag nicht gekündigt wird, verlängert er sich automatisch um die hier angegebene Zeit + """Innerhalb dieser Frist kann der Vertrag gekündigt werden""" vertragsverlaengerung: Optional["Zeitraum"] = None - #: In diesen Zyklen werden Abschläge gestellt. Alternativ kann auch die Anzahl in den Konditionen angeben werden. + """Falls der Vertrag nicht gekündigt wird, verlängert er sich automatisch um die hier angegebene Zeit""" abschlagszyklus: Optional["Zeitraum"] = None + """In diesen Zyklen werden Abschläge gestellt. Alternativ kann auch die Anzahl in den Konditionen angeben werden.""" diff --git a/src/bo4e/com/zaehlwerk.py b/src/bo4e/com/zaehlwerk.py index c09afd572..9fd170fa9 100644 --- a/src/bo4e/com/zaehlwerk.py +++ b/src/bo4e/com/zaehlwerk.py @@ -19,12 +19,6 @@ from ..enum.waermenutzung import Waermenutzung -# pylint: disable=no-name-in-module -# pylint: disable=no-name-in-module - -# pylint: disable=too-few-public-methods - - @postprocess_docstring class Zaehlwerk(COM): """ @@ -39,32 +33,48 @@ class Zaehlwerk(COM): """ - zaehlwerk_id: Optional[str] = None # Identifikation des Zählwerks (Registers) innerhalb des Zählers. - # Oftmals eine laufende Nummer hinter der Zählernummer. Z.B. 47110815_1 - bezeichnung: Optional[str] = None # Zusätzliche Bezeichnung, z.B. Zählwerk_Wirkarbeit. - richtung: Optional["Energierichtung"] = None # Die Energierichtung, Einspeisung oder Ausspeisung. - obis_kennzahl: Optional[str] = ( - None # Die OBIS-Kennzahl für das Zählwerk, die festlegt, welche auf die gemessene Größe mit dem Stand gemeldet wird. - ) - # Nur Zählwerkstände mit dieser OBIS-Kennzahl werden an diesem Zählwerk registriert. - wandlerfaktor: Optional[Decimal] = ( - None # Mit diesem Faktor wird eine Zählerstandsdifferenz multipliziert, um zum eigentlichen Verbrauch im Zeitraum - ) - # zu kommen. - einheit: Optional["Mengeneinheit"] = None # Die Einheit der gemessenen Größe, z.B. kWh - ist_schwachlastfaehig: Optional[bool] = None #: Schwachlastfaehigkeit - verwendungszwecke: Optional[list["VerwendungszweckProMarktrolle"]] = ( - None #: Verwendungungszweck der Werte Marktlokation - ) - verbrauchsart: Optional["Verbrauchsart"] = None #: Stromverbrauchsart/Verbrauchsart Marktlokation - ist_unterbrechbar: Optional[bool] = None #: Unterbrechbarkeit Marktlokation - waermenutzung: Optional["Waermenutzung"] = None #: Wärmenutzung Marktlokation - konzessionsabgabe: Optional["Konzessionsabgabe"] = None #: Konzessionsabgabe - ist_steuerbefreit: Optional[bool] = None #: Steuerbefreiung - vorkommastelle: Optional[int] = None #: Anzahl der Vorkommastellen - nachkommastelle: Optional[int] = None #: Anzahl der Nachkommastellen - ist_abrechnungsrelevant: Optional[bool] = None #: Abrechnungsrelevant - anzahlAblesungen: Optional[int] = None #: Anzahl Ablesungen pro Jahr - zaehlzeitregister: Optional["Zaehlzeitregister"] = ( - None #: Erweiterte Definition der Zählzeit in Bezug auf ein Register - ) + zaehlwerk_id: Optional[str] = None + """ + Identifikation des Zählwerks (Registers) innerhalb des Zählers. + Oftmals eine laufende Nummer hinter der Zählernummer. Z.B. 47110815_1 + """ + bezeichnung: Optional[str] = None + """Zusätzliche Bezeichnung, z.B. Zählwerk_Wirkarbeit.""" + richtung: Optional["Energierichtung"] = None + """Die Energierichtung, Einspeisung oder Ausspeisung.""" + obis_kennzahl: Optional[str] = None + """ + Die OBIS-Kennzahl für das Zählwerk, die festlegt, welche auf die gemessene Größe mit dem Stand gemeldet wird. + Nur Zählwerkstände mit dieser OBIS-Kennzahl werden an diesem Zählwerk registriert. + """ + wandlerfaktor: Optional[Decimal] = None + """ + Mit diesem Faktor wird eine Zählerstandsdifferenz multipliziert, um zum eigentlichen Verbrauch im Zeitraum + zu kommen. + """ + einheit: Optional["Mengeneinheit"] = None + """Die Einheit der gemessenen Größe, z.B. kWh""" + ist_schwachlastfaehig: Optional[bool] = None + """Schwachlastfaehigkeit""" + verwendungszwecke: Optional[list["VerwendungszweckProMarktrolle"]] = None + """Verwendungungszweck der Werte Marktlokation""" + verbrauchsart: Optional["Verbrauchsart"] = None + """Stromverbrauchsart/Verbrauchsart Marktlokation""" + ist_unterbrechbar: Optional[bool] = None + """Unterbrechbarkeit Marktlokation""" + waermenutzung: Optional["Waermenutzung"] = None + """Wärmenutzung Marktlokation""" + konzessionsabgabe: Optional["Konzessionsabgabe"] = None + """Konzessionsabgabe""" + ist_steuerbefreit: Optional[bool] = None + """Steuerbefreiung""" + vorkommastelle: Optional[int] = None + """Anzahl der Vorkommastellen""" + nachkommastelle: Optional[int] = None + """Anzahl der Nachkommastellen""" + ist_abrechnungsrelevant: Optional[bool] = None + """Abrechnungsrelevant""" + anzahlAblesungen: Optional[int] = None + """Anzahl Ablesungen pro Jahr""" + zaehlzeitregister: Optional["Zaehlzeitregister"] = None + """Erweiterte Definition der Zählzeit in Bezug auf ein Register""" diff --git a/src/bo4e/com/zaehlzeitregister.py b/src/bo4e/com/zaehlzeitregister.py index 3e7e223f1..5267da74d 100644 --- a/src/bo4e/com/zaehlzeitregister.py +++ b/src/bo4e/com/zaehlzeitregister.py @@ -26,6 +26,9 @@ class Zaehlzeitregister(COM): """ - zaehlzeit_definition: Optional[str] = None #: Zählzeitdefinition - zaehlzeit_register: Optional[str] = None #: Zählzeitregister - ist_schwachlastfaehig: Optional[bool] = None #: Schwachlastfaehigkeit + zaehlzeit_definition: Optional[str] = None + """Zählzeitdefinition""" + zaehlzeit_register: Optional[str] = None + """Zählzeitregister""" + ist_schwachlastfaehig: Optional[bool] = None + """Schwachlastfaehigkeit""" diff --git a/src/bo4e/com/zeitreihenwert.py b/src/bo4e/com/zeitreihenwert.py index 2ed922a61..a4f6f9e91 100644 --- a/src/bo4e/com/zeitreihenwert.py +++ b/src/bo4e/com/zeitreihenwert.py @@ -32,12 +32,12 @@ class Zeitreihenwert(COM): """ - zeitspanne: Optional["Zeitspanne"] = None #: Zeitespanne für das Messintervall - - wert: Optional[Decimal] = None #: Der in der Zeitspanne gültige Wert. - - #: Der Status gibt an, wie der Wert zu interpretieren ist, z.B. in Berechnungen. + zeitspanne: Optional["Zeitspanne"] = None + """Zeitespanne für das Messintervall""" + wert: Optional[Decimal] = None + """Der in der Zeitspanne gültige Wert.""" status: Optional["Messwertstatus"] = None + """Der Status gibt an, wie der Wert zu interpretieren ist, z.B. in Berechnungen.""" - #: Eine Zusatzinformation zum Status, beispielsweise ein Grund für einen fehlenden Wert. statuszusatz: Optional["Messwertstatuszusatz"] = None + """Eine Zusatzinformation zum Status, beispielsweise ein Grund für einen fehlenden Wert.""" diff --git a/src/bo4e/com/zeitspanne.py b/src/bo4e/com/zeitspanne.py index d794a2499..73fc7b047 100644 --- a/src/bo4e/com/zeitspanne.py +++ b/src/bo4e/com/zeitspanne.py @@ -27,5 +27,7 @@ class Zeitspanne(COM): """ - start: Optional[pydantic.AwareDatetime] = None #: inklusiver Beginn - ende: Optional[pydantic.AwareDatetime] = None #: exklusives Ende + start: Optional[pydantic.AwareDatetime] = None + """inklusiver Beginn""" + ende: Optional[pydantic.AwareDatetime] = None + """exklusives Ende""" diff --git a/src/bo4e/com/zustaendigkeit.py b/src/bo4e/com/zustaendigkeit.py index 4447f18c2..fb836ef29 100644 --- a/src/bo4e/com/zustaendigkeit.py +++ b/src/bo4e/com/zustaendigkeit.py @@ -34,5 +34,7 @@ class Zustaendigkeit(COM): Hier kann eine thematische Zuordnung des Ansprechpartners bzw. der Person angegeben werden """ - position: Optional[str] = None #: Berufliche Rolle des Ansprechpartners/ der Person - abteilung: Optional[str] = None #: Abteilung, in der der Ansprechpartner/ die Person tätig ist + position: Optional[str] = None + """Berufliche Rolle des Ansprechpartners/ der Person""" + abteilung: Optional[str] = None + """Abteilung, in der der Ansprechpartner/ die Person tätig ist""" From 44af5037daa05bc11f931ea14d86daf0f863738c Mon Sep 17 00:00:00 2001 From: Leon Haffmans Date: Fri, 24 Jan 2025 16:24:54 +0100 Subject: [PATCH 2/4] Unify doc string style with `enum` --- src/bo4e/enum/abgabeart.py | 27 +- src/bo4e/enum/angebotsstatus.py | 27 +- src/bo4e/enum/anrede.py | 21 +- src/bo4e/enum/arithmetische_operation.py | 12 +- src/bo4e/enum/artikelid.py | 21 +- src/bo4e/enum/aufabschlagstyp.py | 6 +- src/bo4e/enum/aufabschlagsziel.py | 18 +- src/bo4e/enum/ausschreibungsportal.py | 30 +- src/bo4e/enum/ausschreibungsstatus.py | 12 +- src/bo4e/enum/ausschreibungstyp.py | 9 +- src/bo4e/enum/bdewartikelnummer.py | 136 ++++-- src/bo4e/enum/befestigungsart.py | 15 +- src/bo4e/enum/bemessungsgroesse.py | 36 +- src/bo4e/enum/bilanzierungsmethode.py | 15 +- src/bo4e/enum/dienstleistungstyp.py | 81 ++-- src/bo4e/enum/energierichtung.py | 6 +- src/bo4e/enum/erzeugungsart.py | 42 +- src/bo4e/enum/gasqualitaet.py | 6 +- src/bo4e/enum/gebiettyp.py | 27 +- src/bo4e/enum/geraeteklasse.py | 21 +- src/bo4e/enum/geraetetyp.py | 138 ++++-- src/bo4e/enum/geschaeftspartnerrolle.py | 15 +- src/bo4e/enum/gueltigkeitstyp.py | 8 +- src/bo4e/enum/kalkulationsmethode.py | 50 +- src/bo4e/enum/kontaktart.py | 15 +- src/bo4e/enum/kostenklasse.py | 15 +- src/bo4e/enum/kundengruppe.py | 105 +++-- src/bo4e/enum/kundengruppeka.py | 60 ++- src/bo4e/enum/kundentyp.py | 45 +- src/bo4e/enum/leistungstyp.py | 93 ++-- src/bo4e/enum/lokationstyp.py | 15 +- src/bo4e/enum/marktrolle.py | 39 +- src/bo4e/enum/medium.py | 12 +- src/bo4e/enum/mengeneinheit.py | 72 ++- src/bo4e/enum/mengenoperator.py | 9 +- src/bo4e/enum/messart.py | 9 +- src/bo4e/enum/messgroesse.py | 39 +- src/bo4e/enum/messpreistyp.py | 72 ++- src/bo4e/enum/messwerterfassung.py | 6 +- src/bo4e/enum/messwertstatus.py | 27 +- src/bo4e/enum/messwertstatuszusatz.py | 112 +++-- src/bo4e/enum/netzebene.py | 30 +- src/bo4e/enum/netznutzungrechnungsart.py | 6 +- src/bo4e/enum/netznutzungrechnungstyp.py | 27 +- src/bo4e/enum/oekolabel.py | 36 +- src/bo4e/enum/oekozertifikat.py | 51 +- src/bo4e/enum/organisationstyp.py | 12 +- src/bo4e/enum/preisgarantietyp.py | 12 +- src/bo4e/enum/preismodell.py | 6 +- src/bo4e/enum/preisstatus.py | 6 +- src/bo4e/enum/preistyp.py | 30 +- src/bo4e/enum/rechnungslegung.py | 15 +- src/bo4e/enum/rechnungsstatus.py | 15 +- src/bo4e/enum/rechnungstyp.py | 16 +- src/bo4e/enum/regionskriteriumtyp.py | 96 ++-- src/bo4e/enum/registeranzahl.py | 9 +- src/bo4e/enum/rollencodetyp.py | 9 +- src/bo4e/enum/steuerkennzeichen.py | 27 +- src/bo4e/enum/tarifkalkulationsmethode.py | 15 +- src/bo4e/enum/tarifmerkmal.py | 27 +- src/bo4e/enum/tarifregionskriterium.py | 15 +- src/bo4e/enum/tariftyp.py | 12 +- src/bo4e/enum/tarifzeit.py | 9 +- src/bo4e/enum/themengebiet.py | 182 +++++--- src/bo4e/enum/titel.py | 9 +- src/bo4e/enum/verbrauchsart.py | 15 +- src/bo4e/enum/vertragsart.py | 15 +- src/bo4e/enum/vertragsform.py | 9 +- src/bo4e/enum/vertragsstatus.py | 27 +- src/bo4e/enum/verwendungszweck.py | 17 +- src/bo4e/enum/voraussetzungen.py | 103 ++-- src/bo4e/enum/waehrungscode.py | 546 ++++++++++++++-------- src/bo4e/enum/waehrungseinheit.py | 6 +- src/bo4e/enum/waermenutzung.py | 9 +- src/bo4e/enum/wertermittlungsverfahren.py | 6 +- src/bo4e/enum/zaehlerauspraegung.py | 6 +- src/bo4e/enum/zaehlergroesse.py | 63 ++- src/bo4e/enum/zaehlertyp.py | 34 +- src/bo4e/enum/zaehlertypspezifikation.py | 15 +- 79 files changed, 2033 insertions(+), 1034 deletions(-) diff --git a/src/bo4e/enum/abgabeart.py b/src/bo4e/enum/abgabeart.py index d947b4427..56ba2266f 100644 --- a/src/bo4e/enum/abgabeart.py +++ b/src/bo4e/enum/abgabeart.py @@ -7,12 +7,21 @@ class AbgabeArt(StrEnum): Art der Konzessionsabgabe """ - KAS = "KAS" #: KAS: für alle konzessionsvertraglichen Sonderregelungen, die nicht in die Systematik der KAV eingegliedert sind - SA = "SA" #: SA: Sondervertragskunden 1 kV, Preis nach § 2 (3) (für Strom 0,11 ct/kWh und für Gas 0,03 ct/kWh) - SAS = "SAS" #: SAS: Kennzeichnung, dass ein abweichender Preis für Sondervertragskunden vorliegt - TA = "TA" #: TA: Tarifkunden, für Strom § 2. (2) 1b HT bzw.ET(hohe KA) und für Gas § 2 (2) 2b - TAS = "TAS" #: TAS: Kennzeichnung, dass ein abweichender Preis für Tarifkunden vorliegt - TK = "TK" #: TK: für Gas nach KAV § 2 (2) 2a bei ausschließlicher Nutzung zum Kochen und Warmwassererzeugung - TKS = "TKS" #: TKS: Kennzeichnung, wenn nach KAV § 2 (2) 2a ein anderen Preis zu verwenden ist - TS = "TS" #: TS: für Strom mit Schwachlast § 2. (2) 1a NT(niedrige KA, 0,61 ct/kWh) - TSS = "TSS" #: TSS: Kennzeichnung, dass ein abweichender Preis für Schwachlast angewendet wird + KAS = "KAS" + """KAS: für alle konzessionsvertraglichen Sonderregelungen, die nicht in die Systematik der KAV eingegliedert sind""" + SA = "SA" + """SA: Sondervertragskunden 1 kV, Preis nach § 2 (3) (für Strom 0,11 ct/kWh und für Gas 0,03 ct/kWh)""" + SAS = "SAS" + """SAS: Kennzeichnung, dass ein abweichender Preis für Sondervertragskunden vorliegt""" + TA = "TA" + """TA: Tarifkunden, für Strom § 2. (2) 1b HT bzw.ET(hohe KA) und für Gas § 2 (2) 2b""" + TAS = "TAS" + """TAS: Kennzeichnung, dass ein abweichender Preis für Tarifkunden vorliegt""" + TK = "TK" + """TK: für Gas nach KAV § 2 (2) 2a bei ausschließlicher Nutzung zum Kochen und Warmwassererzeugung""" + TKS = "TKS" + """TKS: Kennzeichnung, wenn nach KAV § 2 (2) 2a ein anderen Preis zu verwenden ist""" + TS = "TS" + """TS: für Strom mit Schwachlast § 2. (2) 1a NT(niedrige KA, 0,61 ct/kWh)""" + TSS = "TSS" + """TSS: Kennzeichnung, dass ein abweichender Preis für Schwachlast angewendet wird""" diff --git a/src/bo4e/enum/angebotsstatus.py b/src/bo4e/enum/angebotsstatus.py index db6b315df..6867ecfa9 100644 --- a/src/bo4e/enum/angebotsstatus.py +++ b/src/bo4e/enum/angebotsstatus.py @@ -7,12 +7,21 @@ class Angebotsstatus(StrEnum): Gibt den Status eines Angebotes an. """ - KONZEPTION = "KONZEPTION" #: Konzeption - UNVERBINDLICH = "UNVERBINDLICH" #: unverbindlich - VERBINDLICH = "VERBINDLICH" #: verbindlich - BEAUFTRAGT = "BEAUFTRAGT" #: beauftragt - UNGUELTIG = "UNGUELTIG" #: ungültig - ABGELEHNT = "ABGELEHNT" #: abgelehnt - NACHGEFASST = "NACHGEFASST" #: nachgefasst - AUSSTEHEND = "AUSSTEHEND" #: ausstehend - ERLEDIGT = "ERLEDIGT" #: erledigt + KONZEPTION = "KONZEPTION" + """Konzeption""" + UNVERBINDLICH = "UNVERBINDLICH" + """unverbindlich""" + VERBINDLICH = "VERBINDLICH" + """verbindlich""" + BEAUFTRAGT = "BEAUFTRAGT" + """beauftragt""" + UNGUELTIG = "UNGUELTIG" + """ungültig""" + ABGELEHNT = "ABGELEHNT" + """abgelehnt""" + NACHGEFASST = "NACHGEFASST" + """nachgefasst""" + AUSSTEHEND = "AUSSTEHEND" + """ausstehend""" + ERLEDIGT = "ERLEDIGT" + """erledigt""" diff --git a/src/bo4e/enum/anrede.py b/src/bo4e/enum/anrede.py index aabf0f73a..d080beb19 100644 --- a/src/bo4e/enum/anrede.py +++ b/src/bo4e/enum/anrede.py @@ -7,10 +7,17 @@ class Anrede(StrEnum): Übersicht möglicher Anreden, z.B. eines Geschäftspartners. """ - HERR = "HERR" #: "Herr - FRAU = "FRAU" #: Frau - EHELEUTE = "EHELEUTE" #: Eheleute - FIRMA = "FIRMA" #: Firma - FAMILIE = "FAMILIE" #: Familie - ERBENGEMEINSCHAFT = "ERBENGEMEINSCHAFT" #: Erbengemeinschaft - GRUNDSTUECKSGEMEINSCHAFT = "GRUNDSTUECKSGEMEINSCHAFT" #: Grundstücksgemeinschaft + HERR = "HERR" + """"Herr""" + FRAU = "FRAU" + """Frau""" + EHELEUTE = "EHELEUTE" + """Eheleute""" + FIRMA = "FIRMA" + """Firma""" + FAMILIE = "FAMILIE" + """Familie""" + ERBENGEMEINSCHAFT = "ERBENGEMEINSCHAFT" + """Erbengemeinschaft""" + GRUNDSTUECKSGEMEINSCHAFT = "GRUNDSTUECKSGEMEINSCHAFT" + """Grundstücksgemeinschaft""" diff --git a/src/bo4e/enum/arithmetische_operation.py b/src/bo4e/enum/arithmetische_operation.py index 80fd030bc..08512d178 100644 --- a/src/bo4e/enum/arithmetische_operation.py +++ b/src/bo4e/enum/arithmetische_operation.py @@ -7,7 +7,11 @@ class ArithmetischeOperation(StrEnum): Mit dieser Aufzählung können arithmetische Operationen festgelegt werden. """ - ADDITION = "ADDITION" #: Es wird addiert - SUBTRAKTION = "SUBTRAKTION" #: Es wird subtrahiert - MULTIPLIKATION = "MULTIPLIKATION" #: Es wird multipliziert - DIVISION = "DIVISION" #: Es wird dividiert + ADDITION = "ADDITION" + """Es wird addiert""" + SUBTRAKTION = "SUBTRAKTION" + """Es wird subtrahiert""" + MULTIPLIKATION = "MULTIPLIKATION" + """Es wird multipliziert""" + DIVISION = "DIVISION" + """Es wird dividiert""" diff --git a/src/bo4e/enum/artikelid.py b/src/bo4e/enum/artikelid.py index 7c340941d..0e330f8c5 100644 --- a/src/bo4e/enum/artikelid.py +++ b/src/bo4e/enum/artikelid.py @@ -10,14 +10,19 @@ class ArtikelId(StrEnum): # von allen enums ist das hier wohl das mit den unpassendsten Namen ;) - ARTIKEL_2017001 = "2-01-7-001" #: Unterbrechung der Anschlussnutzung in der regulären Arbeitszeit (€/Auftrag) - ARTIKEL_2017002 = "2-01-7-002" #: Wiederherstellung der Anschlussnutzung in der regulären Arbeitszeit (€/Auftrag) - ARTIKEL_2017003 = "2-01-7-003" #: Erfolglose Unterbrechung (€/Auftrag) - #: Stornierung eines Auftrages zur Unterbrechung der Anschlussnutzung bis zum Vortag der Sperrung (€/Auftrag) + ARTIKEL_2017001 = "2-01-7-001" + """Unterbrechung der Anschlussnutzung in der regulären Arbeitszeit (€/Auftrag)""" + ARTIKEL_2017002 = "2-01-7-002" + """Wiederherstellung der Anschlussnutzung in der regulären Arbeitszeit (€/Auftrag)""" + ARTIKEL_2017003 = "2-01-7-003" + """Erfolglose Unterbrechung (€/Auftrag)""" ARTIKEL_2017004 = "2-01-7-004" - #: Stornierung eines Auftrages zur Unterbrechung der Anschlussnutzung am Tag der Sperrung (€/Auftrag) + """Stornierung eines Auftrages zur Unterbrechung der Anschlussnutzung bis zum Vortag der Sperrung (€/Auftrag)""" ARTIKEL_2017005 = "2-01-7-005" - #: Wiederherstellung der Anschlussnutzung außerhalb der regulären Arbeitszeit (€/Auftrag) + """Stornierung eines Auftrages zur Unterbrechung der Anschlussnutzung am Tag der Sperrung (€/Auftrag)""" ARTIKEL_2017006 = "2-01-7-006" - ARTIKEL_2020001 = "2-02-0-001" #: Verzugskosten pauschal (€/Fall) - ARTIKEL_2020002 = "2-02-0-002" #: Verzugskosten variabel (€) + """Wiederherstellung der Anschlussnutzung außerhalb der regulären Arbeitszeit (€/Auftrag)""" + ARTIKEL_2020001 = "2-02-0-001" + """Verzugskosten pauschal (€/Fall)""" + ARTIKEL_2020002 = "2-02-0-002" + """Verzugskosten variabel (€)""" diff --git a/src/bo4e/enum/aufabschlagstyp.py b/src/bo4e/enum/aufabschlagstyp.py index c6ab170af..48af0dbfd 100644 --- a/src/bo4e/enum/aufabschlagstyp.py +++ b/src/bo4e/enum/aufabschlagstyp.py @@ -7,5 +7,7 @@ class AufAbschlagstyp(StrEnum): Festlegung, ob der Auf- oder Abschlag mit relativen oder absoluten Werten erfolgt. """ - RELATIV = "RELATIV" #: prozentualer Auf-/Abschlag - ABSOLUT = "ABSOLUT" #: Absoluter Auf-/Abschlag + RELATIV = "RELATIV" + """prozentualer Auf-/Abschlag""" + ABSOLUT = "ABSOLUT" + """Absoluter Auf-/Abschlag""" diff --git a/src/bo4e/enum/aufabschlagsziel.py b/src/bo4e/enum/aufabschlagsziel.py index 2bb29ebe2..96bf0c4ff 100644 --- a/src/bo4e/enum/aufabschlagsziel.py +++ b/src/bo4e/enum/aufabschlagsziel.py @@ -7,9 +7,15 @@ class AufAbschlagsziel(StrEnum): Der Preis, auf den sich ein Auf- oder Abschlag bezieht. """ - ARBEITSPREIS_EINTARIF = "ARBEITSPREIS_EINTARIF" #: Auf-/Abschlag auf den Arbeitspreis Eintarif - ARBEITSPREIS_HT = "ARBEITSPREIS_HT" #: Auf-/Abschlag auf den Arbeitspreis HT - ARBEITSPREIS_NT = "ARBEITSPREIS_NT" #: Auf-/Abschlag auf den Arbeitspreis NT - ARBEITSPREIS_HT_NT = "ARBEITSPREIS_HT_NT" #: Auf-/Abschlag auf den Arbeitspreis HT und NT - GRUNDPREIS = "GRUNDPREIS" #: Auf-/Abschlag auf den Grundpreis - GESAMTPREIS = "GESAMTPREIS" #: Auf-/Abschlag auf den Gesamtpreis + ARBEITSPREIS_EINTARIF = "ARBEITSPREIS_EINTARIF" + """Auf-/Abschlag auf den Arbeitspreis Eintarif""" + ARBEITSPREIS_HT = "ARBEITSPREIS_HT" + """Auf-/Abschlag auf den Arbeitspreis HT""" + ARBEITSPREIS_NT = "ARBEITSPREIS_NT" + """Auf-/Abschlag auf den Arbeitspreis NT""" + ARBEITSPREIS_HT_NT = "ARBEITSPREIS_HT_NT" + """Auf-/Abschlag auf den Arbeitspreis HT und NT""" + GRUNDPREIS = "GRUNDPREIS" + """Auf-/Abschlag auf den Grundpreis""" + GESAMTPREIS = "GESAMTPREIS" + """Auf-/Abschlag auf den Gesamtpreis""" diff --git a/src/bo4e/enum/ausschreibungsportal.py b/src/bo4e/enum/ausschreibungsportal.py index bf0681885..39371d3e2 100644 --- a/src/bo4e/enum/ausschreibungsportal.py +++ b/src/bo4e/enum/ausschreibungsportal.py @@ -7,13 +7,23 @@ class Ausschreibungsportal(StrEnum): Aufzählung der unterstützten Ausschreibungsportale. """ - ENPORTAL = "ENPORTAL" #: enPORTAL - ENERGIE_AGENTUR = "ENERGIE_AGENTUR" #: EnergieAgentur.NRW - BMWI = "BMWI" #: BMWI-Ausschreibungen - ENERGIE_HANDELSPLATZ = "ENERGIE_HANDELSPLATZ" #: energie-handelsplatz.de - BUND = "BUND" #: BUND.DE - VERA_ONLINE = "VERA_ONLINE" #: vera_online.de - ISPEX = "ISPEX" #: ispex.de - ENERGIEMARKTPLATZ = "ENERGIEMARKTPLATZ" #: energiemarktplatz.de - EVERGABE = "EVERGABE" #: evergabe.de - DTAD = "DTAD" #: dtad.de + ENPORTAL = "ENPORTAL" + """enPORTAL""" + ENERGIE_AGENTUR = "ENERGIE_AGENTUR" + """EnergieAgentur.NRW""" + BMWI = "BMWI" + """BMWI-Ausschreibungen""" + ENERGIE_HANDELSPLATZ = "ENERGIE_HANDELSPLATZ" + """energie-handelsplatz.de""" + BUND = "BUND" + """BUND.DE""" + VERA_ONLINE = "VERA_ONLINE" + """vera_online.de""" + ISPEX = "ISPEX" + """ispex.de""" + ENERGIEMARKTPLATZ = "ENERGIEMARKTPLATZ" + """energiemarktplatz.de""" + EVERGABE = "EVERGABE" + """evergabe.de""" + DTAD = "DTAD" + """dtad.de""" diff --git a/src/bo4e/enum/ausschreibungsstatus.py b/src/bo4e/enum/ausschreibungsstatus.py index 375d675ae..5ae8237c1 100644 --- a/src/bo4e/enum/ausschreibungsstatus.py +++ b/src/bo4e/enum/ausschreibungsstatus.py @@ -7,7 +7,11 @@ class Ausschreibungsstatus(StrEnum): Bezeichnungen für die Ausschreibungsphasen """ - PHASE1 = "PHASE1" #: Phase1: Teilnahmewettbewerb - PHASE2 = "PHASE2" #: Phase2: Angebotsphase - PHASE3 = "PHASE3" #: Phase3: Verhandlungsphase - PHASE4 = "PHASE4" #: Phase4: Zuschlagserteilung + PHASE1 = "PHASE1" + """Phase1: Teilnahmewettbewerb""" + PHASE2 = "PHASE2" + """Phase2: Angebotsphase""" + PHASE3 = "PHASE3" + """Phase3: Verhandlungsphase""" + PHASE4 = "PHASE4" + """Phase4: Zuschlagserteilung""" diff --git a/src/bo4e/enum/ausschreibungstyp.py b/src/bo4e/enum/ausschreibungstyp.py index 526cec0c7..838d4ddd9 100644 --- a/src/bo4e/enum/ausschreibungstyp.py +++ b/src/bo4e/enum/ausschreibungstyp.py @@ -7,6 +7,9 @@ class Ausschreibungstyp(StrEnum): Aufzählung für die Typisierung von Ausschreibungen. """ - PRIVATRECHTLICH = "PRIVATRECHTLICH" #: privat-rechtlich - OEFFENTLICHRECHTLICH = "OEFFENTLICHRECHTLICH" #: öffentlich-rechtlich - EUROPAWEIT = "EUROPAWEIT" #: europaweit + PRIVATRECHTLICH = "PRIVATRECHTLICH" + """privat-rechtlich""" + OEFFENTLICHRECHTLICH = "OEFFENTLICHRECHTLICH" + """öffentlich-rechtlich""" + EUROPAWEIT = "EUROPAWEIT" + """europaweit""" diff --git a/src/bo4e/enum/bdewartikelnummer.py b/src/bo4e/enum/bdewartikelnummer.py index 74969025d..5701df769 100644 --- a/src/bo4e/enum/bdewartikelnummer.py +++ b/src/bo4e/enum/bdewartikelnummer.py @@ -7,51 +7,95 @@ class BDEWArtikelnummer(StrEnum): BDEW Artikelnummern """ - LEISTUNG = "LEISTUNG" #: Leistung - LEISTUNG_PAUSCHAL = "LEISTUNG_PAUSCHAL" #: Leistung pauschal - GRUNDPREIS = "GRUNDPREIS" #: Grundpreis - REGELENERGIE_ARBEIT = "REGELENERGIE_ARBEIT" #: Regelenergie Arbeit - REGELENERGIE_LEISTUNG = "REGELENERGIE_LEISTUNG" #: Regelenergie Leistung - NOTSTROMLIEFERUNG_ARBEIT = "NOTSTROMLIEFERUNG_ARBEIT" #: Notstromlieferung Arbeit - NOTSTROMLIEFERUNG_LEISTUNG = "NOTSTROMLIEFERUNG_LEISTUNG" #: Notstromlieferung Leistung - RESERVENETZKAPAZITAET = "RESERVENETZKAPAZITAET" #: Reservenetzkapazität - RESERVELEISTUNG = "RESERVELEISTUNG" #: Reserveleistung - ZUSAETZLICHE_ABLESUNG = "ZUSAETZLICHE_ABLESUNG" #: Zusätzliche Ablesung - PRUEFGEBUEHREN_AUSSERPLANMAESSIG = "PRUEFGEBUEHREN_AUSSERPLANMAESSIG" #: Prüfgebühren (außerplanmäßig) - WIRKARBEIT = "WIRKARBEIT" #: Wirkarbeit - #: singulär genutzte Betriebsmittel (z. B. Trafomiete, Leitungen) + LEISTUNG = "LEISTUNG" + """Leistung""" + LEISTUNG_PAUSCHAL = "LEISTUNG_PAUSCHAL" + """Leistung pauschal""" + GRUNDPREIS = "GRUNDPREIS" + """Grundpreis""" + REGELENERGIE_ARBEIT = "REGELENERGIE_ARBEIT" + """Regelenergie Arbeit""" + REGELENERGIE_LEISTUNG = "REGELENERGIE_LEISTUNG" + """Regelenergie Leistung""" + NOTSTROMLIEFERUNG_ARBEIT = "NOTSTROMLIEFERUNG_ARBEIT" + """Notstromlieferung Arbeit""" + NOTSTROMLIEFERUNG_LEISTUNG = "NOTSTROMLIEFERUNG_LEISTUNG" + """Notstromlieferung Leistung""" + RESERVENETZKAPAZITAET = "RESERVENETZKAPAZITAET" + """Reservenetzkapazität""" + RESERVELEISTUNG = "RESERVELEISTUNG" + """Reserveleistung""" + ZUSAETZLICHE_ABLESUNG = "ZUSAETZLICHE_ABLESUNG" + """Zusätzliche Ablesung""" + PRUEFGEBUEHREN_AUSSERPLANMAESSIG = "PRUEFGEBUEHREN_AUSSERPLANMAESSIG" + """Prüfgebühren (außerplanmäßig)""" + WIRKARBEIT = "WIRKARBEIT" + """Wirkarbeit""" SINGULAER_GENUTZTE_BETRIEBSMITTEL = "SINGULAER_GENUTZTE_BETRIEBSMITTEL" - ABGABE_KWKG = "ABGABE_KWKG" #: Abgabe KWKG - ABSCHLAG = "ABSCHLAG" #: Abschlag - KONZESSIONSABGABE = "KONZESSIONSABGABE" #: Konzessionsabgabe - ENTGELT_FERNAUSLESUNG = "ENTGELT_FERNAUSLESUNG" #: Entgelt für Fernauslesung - UNTERMESSUNG = "UNTERMESSUNG" #: Untermessung - BLINDMEHRARBEIT = "BLINDMEHRARBEIT" #: Blindmehrarbeit - ENTGELT_ABRECHNUNG = "ENTGELT_ABRECHNUNG" #: Entgelt für Abrechnung - SPERRKOSTEN = "SPERRKOSTEN" #: Sperrkosten - ENTSPERRKOSTEN = "ENTSPERRKOSTEN" #: Entsperrkosten - MAHNKOSTEN = "MAHNKOSTEN" #: Mahnkosten - MEHR_MINDERMENGEN = "MEHR_MINDERMENGEN" #: Mehr- und Mindermenge - INKASSOKOSTEN = "INKASSOKOSTEN" #: Inkassokosten - BLINDMEHRLEISTUNG = "BLINDMEHRLEISTUNG" #: Blindmehrleistung - ENTGELT_MESSUNG_ABLESUNG = "ENTGELT_MESSUNG_ABLESUNG" #: Entgelt für Messung und Ablesung - #: Entgelt für Einbau, Betrieb und Wartung der Messtechnik + """singulär genutzte Betriebsmittel (z. B. Trafomiete, Leitungen)""" + ABGABE_KWKG = "ABGABE_KWKG" + """Abgabe KWKG""" + ABSCHLAG = "ABSCHLAG" + """Abschlag""" + KONZESSIONSABGABE = "KONZESSIONSABGABE" + """Konzessionsabgabe""" + ENTGELT_FERNAUSLESUNG = "ENTGELT_FERNAUSLESUNG" + """Entgelt für Fernauslesung""" + UNTERMESSUNG = "UNTERMESSUNG" + """Untermessung""" + BLINDMEHRARBEIT = "BLINDMEHRARBEIT" + """Blindmehrarbeit""" + ENTGELT_ABRECHNUNG = "ENTGELT_ABRECHNUNG" + """Entgelt für Abrechnung""" + SPERRKOSTEN = "SPERRKOSTEN" + """Sperrkosten""" + ENTSPERRKOSTEN = "ENTSPERRKOSTEN" + """Entsperrkosten""" + MAHNKOSTEN = "MAHNKOSTEN" + """Mahnkosten""" + MEHR_MINDERMENGEN = "MEHR_MINDERMENGEN" + """Mehr- und Mindermenge""" + INKASSOKOSTEN = "INKASSOKOSTEN" + """Inkassokosten""" + BLINDMEHRLEISTUNG = "BLINDMEHRLEISTUNG" + """Blindmehrleistung""" + ENTGELT_MESSUNG_ABLESUNG = "ENTGELT_MESSUNG_ABLESUNG" + """Entgelt für Messung und Ablesung""" ENTGELT_EINBAU_BETRIEB_WARTUNG_MESSTECHNIK = "ENTGELT_EINBAU_BETRIEB_WARTUNG_MESSTECHNIK" - AUSGLEICHSENERGIE = "AUSGLEICHSENERGIE" #: Ausgleichsenergie - ZAEHLEINRICHTUNG = "ZAEHLEINRICHTUNG" #: Zähleinrichtung - WANDLER_MENGENUMWERTER = "WANDLER_MENGENUMWERTER" #: Wandler/Mengenumwerter - KOMMUNIKATIONSEINRICHTUNG = "KOMMUNIKATIONSEINRICHTUNG" #: Kommunikationseinrichtung - TECHNISCHE_STEUEREINRICHTUNG = "TECHNISCHE_STEUEREINRICHTUNG" #: Technische Steuereinrichtung - PARAGRAF_19_STROM_NEV_UMLAGE = "PARAGRAF_19_STROM_NEV_UMLAGE" #: § 19 StromNEV Umlage - BEFESTIGUNGSEINRICHTUNG = "BEFESTIGUNGSEINRICHTUNG" #: Befestigungseinrichtung (z. B. Zählertafel) - OFFSHORE_HAFTUNGSUMLAGE = "OFFSHORE_HAFTUNGSUMLAGE" #: Offshore-Haftungsumlage - FIXE_ARBEITSENTGELTKOMPONENTE = "FIXE_ARBEITSENTGELTKOMPONENTE" #: Fixe Arbeitsentgeltkomponente - FIXE_LEISTUNGSENTGELTKOMPONENTE = "FIXE_LEISTUNGSENTGELTKOMPONENTE" #: Fixe Leistungsentgeltkomponente - UMLAGE_ABSCHALTBARE_LASTEN = "UMLAGE_ABSCHALTBARE_LASTEN" #: Umlage abschaltbare Lasten - MEHRMENGE = "MEHRMENGE" #: Mehrmenge - MINDERMENGE = "MINDERMENGE" #: Mindermenge - ENERGIESTEUER = "ENERGIESTEUER" #: Energiesteuer - SMARTMETER_GATEWAY = "SMARTMETER_GATEWAY" #: Smartmeter-Gateway - STEUERBOX = "STEUERBOX" #: Steuerbox - MSB_INKL_MESSUNG = "MSB_INKL_MESSUNG" #: Messtellenbetrieb inklusive Messung - AUSGLEICHSENERGIE_UNTERDECKUNG = "AUSGLEICHSENERGIE_UNTERDECKUNG" #: AusgleichsenergieUnterdeckung + """Entgelt für Einbau, Betrieb und Wartung der Messtechnik""" + AUSGLEICHSENERGIE = "AUSGLEICHSENERGIE" + """Ausgleichsenergie""" + ZAEHLEINRICHTUNG = "ZAEHLEINRICHTUNG" + """Zähleinrichtung""" + WANDLER_MENGENUMWERTER = "WANDLER_MENGENUMWERTER" + """Wandler/Mengenumwerter""" + KOMMUNIKATIONSEINRICHTUNG = "KOMMUNIKATIONSEINRICHTUNG" + """Kommunikationseinrichtung""" + TECHNISCHE_STEUEREINRICHTUNG = "TECHNISCHE_STEUEREINRICHTUNG" + """Technische Steuereinrichtung""" + PARAGRAF_19_STROM_NEV_UMLAGE = "PARAGRAF_19_STROM_NEV_UMLAGE" + """§ 19 StromNEV Umlage""" + BEFESTIGUNGSEINRICHTUNG = "BEFESTIGUNGSEINRICHTUNG" + """Befestigungseinrichtung (z. B. Zählertafel)""" + OFFSHORE_HAFTUNGSUMLAGE = "OFFSHORE_HAFTUNGSUMLAGE" + """Offshore-Haftungsumlage""" + FIXE_ARBEITSENTGELTKOMPONENTE = "FIXE_ARBEITSENTGELTKOMPONENTE" + """Fixe Arbeitsentgeltkomponente""" + FIXE_LEISTUNGSENTGELTKOMPONENTE = "FIXE_LEISTUNGSENTGELTKOMPONENTE" + """Fixe Leistungsentgeltkomponente""" + UMLAGE_ABSCHALTBARE_LASTEN = "UMLAGE_ABSCHALTBARE_LASTEN" + """Umlage abschaltbare Lasten""" + MEHRMENGE = "MEHRMENGE" + """Mehrmenge""" + MINDERMENGE = "MINDERMENGE" + """Mindermenge""" + ENERGIESTEUER = "ENERGIESTEUER" + """Energiesteuer""" + SMARTMETER_GATEWAY = "SMARTMETER_GATEWAY" + """Smartmeter-Gateway""" + STEUERBOX = "STEUERBOX" + """Steuerbox""" + MSB_INKL_MESSUNG = "MSB_INKL_MESSUNG" + """Messtellenbetrieb inklusive Messung""" + AUSGLEICHSENERGIE_UNTERDECKUNG = "AUSGLEICHSENERGIE_UNTERDECKUNG" + """AusgleichsenergieUnterdeckung""" diff --git a/src/bo4e/enum/befestigungsart.py b/src/bo4e/enum/befestigungsart.py index bf968284f..37798af1d 100644 --- a/src/bo4e/enum/befestigungsart.py +++ b/src/bo4e/enum/befestigungsart.py @@ -7,8 +7,13 @@ class Befestigungsart(StrEnum): Befestigungsart von Zählern """ - STECKTECHNIK = "STECKTECHNIK" #: STECKTECHNIK - DREIPUNKT = "DREIPUNKT" #: DREIPUNKT - HUTSCHIENE = "HUTSCHIENE" #: HUTSCHIENE - EINSTUTZEN = "EINSTUTZEN" #: EINSTUTZEN - ZWEISTUTZEN = "ZWEISTUTZEN" #: ZWEISTUTZEN + STECKTECHNIK = "STECKTECHNIK" + """STECKTECHNIK""" + DREIPUNKT = "DREIPUNKT" + """DREIPUNKT""" + HUTSCHIENE = "HUTSCHIENE" + """HUTSCHIENE""" + EINSTUTZEN = "EINSTUTZEN" + """EINSTUTZEN""" + ZWEISTUTZEN = "ZWEISTUTZEN" + """ZWEISTUTZEN""" diff --git a/src/bo4e/enum/bemessungsgroesse.py b/src/bo4e/enum/bemessungsgroesse.py index 8271ed8d9..d2f37f489 100644 --- a/src/bo4e/enum/bemessungsgroesse.py +++ b/src/bo4e/enum/bemessungsgroesse.py @@ -7,15 +7,27 @@ class Bemessungsgroesse(StrEnum): Zur Abbildung von Messgrössen und zur Verwendung in energiewirtschaftlichen Berechnungen. """ - WIRKARBEIT_EL = "WIRKARBEIT_EL" #: elektrische Wirkarbeit - LEISTUNG_EL = "LEISTUNG_EL" #: elektrische Leistung - BLINDARBEIT_KAP = "BLINDARBEIT_KAP" #: Blindarbeit kapazitiv - BLINDARBEIT_IND = "BLINDARBEIT_IND" #: Blindarbeit induktiv - BLINDLEISTUNG_KAP = "BLINDLEISTUNG_KAP" #: Blindleistung kapazitiv - BLINDLEISTUNG_IND = "BLINDLEISTUNG_IND" #: Blindleistung induktiv - WIRKARBEIT_TH = "WIRKARBEIT_TH" #: thermische Wirkarbeit - LEISTUNG_TH = "LEISTUNG_TH" #: thermische Leistung - VOLUMEN = "VOLUMEN" #: Volumen - VOLUMENSTROM = "VOLUMENSTROM" #: Volumenstrom (Volumen/Zeit) - BENUTZUNGSDAUER = "BENUTZUNGSDAUER" #: Benutzungsdauer (Arbeit/Leistung) - ANZAHL = "ANZAHL" #: Darstellung einer Stückzahl + WIRKARBEIT_EL = "WIRKARBEIT_EL" + """elektrische Wirkarbeit""" + LEISTUNG_EL = "LEISTUNG_EL" + """elektrische Leistung""" + BLINDARBEIT_KAP = "BLINDARBEIT_KAP" + """Blindarbeit kapazitiv""" + BLINDARBEIT_IND = "BLINDARBEIT_IND" + """Blindarbeit induktiv""" + BLINDLEISTUNG_KAP = "BLINDLEISTUNG_KAP" + """Blindleistung kapazitiv""" + BLINDLEISTUNG_IND = "BLINDLEISTUNG_IND" + """Blindleistung induktiv""" + WIRKARBEIT_TH = "WIRKARBEIT_TH" + """thermische Wirkarbeit""" + LEISTUNG_TH = "LEISTUNG_TH" + """thermische Leistung""" + VOLUMEN = "VOLUMEN" + """Volumen""" + VOLUMENSTROM = "VOLUMENSTROM" + """Volumenstrom (Volumen/Zeit)""" + BENUTZUNGSDAUER = "BENUTZUNGSDAUER" + """Benutzungsdauer (Arbeit/Leistung)""" + ANZAHL = "ANZAHL" + """Darstellung einer Stückzahl""" diff --git a/src/bo4e/enum/bilanzierungsmethode.py b/src/bo4e/enum/bilanzierungsmethode.py index 21e2f0e5e..78f9e6c5f 100644 --- a/src/bo4e/enum/bilanzierungsmethode.py +++ b/src/bo4e/enum/bilanzierungsmethode.py @@ -7,8 +7,13 @@ class Bilanzierungsmethode(StrEnum): Mit dieser Aufzählung kann zwischen den Bilanzierungsmethoden bzw. -grundlagen unterschieden werden. """ - RLM = "RLM" #: Registrierende Leistungsmessung - SLP = "SLP" #: Standard Lastprofil - TLP_GEMEINSAM = "TLP_GEMEINSAM" #: TLP gemeinsame Messung - TLP_GETRENNT = "TLP_GETRENNT" #: TLP getrennte Messung - PAUSCHAL = "PAUSCHAL" #: Pauschale Betrachtung (Band) + RLM = "RLM" + """Registrierende Leistungsmessung""" + SLP = "SLP" + """Standard Lastprofil""" + TLP_GEMEINSAM = "TLP_GEMEINSAM" + """TLP gemeinsame Messung""" + TLP_GETRENNT = "TLP_GETRENNT" + """TLP getrennte Messung""" + PAUSCHAL = "PAUSCHAL" + """Pauschale Betrachtung (Band)""" diff --git a/src/bo4e/enum/dienstleistungstyp.py b/src/bo4e/enum/dienstleistungstyp.py index 1bc015dba..3217914fe 100644 --- a/src/bo4e/enum/dienstleistungstyp.py +++ b/src/bo4e/enum/dienstleistungstyp.py @@ -9,46 +9,73 @@ class Dienstleistungstyp(StrEnum): Auflistung möglicher abzurechnender Dienstleistungen. """ - DATENBEREITSTELLUNG_TAEGLICH = "DATENBEREITSTELLUNG_TAEGLICH" #: Datenbereitstellung täglich - DATENBEREITSTELLUNG_WOECHENTLICH = "DATENBEREITSTELLUNG_WOECHENTLICH" #: Datenbereitstellung wöchentlich - DATENBEREITSTELLUNG_MONATLICH = "DATENBEREITSTELLUNG_MONATLICH" #: Datenbereitstellung monatlich - DATENBEREITSTELLUNG_JAEHRLICH = "DATENBEREITSTELLUNG_JAEHRLICH" #: Datenbereitstellung jährlich + DATENBEREITSTELLUNG_TAEGLICH = "DATENBEREITSTELLUNG_TAEGLICH" + """Datenbereitstellung täglich""" + DATENBEREITSTELLUNG_WOECHENTLICH = "DATENBEREITSTELLUNG_WOECHENTLICH" + """Datenbereitstellung wöchentlich""" + DATENBEREITSTELLUNG_MONATLICH = "DATENBEREITSTELLUNG_MONATLICH" + """Datenbereitstellung monatlich""" + DATENBEREITSTELLUNG_JAEHRLICH = "DATENBEREITSTELLUNG_JAEHRLICH" + """Datenbereitstellung jährlich""" DATENBEREITSTELLUNG_HISTORISCHE_LG = "DATENBEREITSTELLUNG_HISTORISCHE_LG" # Datenbereitstellung historischer Lastgänge - DATENBEREITSTELLUNG_STUENDLICH = "DATENBEREITSTELLUNG_STUENDLICH" #: Datenbereitstellung stündlich + DATENBEREITSTELLUNG_STUENDLICH = "DATENBEREITSTELLUNG_STUENDLICH" + """Datenbereitstellung stündlich""" DATENBEREITSTELLUNG_VIERTELJAEHRLICH = "DATENBEREITSTELLUNG_VIERTELJAEHRLICH" # Datenbereitstellung vierteljährlich - DATENBEREITSTELLUNG_HALBJAEHRLICH = "DATENBEREITSTELLUNG_HALBJAEHRLICH" #: Datenbereitstellung halbjährlich + DATENBEREITSTELLUNG_HALBJAEHRLICH = "DATENBEREITSTELLUNG_HALBJAEHRLICH" + """Datenbereitstellung halbjährlich""" DATENBEREITSTELLUNG_MONATLICH_ZUSAETZLICH = "DATENBEREITSTELLUNG_MONATLICH_ZUSAETZLICH" # Datenbereitstellung monatlich zusätzlich - DATENBEREITSTELLUNG_EINMALIG = "DATENBEREITSTELLUNG_EINMALIG" #: Datenbereitstellung einmalig + DATENBEREITSTELLUNG_EINMALIG = "DATENBEREITSTELLUNG_EINMALIG" + """Datenbereitstellung einmalig""" AUSLESUNG_2X_TAEGLICH_FERNAUSLESUNG = "AUSLESUNG_2X_TAEGLICH_FERNAUSLESUNG" # Auslesung 2x täglich mittels Fernauslesung - AUSLESUNG_TAEGLICH_FERNAUSLESUNG = "AUSLESUNG_TAEGLICH_FERNAUSLESUNG" #: Auslesung täglich mittels Fernauslesung - AUSLESUNG_MANUELL_MSB = "AUSLESUNG_MANUELL_MSB" #: Auslesung, manuell vom Messstellenbetreiber vorgenommen + AUSLESUNG_TAEGLICH_FERNAUSLESUNG = "AUSLESUNG_TAEGLICH_FERNAUSLESUNG" + """Auslesung täglich mittels Fernauslesung""" + AUSLESUNG_MANUELL_MSB = "AUSLESUNG_MANUELL_MSB" + """Auslesung, manuell vom Messstellenbetreiber vorgenommen""" AUSLESUNG_MONATLICH_FERNAUSLESUNG = "AUSLESUNG_MONATLICH_FERNAUSLESUNG" # Auslesung monatlich bei mittels Fernauslesung AUSLESUNG_JAEHRLICH_FERNAUSLESUNG = "AUSLESUNG_JAEHRLICH_FERNAUSLESUNG" # Auslesung jährlich bei SLP mittels Fernauslesung - AUSLESUNG_MDE = "AUSLESUNG_MDE" #: Auslesung mit mobiler Daten Erfassung (MDE) - ABLESUNG_MONATLICH = "ABLESUNG_MONATLICH" #: Ablesung monatlich - ABLESUNG_VIERTELJAEHRLICH = "ABLESUNG_VIERTELJAEHRLICH" #: Ablesung vierteljährlich - ABLESUNG_HALBJAEHRLICH = "ABLESUNG_HALBJAEHRLICH" #: Ablesung halbjährlich - ABLESUNG_JAEHRLICH = "ABLESUNG_JAEHRLICH" #: Ablesung jährlich - AUSLESUNG_FERNAUSLESUNG = "AUSLESUNG_FERNAUSLESUNG" #: Auslesung mittels Fernauslesung - ABLESUNG_ZUSAETZLICH_MSB = "ABLESUNG_ZUSAETZLICH_MSB" #: Ablesung, zusätzlich vom Messstellenbetreiber vorgenommen - ABLESUNG_ZUSAETZLICH_KUNDE = "ABLESUNG_ZUSAETZLICH_KUNDE" #: Ablesung SLP, zusätzlich vom Kunden vorgenommen + AUSLESUNG_MDE = "AUSLESUNG_MDE" + """Auslesung mit mobiler Daten Erfassung (MDE)""" + ABLESUNG_MONATLICH = "ABLESUNG_MONATLICH" + """Ablesung monatlich""" + ABLESUNG_VIERTELJAEHRLICH = "ABLESUNG_VIERTELJAEHRLICH" + """Ablesung vierteljährlich""" + ABLESUNG_HALBJAEHRLICH = "ABLESUNG_HALBJAEHRLICH" + """Ablesung halbjährlich""" + ABLESUNG_JAEHRLICH = "ABLESUNG_JAEHRLICH" + """Ablesung jährlich""" + AUSLESUNG_FERNAUSLESUNG = "AUSLESUNG_FERNAUSLESUNG" + """Auslesung mittels Fernauslesung""" + ABLESUNG_ZUSAETZLICH_MSB = "ABLESUNG_ZUSAETZLICH_MSB" + """Ablesung, zusätzlich vom Messstellenbetreiber vorgenommen""" + ABLESUNG_ZUSAETZLICH_KUNDE = "ABLESUNG_ZUSAETZLICH_KUNDE" + """Ablesung SLP, zusätzlich vom Kunden vorgenommen""" AUSLESUNG_FERNAUSLESUNG_ZUSAETZLICH_MSB = "AUSLESUNG_FERNAUSLESUNG_ZUSAETZLICH_MSB" # Auslesung, mittels Fernauslesung, zusätzlich vom Messstellenbetreiber vorgenommen - AUSLESUNG_MOATLICH_FERNAUSLESUNG = "AUSLESUNG_MOATLICH_FERNAUSLESUNG" #: Auslesung monatlich mittels Fernauslesung + AUSLESUNG_MOATLICH_FERNAUSLESUNG = "AUSLESUNG_MOATLICH_FERNAUSLESUNG" + """Auslesung monatlich mittels Fernauslesung""" AUSLESUNG_STUENDLICH_FERNAUSLESUNG = "AUSLESUNG_STUENDLICH_FERNAUSLESUNG" # Auslesung stündlich mittels Fernauslesung - AUSLESUNG_TEMPERATURMENGENUMWERTER = "AUSLESUNG_TEMPERATURMENGENUMWERTER" #: Auslesung Temperaturmengenumwerter - AUSLESUNG_ZUSTANDSMENGENUMWERTER = "AUSLESUNG_ZUSTANDSMENGENUMWERTER" #: Auslesung Zustandsmengenumwerter - AUSLESUNG_SYSTEMMENGENUMWERTER = "AUSLESUNG_SYSTEMMENGENUMWERTER" #: Auslesung Systemmengenumwerter - AUSLESUNG_VORGANG = "AUSLESUNG_VORGANG" #: Auslesung je Vorgang - AUSLESUNG_KOMPAKTMENGENUMWERTER = "AUSLESUNG_KOMPAKTMENGENUMWERTER" #: Auslesung Kompaktmengenumwerter - SPERRUNG = "SPERRUNG" #: Sperrung einer Abnahmestelle - ENTSPERRUNG = "ENTSPERRUNG" #: Entsperrung einer Abnahmestelle - MAHNKOSTEN = "MAHNKOSTEN" #: Mahnkosten - INKASSOKOSTEN = "INKASSOKOSTEN" #: Inkassokosten + AUSLESUNG_TEMPERATURMENGENUMWERTER = "AUSLESUNG_TEMPERATURMENGENUMWERTER" + """Auslesung Temperaturmengenumwerter""" + AUSLESUNG_ZUSTANDSMENGENUMWERTER = "AUSLESUNG_ZUSTANDSMENGENUMWERTER" + """Auslesung Zustandsmengenumwerter""" + AUSLESUNG_SYSTEMMENGENUMWERTER = "AUSLESUNG_SYSTEMMENGENUMWERTER" + """Auslesung Systemmengenumwerter""" + AUSLESUNG_VORGANG = "AUSLESUNG_VORGANG" + """Auslesung je Vorgang""" + AUSLESUNG_KOMPAKTMENGENUMWERTER = "AUSLESUNG_KOMPAKTMENGENUMWERTER" + """Auslesung Kompaktmengenumwerter""" + SPERRUNG = "SPERRUNG" + """Sperrung einer Abnahmestelle""" + ENTSPERRUNG = "ENTSPERRUNG" + """Entsperrung einer Abnahmestelle""" + MAHNKOSTEN = "MAHNKOSTEN" + """Mahnkosten""" + INKASSOKOSTEN = "INKASSOKOSTEN" + """Inkassokosten""" diff --git a/src/bo4e/enum/energierichtung.py b/src/bo4e/enum/energierichtung.py index bc279eb4b..412876559 100644 --- a/src/bo4e/enum/energierichtung.py +++ b/src/bo4e/enum/energierichtung.py @@ -8,5 +8,7 @@ class Energierichtung(StrEnum): Spezifiziert die Energierichtung einer Markt- und/oder Messlokation """ - AUSSP = "AUSSP" #: Ausspeisung - EINSP = "EINSP" #: Einspeisung + AUSSP = "AUSSP" + """Ausspeisung""" + EINSP = "EINSP" + """Einspeisung""" diff --git a/src/bo4e/enum/erzeugungsart.py b/src/bo4e/enum/erzeugungsart.py index b3069f98c..fc625c008 100644 --- a/src/bo4e/enum/erzeugungsart.py +++ b/src/bo4e/enum/erzeugungsart.py @@ -7,17 +7,31 @@ class Erzeugungsart(StrEnum): Auflistung der Erzeugungsarten von Energie. """ - FOSSIL = "FOSSIL" #: Fossile Brennstoffe - KWK = "KWK" #: Kraft-Waerme-Koppelung - WIND = "WIND" #: Windkraft - SOLAR = "SOLAR" #: Solarenergie - KERNKRAFT = "KERNKRAFT" #: Kernkraft - WASSER = "WASSER" #: Wasserkraft - GEOTHERMIE = "GEOTHERMIE" #: Geothermie - BIOMASSE = "BIOMASSE" #: Biomasse - KOHLE = "KOHLE" #: Kohle - GAS = "GAS" #: Erdgas - SONSTIGE = "SONSTIGE" #: Sonstige - SONSTIGE_EEG = "SONSTIGE_EEG" #: Sonstige nach EEG - BIOGAS = "BIOGAS" #: Biogas - KLIMANEUTRALES_GAS = "KLIMANEUTRALES_GAS" #: Klimaneutrales Erdgas + FOSSIL = "FOSSIL" + """Fossile Brennstoffe""" + KWK = "KWK" + """Kraft-Waerme-Koppelung""" + WIND = "WIND" + """Windkraft""" + SOLAR = "SOLAR" + """Solarenergie""" + KERNKRAFT = "KERNKRAFT" + """Kernkraft""" + WASSER = "WASSER" + """Wasserkraft""" + GEOTHERMIE = "GEOTHERMIE" + """Geothermie""" + BIOMASSE = "BIOMASSE" + """Biomasse""" + KOHLE = "KOHLE" + """Kohle""" + GAS = "GAS" + """Erdgas""" + SONSTIGE = "SONSTIGE" + """Sonstige""" + SONSTIGE_EEG = "SONSTIGE_EEG" + """Sonstige nach EEG""" + BIOGAS = "BIOGAS" + """Biogas""" + KLIMANEUTRALES_GAS = "KLIMANEUTRALES_GAS" + """Klimaneutrales Erdgas""" diff --git a/src/bo4e/enum/gasqualitaet.py b/src/bo4e/enum/gasqualitaet.py index 1f6ab6eae..9b9ab44ce 100644 --- a/src/bo4e/enum/gasqualitaet.py +++ b/src/bo4e/enum/gasqualitaet.py @@ -8,5 +8,7 @@ class Gasqualitaet(StrEnum): Unterscheidung für hoch- und niedrig-kalorisches Gas. """ - H_GAS = "H_GAS" #: High Caloric Gas - L_GAS = "L_GAS" #: Low Caloric Gas + H_GAS = "H_GAS" + """High Caloric Gas""" + L_GAS = "L_GAS" + """Low Caloric Gas""" diff --git a/src/bo4e/enum/gebiettyp.py b/src/bo4e/enum/gebiettyp.py index d0cb0801e..ce0938b69 100644 --- a/src/bo4e/enum/gebiettyp.py +++ b/src/bo4e/enum/gebiettyp.py @@ -8,12 +8,21 @@ class Gebiettyp(StrEnum): List of possible Gebiettypen. """ - REGELZONE = "REGELZONE" #: Regelzone - MARKTGEBIET = "MARKTGEBIET" #: Marktgebiet - BILANZIERUNGSGEBIET = "BILANZIERUNGSGEBIET" #: Bilanzierungsgebiet - VERTEILNETZ = "VERTEILNETZ" #: Verteilnetz - TRANSPORTNETZ = "TRANSPORTNETZ" #: Transportnetz - REGIONALNETZ = "REGIONALNETZ" #: Regionalnetz - AREALNETZ = "AREALNETZ" #: Arealnetz - GRUNDVERSORGUNGSGEBIET = "GRUNDVERSORGUNGSGEBIET" #: Grundversorgungsgebiet - VERSORGUNGSGEBIET = "VERSORGUNGSGEBIET" #: Versorgungsgebiet + REGELZONE = "REGELZONE" + """Regelzone""" + MARKTGEBIET = "MARKTGEBIET" + """Marktgebiet""" + BILANZIERUNGSGEBIET = "BILANZIERUNGSGEBIET" + """Bilanzierungsgebiet""" + VERTEILNETZ = "VERTEILNETZ" + """Verteilnetz""" + TRANSPORTNETZ = "TRANSPORTNETZ" + """Transportnetz""" + REGIONALNETZ = "REGIONALNETZ" + """Regionalnetz""" + AREALNETZ = "AREALNETZ" + """Arealnetz""" + GRUNDVERSORGUNGSGEBIET = "GRUNDVERSORGUNGSGEBIET" + """Grundversorgungsgebiet""" + VERSORGUNGSGEBIET = "VERSORGUNGSGEBIET" + """Versorgungsgebiet""" diff --git a/src/bo4e/enum/geraeteklasse.py b/src/bo4e/enum/geraeteklasse.py index cd06ccec4..71affe67f 100644 --- a/src/bo4e/enum/geraeteklasse.py +++ b/src/bo4e/enum/geraeteklasse.py @@ -9,10 +9,17 @@ class Geraeteklasse(StrEnum): Auflistung möglicher übergreifenden Geräteklassen. """ - WANDLER = "WANDLER" #: Wandler - KOMMUNIKATIONSEINRICHTUNG = "KOMMUNIKATIONSEINRICHTUNG" #: Kommunikationseinrichtung - TECHNISCHE_STEUEREINRICHTUNG = "TECHNISCHE_STEUEREINRICHTUNG" #: Technische Steuereinrichtung - MENGENUMWERTER = "MENGENUMWERTER" #: Mengenumwerter - SMARTMETER_GATEWAY = "SMARTMETER_GATEWAY" #: Smartmeter-Gateway - STEUERBOX = "STEUERBOX" #: Steuerbox - ZAEHLEINRICHTUNG = "ZAEHLEINRICHTUNG" #: Zaehleinrichtung + WANDLER = "WANDLER" + """Wandler""" + KOMMUNIKATIONSEINRICHTUNG = "KOMMUNIKATIONSEINRICHTUNG" + """Kommunikationseinrichtung""" + TECHNISCHE_STEUEREINRICHTUNG = "TECHNISCHE_STEUEREINRICHTUNG" + """Technische Steuereinrichtung""" + MENGENUMWERTER = "MENGENUMWERTER" + """Mengenumwerter""" + SMARTMETER_GATEWAY = "SMARTMETER_GATEWAY" + """Smartmeter-Gateway""" + STEUERBOX = "STEUERBOX" + """Steuerbox""" + ZAEHLEINRICHTUNG = "ZAEHLEINRICHTUNG" + """Zaehleinrichtung""" diff --git a/src/bo4e/enum/geraetetyp.py b/src/bo4e/enum/geraetetyp.py index 971f61a59..21c9f250a 100644 --- a/src/bo4e/enum/geraetetyp.py +++ b/src/bo4e/enum/geraetetyp.py @@ -9,49 +9,95 @@ class Geraetetyp(StrEnum): Auflistung möglicher abzurechnender Gerätetypen. """ - MULTIPLEXANLAGE = "MULTIPLEXANLAGE" #: Multiplexeranlage - PAUSCHALANLAGE = "PAUSCHALANLAGE" #: Pauschalanlagen - VERSTAERKERANLAGE = "VERSTAERKERANLAGE" #: Verstärkeranlage - SUMMATIONSGERAET = "SUMMATIONSGERAET" #: Summationsgerät - IMPULSGEBER = "IMPULSGEBER" #: Impulsgeber - MENGENUMWERTER = "MENGENUMWERTER" #: Mengenumwerter - STROMWANDLER = "STROMWANDLER" #: Stromwandler - SPANNUNGSWANDLER = "SPANNUNGSWANDLER" #: Spannungs-Wandler - KOMBIMESSWANDLER = "KOMBIMESSWANDLER" #: Kombimesswandler - BLOCKSTROMWANDLER = "BLOCKSTROMWANDLER" #: Blockstromwandler - DATENLOGGER = "DATENLOGGER" #: Datenlogger - KOMMUNIKATIONSANSCHLUSS = "KOMMUNIKATIONSANSCHLUSS" #: Kommunikationsanschluss - MODEM = "MODEM" #: Modem - TELEKOMMUNIKATIONSEINRICHTUNG = "TELEKOMMUNIKATIONSEINRICHTUNG" #: vom Messstellenbetreiber beigestellte Telekommunikationseinrichtung (Telefonanschluss) - MODERNE_MESSEINRICHTUNG = "MODERNE_MESSEINRICHTUNG" #: moderne Messeinrichtung - INTELLIGENTES_MESSYSTEM = "INTELLIGENTES_MESSYSTEM" #: Intelligentes Messystem - STEUEREINRICHTUNG = "STEUEREINRICHTUNG" #: Steuereinrichtung - TARIFSCHALTGERAET = "TARIFSCHALTGERAET" #: Tarifschaltgerät - RUNDSTEUEREMPFAENGER = "RUNDSTEUEREMPFAENGER" #: Rundsteuerempfänger - OPTIONALE_ZUS_ZAEHLEINRICHTUNG = "OPTIONALE_ZUS_ZAEHLEINRICHTUNG" #: optionale zusätzliche Zähleinrichtung - MESSWANDLERSATZ_IMS_MME = "MESSWANDLERSATZ_IMS_MME" #: Messwandlersatz Strom iMS und mME, NSP - KOMBIMESSWANDLER_IMS_MME = "KOMBIMESSWANDLER_IMS_MME" #: Kombimesswandlersatz (Strom u. Spg) iMS und mME - TARIFSCHALTGERAET_IMS_MME = "TARIFSCHALTGERAET_IMS_MME" #: Tarifschaltung iMS und mME - RUNDSTEUEREMPFAENGER_IMS_MME = "RUNDSTEUEREMPFAENGER_IMS_MME" #: Rundsteuerempfänger iMS und mME - TEMPERATUR_KOMPENSATION = "TEMPERATUR_KOMPENSATION" #: Temperaturkompensation - HOECHSTBELASTUNGS_ANZEIGER = "HOECHSTBELASTUNGS_ANZEIGER" #: Höchsbelastungsanzeiger - SONSTIGES_GERAET = "SONSTIGES_GERAET" #: Sonstiges Gerät - EDL_21 = "EDL_21" #: EDL21 - EDL_40_ZAEHLERAUFSATZ = "EDL_40_ZAEHLERAUFSATZ" #: EDL 40 Zähleraufsatz für Zähler - EDL_40 = "EDL_40" #: EDL 40 - TELEFONANSCHLUSS = "TELEFONANSCHLUSS" #: Telefonanschluss - MODEM_GSM = "MODEM_GSM" #: Modem-GSM - MODEM_GPRS = "MODEM_GPRS" #: Modem-GPRS - MODEM_FUNK = "MODEM_FUNK" #: Modem-Funk - MODEM_GSM_O_LG = "MODEM_GSM_O_LG" #: vom Messstellenbetreiber beigestelltes GSM-Modem ohne Lastgangmessung - MODEM_GSM_M_LG = "MODEM_GSM_M_LG" #: vom Messstellenbetreiber beigestelltes GSM-Modem mit Lastgangmessung - MODEM_FESTNETZ = "MODEM_FESTNETZ" #: vom Messstellenbetreiber beigestelltes Festnetz-Modem - MODEM_GPRS_M_LG = "MODEM_GPRS_M_LG" #: vom Messstellenbetreiber bereitgestelltes GPRS-Modem Lastgangmessung - PLC_KOM = "PLC_KOM" #: PLC-Kom.-Einrichtung (Powerline Communication) - ETHERNET_KOM = "ETHERNET_KOM" #: Ethernet-Kom.-Einricht. LAN/WLAN - DSL_KOM = "DSL_KOM" #: DSL-Kommunikationseinrichtung - LTE_KOM = "LTE_KOM" #: LTE-Kommunikationseinrichtung - KOMPAKT_MU = "KOMPAKT_MU" #: Kompaktmengenumwerter - SYSTEM_MU = "SYSTEM_MU" #: Systemmengenumwerter - TEMPERATUR_MU = "TEMPERATUR_MU" #: Temperaturmengenumwerter - ZUSTANDS_MU = "ZUSTANDS_MU" #: Zustandsmengenumwerter + MULTIPLEXANLAGE = "MULTIPLEXANLAGE" + """Multiplexeranlage""" + PAUSCHALANLAGE = "PAUSCHALANLAGE" + """Pauschalanlagen""" + VERSTAERKERANLAGE = "VERSTAERKERANLAGE" + """Verstärkeranlage""" + SUMMATIONSGERAET = "SUMMATIONSGERAET" + """Summationsgerät""" + IMPULSGEBER = "IMPULSGEBER" + """Impulsgeber""" + MENGENUMWERTER = "MENGENUMWERTER" + """Mengenumwerter""" + STROMWANDLER = "STROMWANDLER" + """Stromwandler""" + SPANNUNGSWANDLER = "SPANNUNGSWANDLER" + """Spannungs-Wandler""" + KOMBIMESSWANDLER = "KOMBIMESSWANDLER" + """Kombimesswandler""" + BLOCKSTROMWANDLER = "BLOCKSTROMWANDLER" + """Blockstromwandler""" + DATENLOGGER = "DATENLOGGER" + """Datenlogger""" + KOMMUNIKATIONSANSCHLUSS = "KOMMUNIKATIONSANSCHLUSS" + """Kommunikationsanschluss""" + MODEM = "MODEM" + """Modem""" + TELEKOMMUNIKATIONSEINRICHTUNG = "TELEKOMMUNIKATIONSEINRICHTUNG" + """vom Messstellenbetreiber beigestellte Telekommunikationseinrichtung (Telefonanschluss)""" + MODERNE_MESSEINRICHTUNG = "MODERNE_MESSEINRICHTUNG" + """moderne Messeinrichtung""" + INTELLIGENTES_MESSYSTEM = "INTELLIGENTES_MESSYSTEM" + """Intelligentes Messystem""" + STEUEREINRICHTUNG = "STEUEREINRICHTUNG" + """Steuereinrichtung""" + TARIFSCHALTGERAET = "TARIFSCHALTGERAET" + """Tarifschaltgerät""" + RUNDSTEUEREMPFAENGER = "RUNDSTEUEREMPFAENGER" + """Rundsteuerempfänger""" + OPTIONALE_ZUS_ZAEHLEINRICHTUNG = "OPTIONALE_ZUS_ZAEHLEINRICHTUNG" + """optionale zusätzliche Zähleinrichtung""" + MESSWANDLERSATZ_IMS_MME = "MESSWANDLERSATZ_IMS_MME" + """Messwandlersatz Strom iMS und mME, NSP""" + KOMBIMESSWANDLER_IMS_MME = "KOMBIMESSWANDLER_IMS_MME" + """Kombimesswandlersatz (Strom u. Spg) iMS und mME""" + TARIFSCHALTGERAET_IMS_MME = "TARIFSCHALTGERAET_IMS_MME" + """Tarifschaltung iMS und mME""" + RUNDSTEUEREMPFAENGER_IMS_MME = "RUNDSTEUEREMPFAENGER_IMS_MME" + """Rundsteuerempfänger iMS und mME""" + TEMPERATUR_KOMPENSATION = "TEMPERATUR_KOMPENSATION" + """Temperaturkompensation""" + HOECHSTBELASTUNGS_ANZEIGER = "HOECHSTBELASTUNGS_ANZEIGER" + """Höchsbelastungsanzeiger""" + SONSTIGES_GERAET = "SONSTIGES_GERAET" + """Sonstiges Gerät""" + EDL_21 = "EDL_21" + """EDL21""" + EDL_40_ZAEHLERAUFSATZ = "EDL_40_ZAEHLERAUFSATZ" + """EDL 40 Zähleraufsatz für Zähler""" + EDL_40 = "EDL_40" + """EDL 40""" + TELEFONANSCHLUSS = "TELEFONANSCHLUSS" + """Telefonanschluss""" + MODEM_GSM = "MODEM_GSM" + """Modem-GSM""" + MODEM_GPRS = "MODEM_GPRS" + """Modem-GPRS""" + MODEM_FUNK = "MODEM_FUNK" + """Modem-Funk""" + MODEM_GSM_O_LG = "MODEM_GSM_O_LG" + """vom Messstellenbetreiber beigestelltes GSM-Modem ohne Lastgangmessung""" + MODEM_GSM_M_LG = "MODEM_GSM_M_LG" + """vom Messstellenbetreiber beigestelltes GSM-Modem mit Lastgangmessung""" + MODEM_FESTNETZ = "MODEM_FESTNETZ" + """vom Messstellenbetreiber beigestelltes Festnetz-Modem""" + MODEM_GPRS_M_LG = "MODEM_GPRS_M_LG" + """vom Messstellenbetreiber bereitgestelltes GPRS-Modem Lastgangmessung""" + PLC_KOM = "PLC_KOM" + """PLC-Kom.-Einrichtung (Powerline Communication)""" + ETHERNET_KOM = "ETHERNET_KOM" + """Ethernet-Kom.-Einricht. LAN/WLAN""" + DSL_KOM = "DSL_KOM" + """DSL-Kommunikationseinrichtung""" + LTE_KOM = "LTE_KOM" + """LTE-Kommunikationseinrichtung""" + KOMPAKT_MU = "KOMPAKT_MU" + """Kompaktmengenumwerter""" + SYSTEM_MU = "SYSTEM_MU" + """Systemmengenumwerter""" + TEMPERATUR_MU = "TEMPERATUR_MU" + """Temperaturmengenumwerter""" + ZUSTANDS_MU = "ZUSTANDS_MU" + """Zustandsmengenumwerter""" diff --git a/src/bo4e/enum/geschaeftspartnerrolle.py b/src/bo4e/enum/geschaeftspartnerrolle.py index 0c8f264f1..60de0cdfd 100644 --- a/src/bo4e/enum/geschaeftspartnerrolle.py +++ b/src/bo4e/enum/geschaeftspartnerrolle.py @@ -8,8 +8,13 @@ class Geschaeftspartnerrolle(StrEnum): Diese Rollen kann ein Geschäftspartner einnehmen. """ - LIEFERANT = "LIEFERANT" #: Lieferant - DIENSTLEISTER = "DIENSTLEISTER" #: Dienstleister - KUNDE = "KUNDE" #: Kunde - INTERESSENT = "INTERESSENT" #: Interessent - MARKTPARTNER = "MARKTPARTNER" #: Marktpartner + LIEFERANT = "LIEFERANT" + """Lieferant""" + DIENSTLEISTER = "DIENSTLEISTER" + """Dienstleister""" + KUNDE = "KUNDE" + """Kunde""" + INTERESSENT = "INTERESSENT" + """Interessent""" + MARKTPARTNER = "MARKTPARTNER" + """Marktpartner""" diff --git a/src/bo4e/enum/gueltigkeitstyp.py b/src/bo4e/enum/gueltigkeitstyp.py index 5f349ab18..c02685f0a 100644 --- a/src/bo4e/enum/gueltigkeitstyp.py +++ b/src/bo4e/enum/gueltigkeitstyp.py @@ -7,7 +7,9 @@ class Gueltigkeitstyp(StrEnum): Übersicht der verschiedenen Gültigkeiten zur Umsetzung von Positiv- bzw. Negativlisten. """ - NUR_IN = "NUR_IN" #: Ein so eingeschränktes Merkmal gilt nur mit den angebenen Werten - NICHT_IN = "NICHT_IN" #: Ein so eingeschränktes Merkmal gilt nicht mit den angebenen Werten - #: Die Kriterien mit diesem Gültigkeitstyp werden miteinander kombiniert + NUR_IN = "NUR_IN" + """Ein so eingeschränktes Merkmal gilt nur mit den angebenen Werten""" + NICHT_IN = "NICHT_IN" + """Ein so eingeschränktes Merkmal gilt nicht mit den angebenen Werten""" NUR_IN_KOMBINATION_MIT = "NUR_IN_KOMBINATION_MIT" + """Die Kriterien mit diesem Gültigkeitstyp werden miteinander kombiniert""" diff --git a/src/bo4e/enum/kalkulationsmethode.py b/src/bo4e/enum/kalkulationsmethode.py index 021be7744..6c7a55c91 100644 --- a/src/bo4e/enum/kalkulationsmethode.py +++ b/src/bo4e/enum/kalkulationsmethode.py @@ -7,19 +7,37 @@ class Kalkulationsmethode(StrEnum): Auflistung der verschiedenen Berechnungsmethoden für ein Preisblatt. """ - STUFEN = "STUFEN" #: Stufenmodell, d.h. die Gesamtmenge wird in eine Stufe eingeordnet und für die gesamte Menge gilt der so ermittelte Preis - ZONEN = "ZONEN" #: Zonenmodell, d.h. die Gesamtmenge wird auf die Zonen aufgeteilt und für die Teilmengen gilt der jeweilige Preis der Zone. - VORZONEN_GP = "VORZONEN_GP" #: Vorzonengrundpreis - SIGMOID = "SIGMOID" #: Sigmoidfunktion - BLINDARBEIT_GT_50_PROZENT = "BLINDARBEIT_GT_50_PROZENT" #: Blindarbeit oberhalb 50% der Wirkarbeit - BLINDARBEIT_GT_40_PROZENT = "BLINDARBEIT_GT_40_PROZENT" #: Blindarbeit oberhalb 40% der Wirkarbeit - BLINDARBEIT_MIT_FREIMENGE = "BLINDARBEIT_MIT_FREIMENGE" #: Blindarbeit. Freimenge ist durch cos phi oder prozentualem Anteil der Wirkarbeit angegeben. - AP_GP_ZONEN = "AP_GP_ZONEN" #: Arbeits- und Grundpreis gezont - LP_INSTALL_LEISTUNG = "LP_INSTALL_LEISTUNG" #: Leistungsentgelt auf Grundlage der installierten Leistung - AP_TRANSPORT_ODER_VERTEILNETZ = "AP_TRANSPORT_ODER_VERTEILNETZ" #: AP auf Grundlage Transport- oder Verteilnetz - AP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID = "AP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID" #: AP auf Grundlage Transport- oder Verteilnetz, Ortsverteilnetz über Sigmoid - LP_JAHRESVERBRAUCH = "LP_JAHRESVERBRAUCH" #: Leistungsentgelt auf Grundlage des Jahresverbrauchs - LP_TRANSPORT_ODER_VERTEILNETZ = "LP_TRANSPORT_ODER_VERTEILNETZ" #: LP auf Grundlage Transport- oder Verteilnetz - LP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID = "LP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID" #: LP auf Grundlage Transport- oder Verteilnetz, Ortsverteilnetz über Sigmoid - FUNKTIONEN = "FUNKTIONEN" #: Funktionsbezogene Leistungsermittlung bei Verbräuchen oberhalb der SLP Grenze. (ähnlich Sigmoid) - VERBRAUCH_UEBER_SLP_GRENZE_FUNKTIONSBEZOGEN_WEITERE_BERECHNUNG_ALS_LGK = "VERBRAUCH_UEBER_SLP_GRENZE_FUNKTIONSBEZOGEN_WEITERE_BERECHNUNG_ALS_LGK" #: Bei einem Verbrauch über der SLP-Grenze (letzte Staffelgrenze überschritten) erfolgt die Berechnung funktionsbezogen (s.o.) als LGK. + STUFEN = "STUFEN" + """Stufenmodell, d.h. die Gesamtmenge wird in eine Stufe eingeordnet und für die gesamte Menge gilt der so ermittelte Preis""" + ZONEN = "ZONEN" + """Zonenmodell, d.h. die Gesamtmenge wird auf die Zonen aufgeteilt und für die Teilmengen gilt der jeweilige Preis der Zone.""" + VORZONEN_GP = "VORZONEN_GP" + """Vorzonengrundpreis""" + SIGMOID = "SIGMOID" + """Sigmoidfunktion""" + BLINDARBEIT_GT_50_PROZENT = "BLINDARBEIT_GT_50_PROZENT" + """Blindarbeit oberhalb 50% der Wirkarbeit""" + BLINDARBEIT_GT_40_PROZENT = "BLINDARBEIT_GT_40_PROZENT" + """Blindarbeit oberhalb 40% der Wirkarbeit""" + BLINDARBEIT_MIT_FREIMENGE = "BLINDARBEIT_MIT_FREIMENGE" + """Blindarbeit. Freimenge ist durch cos phi oder prozentualem Anteil der Wirkarbeit angegeben.""" + AP_GP_ZONEN = "AP_GP_ZONEN" + """Arbeits- und Grundpreis gezont""" + LP_INSTALL_LEISTUNG = "LP_INSTALL_LEISTUNG" + """Leistungsentgelt auf Grundlage der installierten Leistung""" + AP_TRANSPORT_ODER_VERTEILNETZ = "AP_TRANSPORT_ODER_VERTEILNETZ" + """AP auf Grundlage Transport- oder Verteilnetz""" + AP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID = "AP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID" + """AP auf Grundlage Transport- oder Verteilnetz, Ortsverteilnetz über Sigmoid""" + LP_JAHRESVERBRAUCH = "LP_JAHRESVERBRAUCH" + """Leistungsentgelt auf Grundlage des Jahresverbrauchs""" + LP_TRANSPORT_ODER_VERTEILNETZ = "LP_TRANSPORT_ODER_VERTEILNETZ" + """LP auf Grundlage Transport- oder Verteilnetz""" + LP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID = "LP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID" + """LP auf Grundlage Transport- oder Verteilnetz, Ortsverteilnetz über Sigmoid""" + FUNKTIONEN = "FUNKTIONEN" + """Funktionsbezogene Leistungsermittlung bei Verbräuchen oberhalb der SLP Grenze. (ähnlich Sigmoid)""" + VERBRAUCH_UEBER_SLP_GRENZE_FUNKTIONSBEZOGEN_WEITERE_BERECHNUNG_ALS_LGK = ( + "VERBRAUCH_UEBER_SLP_GRENZE_FUNKTIONSBEZOGEN_WEITERE_BERECHNUNG_ALS_LGK" + ) + """Bei einem Verbrauch über der SLP-Grenze (letzte Staffelgrenze überschritten) erfolgt die Berechnung funktionsbezogen (s.o.) als LGK.""" diff --git a/src/bo4e/enum/kontaktart.py b/src/bo4e/enum/kontaktart.py index 7522b5460..9719e34f0 100644 --- a/src/bo4e/enum/kontaktart.py +++ b/src/bo4e/enum/kontaktart.py @@ -8,8 +8,13 @@ class Kontaktart(StrEnum): Gibt an, auf welchem Weg die Person oder der Geschäftspartner kontaktiert werden kann. """ - POSTWEG = "POSTWEG" #: Postweg - TELEFON = "TELEFON" #: Telefon - FAX = "FAX" #: Fax - E_MAIL = "E_MAIL" #: E-Mail - SMS = "SMS" #: SMS + POSTWEG = "POSTWEG" + """Postweg""" + TELEFON = "TELEFON" + """Telefon""" + FAX = "FAX" + """Fax""" + E_MAIL = "E_MAIL" + """E-Mail""" + SMS = "SMS" + """SMS""" diff --git a/src/bo4e/enum/kostenklasse.py b/src/bo4e/enum/kostenklasse.py index 0a6a2e728..75a30742b 100644 --- a/src/bo4e/enum/kostenklasse.py +++ b/src/bo4e/enum/kostenklasse.py @@ -8,8 +8,13 @@ class Kostenklasse(StrEnum): In der Regel werden die Gesamtkosten einer Kostenklasse in einer App berechnet. """ - FREMDKOSTEN = "FREMDKOSTEN" #: Fremdkosten - BESCHAFFUNG = "BESCHAFFUNG" #: Beschaffung - SELBSTKOSTEN = "SELBSTKOSTEN" #: Selbstkosten - MARGEN = "MARGEN" #: Margen - ENERGIEVERSORGUNGSKOSTEN = "ENERGIEVERSORGUNGSKOSTEN" #: Energieversorgungskosten + FREMDKOSTEN = "FREMDKOSTEN" + """Fremdkosten""" + BESCHAFFUNG = "BESCHAFFUNG" + """Beschaffung""" + SELBSTKOSTEN = "SELBSTKOSTEN" + """Selbstkosten""" + MARGEN = "MARGEN" + """Margen""" + ENERGIEVERSORGUNGSKOSTEN = "ENERGIEVERSORGUNGSKOSTEN" + """Energieversorgungskosten""" diff --git a/src/bo4e/enum/kundengruppe.py b/src/bo4e/enum/kundengruppe.py index 57dcc3229..cb85c8586 100644 --- a/src/bo4e/enum/kundengruppe.py +++ b/src/bo4e/enum/kundengruppe.py @@ -7,38 +7,73 @@ class Kundengruppe(StrEnum): Kundengruppe für eine Marktlokation (orientiert sich an den Standard-Lastprofilen). """ - RLM = "RLM" #: Kunde mit registrierender Leistungsmessung (kein SLP) - RLM_KOMMUNAL = "RLM_KOMMUNAL" #: Kommunale Abnahmestelle leistungsgemessen - SLP_KOMMUNAL = "SLP_KOMMUNAL" #: Kommunale Abnahmestelle nicht leistungsgemessen - SLP_S_G0 = "SLP_S_G0" #: Gewerbe allgemein - SLP_S_G1 = "SLP_S_G1" #: Werktags - SLP_S_G2 = "SLP_S_G2" #: Verbrauch in Abendstunden - SLP_S_G3 = "SLP_S_G3" #: Gewerbe durchlaufend - SLP_S_G4 = "SLP_S_G4" #: Laden, Friseur - SLP_S_G5 = "SLP_S_G5" #: Bäckerei mit Backstube - SLP_S_G6 = "SLP_S_G6" #: Wochenendbetrieb - SLP_S_G7 = "SLP_S_G7" #: Mobilfunksendestation - SLP_S_L0 = "SLP_S_L0" #: Landwirtschaft allgemein - SLP_S_L1 = "SLP_S_L1" #: Landwirtschaft mit Milchwirtschaft/Nebenerwerbs-Tierzucht - SLP_S_L2 = "SLP_S_L2" #: Übrige Landwirtschaftsbetriebe - SLP_S_H0 = "SLP_S_H0" #: Haushalt allgemein - SLP_S_SB = "SLP_S_SB" #: Straßenbeleuchtung - SLP_S_HZ = "SLP_S_HZ" #: Nachtspeicherheizung - SLP_S_WP = "SLP_S_WP" #: Wärmepumpe - SLP_S_EM = "SLP_S_EM" #: Elektromobilität - SLP_S_HZ_GEM = "SLP_S_HZ_GEM" #: Nachtspeicherheizung gemeinsame Messung - SLP_G_GKO = "SLP_G_GKO" #: Gebietskörpersch., Kreditinst. u. Versich., Org. o. Erwerbszw. & öff. Einr. - SLP_G_STANDARD = "SLP_G_STANDARD" #: Standardkundengruppe für Gas - SLP_G_GHA = "SLP_G_GHA" #: Einzelhandel, Großhandel - SLP_G_GMK = "SLP_G_GMK" #: Metall, Kfz - SLP_G_GBD = "SLP_G_GBD" #: sonst. betr. Dienstleistungen - SLP_G_GGA = "SLP_G_GGA" #: Beherbergung - SLP_G_GBH = "SLP_G_GBH" #: Gaststätten - SLP_G_GBA = "SLP_G_GBA" #: Bäckereien - SLP_G_GWA = "SLP_G_GWA" #: Wäschereien - SLP_G_GGB = "SLP_G_GGB" #: Gartenbau - SLP_G_GPD = "SLP_G_GPD" #: Papier und Druck - SLP_G_GMF = "SLP_G_GMF" #: haushaltsähnliche Gewerbebetriebe - SLP_G_HEF = "SLP_G_HEF" #: Einfamilienhaushalt - SLP_G_HMF = "SLP_G_HMF" #: Mehrfamilienhaushalt - SLP_G_HKO = "SLP_G_HKO" #: Kochgas + RLM = "RLM" + """Kunde mit registrierender Leistungsmessung (kein SLP)""" + RLM_KOMMUNAL = "RLM_KOMMUNAL" + """Kommunale Abnahmestelle leistungsgemessen""" + SLP_KOMMUNAL = "SLP_KOMMUNAL" + """Kommunale Abnahmestelle nicht leistungsgemessen""" + SLP_S_G0 = "SLP_S_G0" + """Gewerbe allgemein""" + SLP_S_G1 = "SLP_S_G1" + """Werktags""" + SLP_S_G2 = "SLP_S_G2" + """Verbrauch in Abendstunden""" + SLP_S_G3 = "SLP_S_G3" + """Gewerbe durchlaufend""" + SLP_S_G4 = "SLP_S_G4" + """Laden, Friseur""" + SLP_S_G5 = "SLP_S_G5" + """Bäckerei mit Backstube""" + SLP_S_G6 = "SLP_S_G6" + """Wochenendbetrieb""" + SLP_S_G7 = "SLP_S_G7" + """Mobilfunksendestation""" + SLP_S_L0 = "SLP_S_L0" + """Landwirtschaft allgemein""" + SLP_S_L1 = "SLP_S_L1" + """Landwirtschaft mit Milchwirtschaft/Nebenerwerbs-Tierzucht""" + SLP_S_L2 = "SLP_S_L2" + """Übrige Landwirtschaftsbetriebe""" + SLP_S_H0 = "SLP_S_H0" + """Haushalt allgemein""" + SLP_S_SB = "SLP_S_SB" + """Straßenbeleuchtung""" + SLP_S_HZ = "SLP_S_HZ" + """Nachtspeicherheizung""" + SLP_S_WP = "SLP_S_WP" + """Wärmepumpe""" + SLP_S_EM = "SLP_S_EM" + """Elektromobilität""" + SLP_S_HZ_GEM = "SLP_S_HZ_GEM" + """Nachtspeicherheizung gemeinsame Messung""" + SLP_G_GKO = "SLP_G_GKO" + """Gebietskörpersch., Kreditinst. u. Versich., Org. o. Erwerbszw. & öff. Einr.""" + SLP_G_STANDARD = "SLP_G_STANDARD" + """Standardkundengruppe für Gas""" + SLP_G_GHA = "SLP_G_GHA" + """Einzelhandel, Großhandel""" + SLP_G_GMK = "SLP_G_GMK" + """Metall, Kfz""" + SLP_G_GBD = "SLP_G_GBD" + """sonst. betr. Dienstleistungen""" + SLP_G_GGA = "SLP_G_GGA" + """Beherbergung""" + SLP_G_GBH = "SLP_G_GBH" + """Gaststätten""" + SLP_G_GBA = "SLP_G_GBA" + """Bäckereien""" + SLP_G_GWA = "SLP_G_GWA" + """Wäschereien""" + SLP_G_GGB = "SLP_G_GGB" + """Gartenbau""" + SLP_G_GPD = "SLP_G_GPD" + """Papier und Druck""" + SLP_G_GMF = "SLP_G_GMF" + """haushaltsähnliche Gewerbebetriebe""" + SLP_G_HEF = "SLP_G_HEF" + """Einfamilienhaushalt""" + SLP_G_HMF = "SLP_G_HMF" + """Mehrfamilienhaushalt""" + SLP_G_HKO = "SLP_G_HKO" + """Kochgas""" diff --git a/src/bo4e/enum/kundengruppeka.py b/src/bo4e/enum/kundengruppeka.py index 6c085b70a..9986aa758 100644 --- a/src/bo4e/enum/kundengruppeka.py +++ b/src/bo4e/enum/kundengruppeka.py @@ -7,23 +7,43 @@ class KundengruppeKA(StrEnum): Eine Aufzählung zur Einordnung für die Höhe der Konzessionsabgabe. """ - S_SCHWACHLAST = "S_SCHWACHLAST" #: Strom - S_TARIF_25000 = "S_TARIF_25000" #: Strom - S_TARIF_100000 = "S_TARIF_100000" #: Strom - S_TARIF_500000 = "S_TARIF_500000" #: Strom - S_TARIF_G_500000 = "S_TARIF_G_500000" #: Strom - S_SONDERKUNDE = "S_SONDERKUNDE" #: Strom - G_KOWA_25000 = "G_KOWA_25000" #: Gas - G_KOWA_100000 = "G_KOWA_100000" #: Gas - G_KOWA_500000 = "G_KOWA_500000" #: Gas - G_KOWA_G_500000 = "G_KOWA_G_500000" #: Gas - G_TARIF_25000 = "G_TARIF_25000" #: Gas - G_TARIF_100000 = "G_TARIF_100000" #: Gas - G_TARIF_500000 = "G_TARIF_500000" #: Gas - G_TARIF_G_500000 = "G_TARIF_G_500000" #: Gas - G_SONDERKUNDE = "G_SONDERKUNDE" #: Gas - SONDER_KAS = "SONDER_KAS" #: beides - SONDER_SAS = "SONDER_SAS" #: beides - SONDER_TAS = "SONDER_TAS" #: beides - SONDER_TKS = "SONDER_TKS" #: Gas - SONDER_TSS = "SONDER_TSS" #: Strom + S_SCHWACHLAST = "S_SCHWACHLAST" + """Strom""" + S_TARIF_25000 = "S_TARIF_25000" + """Strom""" + S_TARIF_100000 = "S_TARIF_100000" + """Strom""" + S_TARIF_500000 = "S_TARIF_500000" + """Strom""" + S_TARIF_G_500000 = "S_TARIF_G_500000" + """Strom""" + S_SONDERKUNDE = "S_SONDERKUNDE" + """Strom""" + G_KOWA_25000 = "G_KOWA_25000" + """Gas""" + G_KOWA_100000 = "G_KOWA_100000" + """Gas""" + G_KOWA_500000 = "G_KOWA_500000" + """Gas""" + G_KOWA_G_500000 = "G_KOWA_G_500000" + """Gas""" + G_TARIF_25000 = "G_TARIF_25000" + """Gas""" + G_TARIF_100000 = "G_TARIF_100000" + """Gas""" + G_TARIF_500000 = "G_TARIF_500000" + """Gas""" + G_TARIF_G_500000 = "G_TARIF_G_500000" + """Gas""" + G_SONDERKUNDE = "G_SONDERKUNDE" + """Gas""" + SONDER_KAS = "SONDER_KAS" + """beides""" + SONDER_SAS = "SONDER_SAS" + """beides""" + SONDER_TAS = "SONDER_TAS" + """beides""" + SONDER_TKS = "SONDER_TKS" + """Gas""" + SONDER_TSS = "SONDER_TSS" + """Strom""" diff --git a/src/bo4e/enum/kundentyp.py b/src/bo4e/enum/kundentyp.py index 0177b0054..cb6ec8986 100644 --- a/src/bo4e/enum/kundentyp.py +++ b/src/bo4e/enum/kundentyp.py @@ -7,18 +7,33 @@ class Kundentyp(StrEnum): Auflistung der Typen von Endkunden. Daraus kann das Verbrauchsprofil abgeleitet werden. """ - GEWERBE = "GEWERBE" #: Gewerbekunden - PRIVAT = "PRIVAT" #: Privatkunden - LANDWIRT = "LANDWIRT" #: Landwirte - SONSTIGE = "SONSTIGE" #: Sonstige Endkunden - HAUSHALT = "HAUSHALT" #: Haushaltskunden - DIREKTHEIZUNG = "DIREKTHEIZUNG" #: Direktheizungen - GEMEINSCHAFT_MFH = "GEMEINSCHAFT_MFH" #: Gemeinschaftseinrichtungen von MFH - KIRCHE = "KIRCHE" #: Kirchen und caritative Einrichtungen - KWK = "KWK" #: KWK-Anlagen - LADESAEULE = "LADESAEULE" #: Ladesäulen - BELEUCHTUNG_OEFFENTLICH = "BELEUCHTUNG_OEFFENTLICH" #: Öffentliche Beleuchtungen - BELEUCHTUNG_STRASSE = "BELEUCHTUNG_STRASSE" #: Straßenbeleuchtungen - SPEICHERHEIZUNG = "SPEICHERHEIZUNG" #: Speicherheizungen - UNTERBR_EINRICHTUNG = "UNTERBR_EINRICHTUNG" #: Unterbrechbare Verbrauchseinrichtungen - WAERMEPUMPE = "WAERMEPUMPE" #: Wärmepumpen + GEWERBE = "GEWERBE" + """Gewerbekunden""" + PRIVAT = "PRIVAT" + """Privatkunden""" + LANDWIRT = "LANDWIRT" + """Landwirte""" + SONSTIGE = "SONSTIGE" + """Sonstige Endkunden""" + HAUSHALT = "HAUSHALT" + """Haushaltskunden""" + DIREKTHEIZUNG = "DIREKTHEIZUNG" + """Direktheizungen""" + GEMEINSCHAFT_MFH = "GEMEINSCHAFT_MFH" + """Gemeinschaftseinrichtungen von MFH""" + KIRCHE = "KIRCHE" + """Kirchen und caritative Einrichtungen""" + KWK = "KWK" + """KWK-Anlagen""" + LADESAEULE = "LADESAEULE" + """Ladesäulen""" + BELEUCHTUNG_OEFFENTLICH = "BELEUCHTUNG_OEFFENTLICH" + """Öffentliche Beleuchtungen""" + BELEUCHTUNG_STRASSE = "BELEUCHTUNG_STRASSE" + """Straßenbeleuchtungen""" + SPEICHERHEIZUNG = "SPEICHERHEIZUNG" + """Speicherheizungen""" + UNTERBR_EINRICHTUNG = "UNTERBR_EINRICHTUNG" + """Unterbrechbare Verbrauchseinrichtungen""" + WAERMEPUMPE = "WAERMEPUMPE" + """Wärmepumpen""" diff --git a/src/bo4e/enum/leistungstyp.py b/src/bo4e/enum/leistungstyp.py index fa1cb405c..5453e7759 100644 --- a/src/bo4e/enum/leistungstyp.py +++ b/src/bo4e/enum/leistungstyp.py @@ -7,38 +7,67 @@ class Leistungstyp(StrEnum): """ """ - ARBEITSPREIS_WIRKARBEIT = "ARBEITSPREIS_WIRKARBEIT" #: Arbeitspreis zur Abrechnung der Wirkarbeit - LEISTUNGSPREIS_WIRKLEISTUNG = "LEISTUNGSPREIS_WIRKLEISTUNG" #: Leistungspreis zur Abrechnung der Wirkleistung - #: Arbeitspreis zur Abrechnung der Blindarbeit induktiv + ARBEITSPREIS_WIRKARBEIT = "ARBEITSPREIS_WIRKARBEIT" + """Arbeitspreis zur Abrechnung der Wirkarbeit""" + LEISTUNGSPREIS_WIRKLEISTUNG = "LEISTUNGSPREIS_WIRKLEISTUNG" + """Leistungspreis zur Abrechnung der Wirkleistung""" ARBEITSPREIS_BLINDARBEIT_IND = "ARBEITSPREIS_BLINDARBEIT_IND" - #: Arbeitspreis zur Abrechnung der Blindarbeit kapazitiv + """Arbeitspreis zur Abrechnung der Blindarbeit induktiv""" ARBEITSPREIS_BLINDARBEIT_KAP = "ARBEITSPREIS_BLINDARBEIT_KAP" - GRUNDPREIS = "GRUNDPREIS" #: Grundpreis (pro Zeiteinheit) - GRUNDPREIS_ARBEIT = "GRUNDPREIS_ARBEIT" #: Grundpreis, der auf die Arbeit berechnet wird (bei RLM) - GRUNDPREIS_LEISTUNG = "GRUNDPREIS_LEISTUNG" #: Grundpreis, der auf die Leistung berechnet wird (bei RLM) - MEHRMINDERMENGE = "MEHRMINDERMENGE" #: Mehr- oder Mindermenge - MESSSTELLENBETRIEB = "MESSSTELLENBETRIEB" #: Preis pro Zeiteinheit - MESSDIENSTLEISTUNG = "MESSDIENSTLEISTUNG" #: Preis pro Zeiteinheit - #: MDL inklusive der Messung (ab 2017), Preis pro Zeiteinheit + """Arbeitspreis zur Abrechnung der Blindarbeit kapazitiv""" + GRUNDPREIS = "GRUNDPREIS" + """Grundpreis (pro Zeiteinheit)""" + GRUNDPREIS_ARBEIT = "GRUNDPREIS_ARBEIT" + """Grundpreis, der auf die Arbeit berechnet wird (bei RLM)""" + GRUNDPREIS_LEISTUNG = "GRUNDPREIS_LEISTUNG" + """Grundpreis, der auf die Leistung berechnet wird (bei RLM)""" + MEHRMINDERMENGE = "MEHRMINDERMENGE" + """Mehr- oder Mindermenge""" + MESSSTELLENBETRIEB = "MESSSTELLENBETRIEB" + """Preis pro Zeiteinheit""" + MESSDIENSTLEISTUNG = "MESSDIENSTLEISTUNG" + """Preis pro Zeiteinheit""" MESSDIENSTLEISTUNG_INKL_MESSUNG = "MESSDIENSTLEISTUNG_INKL_MESSUNG" - ABRECHNUNG = "ABRECHNUNG" #: Preis pro Zeiteinheit - KONZESSIONS_ABGABE = "KONZESSIONS_ABGABE" #: Konzessionsabgabe - KWK_UMLAGE = "KWK_UMLAGE" #: KWK-Umlage - OFFSHORE_UMLAGE = "OFFSHORE_UMLAGE" #: Offshore-Haftungsumlage - ABLAV_UMLAGE = "ABLAV_UMLAGE" #: Umlage für abschaltbare Lasten - SONDERKUNDEN_UMLAGE = "SONDERKUNDEN_UMLAGE" #: §19 StromNEV Umlage - REGELENERGIE_UMLAGE = "REGELENERGIE_UMLAGE" #: Regelenergieumlage - BILANZIERUNG_UMLAGE = "BILANZIERUNG_UMLAGE" #: Bilanzierungsumlage - AUSLESUNG_ZUSAETZLICH = "AUSLESUNG_ZUSAETZLICH" #: Zusätzliche Auslesung (pro Vorgang) - ABLESUNG_ZUSAETZLICH = "ABLESUNG_ZUSAETZLICH" #: Zusätzliche Ablesung (pro Vorgang) - ABRECHNUNG_ZUSAETZLICH = "ABRECHNUNG_ZUSAETZLICH" #: Zusätzliche Abresung (pro Vorgang) - SPERRUNG = "SPERRUNG" #: Sperrung einer Abnahmestelle - ENTSPERRUNG = "ENTSPERRUNG" #: Entsperrung einer Abnahmestelle - MAHNKOSTEN = "MAHNKOSTEN" #: Mahnkosten - INKASSOKOSTEN = "INKASSOKOSTEN" #: Inkassokosten - EEG_UMLAGE = "EEG_UMLAGE" #: EEG-Umlage - ENERGIESTEUER = "ENERGIESTEUER" #: Strom- oder Erdgassteuer - NETZPREIS = "NETZPREIS" #: Netzpreis - MESSPREIS = "MESSPREIS" #: Messpreis - SONSTIGER_PREIS = "SONSTIGER_PREIS" #: Sonstiger_Preis - DIENSTLEISTUNG = "DIENSTLEISTUNG" #: Dienstleistung + """MDL inklusive der Messung (ab 2017), Preis pro Zeiteinheit""" + ABRECHNUNG = "ABRECHNUNG" + """Preis pro Zeiteinheit""" + KONZESSIONS_ABGABE = "KONZESSIONS_ABGABE" + """Konzessionsabgabe""" + KWK_UMLAGE = "KWK_UMLAGE" + """KWK-Umlage""" + OFFSHORE_UMLAGE = "OFFSHORE_UMLAGE" + """Offshore-Haftungsumlage""" + ABLAV_UMLAGE = "ABLAV_UMLAGE" + """Umlage für abschaltbare Lasten""" + SONDERKUNDEN_UMLAGE = "SONDERKUNDEN_UMLAGE" + """§19 StromNEV Umlage""" + REGELENERGIE_UMLAGE = "REGELENERGIE_UMLAGE" + """Regelenergieumlage""" + BILANZIERUNG_UMLAGE = "BILANZIERUNG_UMLAGE" + """Bilanzierungsumlage""" + AUSLESUNG_ZUSAETZLICH = "AUSLESUNG_ZUSAETZLICH" + """Zusätzliche Auslesung (pro Vorgang)""" + ABLESUNG_ZUSAETZLICH = "ABLESUNG_ZUSAETZLICH" + """Zusätzliche Ablesung (pro Vorgang)""" + ABRECHNUNG_ZUSAETZLICH = "ABRECHNUNG_ZUSAETZLICH" + """Zusätzliche Abresung (pro Vorgang)""" + SPERRUNG = "SPERRUNG" + """Sperrung einer Abnahmestelle""" + ENTSPERRUNG = "ENTSPERRUNG" + """Entsperrung einer Abnahmestelle""" + MAHNKOSTEN = "MAHNKOSTEN" + """Mahnkosten""" + INKASSOKOSTEN = "INKASSOKOSTEN" + """Inkassokosten""" + EEG_UMLAGE = "EEG_UMLAGE" + """EEG-Umlage""" + ENERGIESTEUER = "ENERGIESTEUER" + """Strom- oder Erdgassteuer""" + NETZPREIS = "NETZPREIS" + """Netzpreis""" + MESSPREIS = "MESSPREIS" + """Messpreis""" + SONSTIGER_PREIS = "SONSTIGER_PREIS" + """Sonstiger_Preis""" + DIENSTLEISTUNG = "DIENSTLEISTUNG" + """Dienstleistung""" diff --git a/src/bo4e/enum/lokationstyp.py b/src/bo4e/enum/lokationstyp.py index ead8639f2..125a1db23 100644 --- a/src/bo4e/enum/lokationstyp.py +++ b/src/bo4e/enum/lokationstyp.py @@ -7,8 +7,13 @@ class Lokationstyp(StrEnum): Gibt an, ob es sich um eine Markt- oder Messlokation handelt. """ - MALO = "MALO" #: Marktlokation - MELO = "MELO" #: Messlokation - NELO = "NELO" #: Netzlokation - SR = "SR" #: Steuerbare Ressource - TR = "TR" #: Technische Ressource + MALO = "MALO" + """Marktlokation""" + MELO = "MELO" + """Messlokation""" + NELO = "NELO" + """Netzlokation""" + SR = "SR" + """Steuerbare Ressource""" + TR = "TR" + """Technische Ressource""" diff --git a/src/bo4e/enum/marktrolle.py b/src/bo4e/enum/marktrolle.py index 2a4e9825e..cbd24c3e7 100644 --- a/src/bo4e/enum/marktrolle.py +++ b/src/bo4e/enum/marktrolle.py @@ -8,16 +8,29 @@ class Marktrolle(StrEnum): Diese Rollen kann ein Marktteilnehmer einnehmen. """ - BTR = "BTR" #: Betreiber einer technischen Ressource - BIKO = "BIKO" #: Bilanzkoordinator / Marktgebietsverantwortlicher - BKV = "BKV" #: Bilanzkreisverantwortlicher - DP = "DP" #: Data Provider - EIV = "EIV" #: Einsatzverantwortlicher - ESA = "ESA" #: Energieserviceanbieter des Anschlussnutzers - KN = "KN" #: Kapazitätsnutzer - LF = "LF" #: Lieferant - MGV = "MGV" #: Marktgebietsverantwortlicher - MSB = "MSB" #: Messstellenbetreiber - NB = "NB" #: Netzbetreiber - RB = "RB" #: Registerbetreiber - UENB = "UENB" #: Übertragungsnetzbetreiber + BTR = "BTR" + """Betreiber einer technischen Ressource""" + BIKO = "BIKO" + """Bilanzkoordinator / Marktgebietsverantwortlicher""" + BKV = "BKV" + """Bilanzkreisverantwortlicher""" + DP = "DP" + """Data Provider""" + EIV = "EIV" + """Einsatzverantwortlicher""" + ESA = "ESA" + """Energieserviceanbieter des Anschlussnutzers""" + KN = "KN" + """ Kapazitätsnutzer""" + LF = "LF" + """Lieferant""" + MGV = "MGV" + """Marktgebietsverantwortlicher""" + MSB = "MSB" + """Messstellenbetreiber""" + NB = "NB" + """Netzbetreiber""" + RB = "RB" + """Registerbetreiber""" + UENB = "UENB" + """Übertragungsnetzbetreiber""" diff --git a/src/bo4e/enum/medium.py b/src/bo4e/enum/medium.py index 01bb2301f..4351b56cc 100644 --- a/src/bo4e/enum/medium.py +++ b/src/bo4e/enum/medium.py @@ -7,7 +7,11 @@ class Medium(StrEnum): Gibt ein physikalisches Medium an. """ - STROM = "STROM" #: STROM - GAS = "GAS" #: GAS - WASSER = "WASSER" #: WASSER - DAMPF = "DAMPF" #: DAMPF + STROM = "STROM" + """STROM""" + GAS = "GAS" + """GAS""" + WASSER = "WASSER" + """WASSER""" + DAMPF = "DAMPF" + """DAMPF""" diff --git a/src/bo4e/enum/mengeneinheit.py b/src/bo4e/enum/mengeneinheit.py index ecda9cf2c..4a7935940 100644 --- a/src/bo4e/enum/mengeneinheit.py +++ b/src/bo4e/enum/mengeneinheit.py @@ -8,27 +8,51 @@ class Mengeneinheit(StrEnum): Einheit: Messgrößen, die per Messung oder Vorgabe ermittelt werden können. """ - W = "W" #: Watt - WH = "WH" #: Wattstunde - KW = "KW" #: Kilowatt - KWH = "KWH" #: Kilowattstunde - KVARH = "KVARH" #: Kilovarstunde - MW = "MW" #: Megawatt - MWH = "MWH" #: Megawattstunde - STUECK = "STUECK" #: Stückzahl - KUBIKMETER = "KUBIKMETER" #: Kubikmeter (Gas) - SEKUNDE = "SEKUNDE" #: Sekunde - MINUTE = "MINUTE" #: Minute - STUNDE = "STUNDE" #: Stunde - VIERTEL_STUNDE = "VIERTEL_STUNDE" #: Viertelstunde - TAG = "TAG" #: Tag - WOCHE = "WOCHE" #: Woche - MONAT = "MONAT" #: Monat - QUARTAL = "QUARTAL" #: Quartal - HALBJAHR = "HALBJAHR" #: Halbjahr - JAHR = "JAHR" #: Jahr - PROZENT = "PROZENT" #: Prozent - KVAR = "KVAR" #: Kilovar - KWHK = "KWHK" #: Kilowattstunde pro Kelvin - VAR = "VAR" #: Var - VARH = "VARH" #: Varstunde + W = "W" + """Watt""" + WH = "WH" + """Wattstunde""" + KW = "KW" + """Kilowatt""" + KWH = "KWH" + """Kilowattstunde""" + KVARH = "KVARH" + """Kilovarstunde""" + MW = "MW" + """Megawatt""" + MWH = "MWH" + """Megawattstunde""" + STUECK = "STUECK" + """Stückzahl""" + KUBIKMETER = "KUBIKMETER" + """Kubikmeter (Gas)""" + SEKUNDE = "SEKUNDE" + """Sekunde""" + MINUTE = "MINUTE" + """Minute""" + STUNDE = "STUNDE" + """Stunde""" + VIERTEL_STUNDE = "VIERTEL_STUNDE" + """Viertelstunde""" + TAG = "TAG" + """Tag""" + WOCHE = "WOCHE" + """Woche""" + MONAT = "MONAT" + """Monat""" + QUARTAL = "QUARTAL" + """Quartal""" + HALBJAHR = "HALBJAHR" + """Halbjahr""" + JAHR = "JAHR" + """Jahr""" + PROZENT = "PROZENT" + """Prozent""" + KVAR = "KVAR" + """Kilovar""" + KWHK = "KWHK" + """Kilowattstunde pro Kelvin""" + VAR = "VAR" + """Var""" + VARH = "VARH" + """Varstunde""" diff --git a/src/bo4e/enum/mengenoperator.py b/src/bo4e/enum/mengenoperator.py index 9947e0def..c0388d08b 100644 --- a/src/bo4e/enum/mengenoperator.py +++ b/src/bo4e/enum/mengenoperator.py @@ -7,6 +7,9 @@ class Mengenoperator(StrEnum): Angabe, wie eine Menge in Bezug auf einen Wert zu bilden ist. """ - KLEINER_ALS = "KLEINER_ALS" #: KLEINER_ALS - GROESSER_ALS = "GROESSER_ALS" #: GROESSER_ALS - GLEICH = "GLEICH" #: GLEICH + KLEINER_ALS = "KLEINER_ALS" + """KLEINER_ALS""" + GROESSER_ALS = "GROESSER_ALS" + """GROESSER_ALS""" + GLEICH = "GLEICH" + """GLEICH""" diff --git a/src/bo4e/enum/messart.py b/src/bo4e/enum/messart.py index e293fff9d..736cc8e04 100644 --- a/src/bo4e/enum/messart.py +++ b/src/bo4e/enum/messart.py @@ -7,6 +7,9 @@ class Messart(StrEnum): Gibt an, auf welche Art gemessen wurde. """ - AKTUELLERWERT = "AKTUELLERWERT" #: AKTUELLERWERT - MITTELWERT = "MITTELWERT" #: MITTELWERT - MAXIMALWERT = "MAXIMALWERT" #: MAXIMALWERT + AKTUELLERWERT = "AKTUELLERWERT" + """AKTUELLERWERT""" + MITTELWERT = "MITTELWERT" + """MITTELWERT""" + MAXIMALWERT = "MAXIMALWERT" + """MAXIMALWERT""" diff --git a/src/bo4e/enum/messgroesse.py b/src/bo4e/enum/messgroesse.py index 0ef5511a7..f901812c3 100644 --- a/src/bo4e/enum/messgroesse.py +++ b/src/bo4e/enum/messgroesse.py @@ -7,16 +7,29 @@ class Messgroesse(StrEnum): Gibt die physikalische Größe an, die gemessen wurde. """ - STROM = "STROM" #: Strom - SPANNUNG = "SPANNUNG" #: Spannung - WIRKLEISTUNG = "WIRKLEISTUNG" #: Wirkleistung - BLINDLEISTUNG = "BLINDLEISTUNG" #: Blindleistung - DRUCK = "DRUCK" #: Druck - LASTGANG = "LASTGANG" #: Lastgang - LASTPROFIL = "LASTPROFIL" #: Lastprofil - TEMPERATUR = "TEMPERATUR" #: Temperatur - ZZAHL = "ZZAHL" #: Zustandszahl - BRENNWERT = "BRENNWERT" #: Brennwert - GRADTZAGSZAHLEN = "GRADTZAGSZAHLEN" #: Gradtagszahlen - VOLUMENSTROM = "VOLUMENSTROM" #: Volumenstrom - PREISE = "PREISE" #: Preise + STROM = "STROM" + """Strom""" + SPANNUNG = "SPANNUNG" + """Spannung""" + WIRKLEISTUNG = "WIRKLEISTUNG" + """Wirkleistung""" + BLINDLEISTUNG = "BLINDLEISTUNG" + """Blindleistung""" + DRUCK = "DRUCK" + """Druck""" + LASTGANG = "LASTGANG" + """Lastgang""" + LASTPROFIL = "LASTPROFIL" + """Lastprofil""" + TEMPERATUR = "TEMPERATUR" + """Temperatur""" + ZZAHL = "ZZAHL" + """Zustandszahl""" + BRENNWERT = "BRENNWERT" + """Brennwert""" + GRADTZAGSZAHLEN = "GRADTZAGSZAHLEN" + """Gradtagszahlen""" + VOLUMENSTROM = "VOLUMENSTROM" + """Volumenstrom""" + PREISE = "PREISE" + """Preise""" diff --git a/src/bo4e/enum/messpreistyp.py b/src/bo4e/enum/messpreistyp.py index 5fd87ac6c..8e3922271 100644 --- a/src/bo4e/enum/messpreistyp.py +++ b/src/bo4e/enum/messpreistyp.py @@ -7,27 +7,51 @@ class Messpreistyp(StrEnum): Festlegung, welcher Typ von Messung mit einem Preis belegt wird """ - MESSPREIS_G2_5 = "MESSPREIS_G2_5" #: MESSPREIS_G2_5 - MESSPREIS_G4 = "MESSPREIS_G4" #: MESSPREIS_G4 - MESSPREIS_G6 = "MESSPREIS_G6" #: MESSPREIS_G6 - MESSPREIS_G10 = "MESSPREIS_G10" #: MESSPREIS_G10 - MESSPREIS_G16 = "MESSPREIS_G16" #: MESSPREIS_G16 - MESSPREIS_G25 = "MESSPREIS_G25" #: MESSPREIS_G25 - MESSPREIS_G40 = "MESSPREIS_G40" #: MESSPREIS_G40 - ELEKTRONISCHER_AUFSATZ = "ELEKTRONISCHER_AUFSATZ" #: ELEKTRONISCHER_AUFSATZ - SMART_METER_MESSPREIS_G2_5 = "SMART_METER_MESSPREIS_G2_5" #: SMART_METER_MESSPREIS_G2_5 - SMART_METER_MESSPREIS_G4 = "SMART_METER_MESSPREIS_G4" #: SMART_METER_MESSPREIS_G4 - SMART_METER_MESSPREIS_G6 = "SMART_METER_MESSPREIS_G6" #: SMART_METER_MESSPREIS_G6 - SMART_METER_MESSPREIS_G10 = "SMART_METER_MESSPREIS_G10" #: SMART_METER_MESSPREIS_G10 - SMART_METER_MESSPREIS_G16 = "SMART_METER_MESSPREIS_G16" #: SMART_METER_MESSPREIS_G16 - SMART_METER_MESSPREIS_G25 = "SMART_METER_MESSPREIS_G25" #: SMART_METER_MESSPREIS_G25 - SMART_METER_MESSPREIS_G40 = "SMART_METER_MESSPREIS_G40" #: SMART_METER_MESSPREIS_G40 - VERRECHNUNGSPREIS_ET_WECHSEL = "VERRECHNUNGSPREIS_ET_WECHSEL" #: VERRECHNUNGSPREIS_ET_WECHSEL - VERRECHNUNGSPREIS_ET_DREH = "VERRECHNUNGSPREIS_ET_DREH" #: VERRECHNUNGSPREIS_ET_DREH - VERRECHNUNGSPREIS_ZT_WECHSEL = "VERRECHNUNGSPREIS_ZT_WECHSEL" #: VERRECHNUNGSPREIS_ZT_WECHSEL - VERRECHNUNGSPREIS_ZT_DREH = "VERRECHNUNGSPREIS_ZT_DREH" #: VERRECHNUNGSPREIS_ZT_DREH - VERRECHNUNGSPREIS_L_ET = "VERRECHNUNGSPREIS_L_ET" #: VERRECHNUNGSPREIS_L_ET - VERRECHNUNGSPREIS_L_ZT = "VERRECHNUNGSPREIS_L_ZT" #: VERRECHNUNGSPREIS_L_ZT - VERRECHNUNGSPREIS_SM = "VERRECHNUNGSPREIS_SM" #: VERRECHNUNGSPREIS_SM - AUFSCHLAG_WANDLER = "AUFSCHLAG_WANDLER" #: AUFSCHLAG_WANDLER - AUFSCHLAG_TARIFSCHALTUNG = "AUFSCHLAG_TARIFSCHALTUNG" #: AUFSCHLAG_TARIFSCHALTUNG + MESSPREIS_G2_5 = "MESSPREIS_G2_5" + """MESSPREIS_G2_5""" + MESSPREIS_G4 = "MESSPREIS_G4" + """MESSPREIS_G4""" + MESSPREIS_G6 = "MESSPREIS_G6" + """MESSPREIS_G6""" + MESSPREIS_G10 = "MESSPREIS_G10" + """MESSPREIS_G10""" + MESSPREIS_G16 = "MESSPREIS_G16" + """MESSPREIS_G16""" + MESSPREIS_G25 = "MESSPREIS_G25" + """MESSPREIS_G25""" + MESSPREIS_G40 = "MESSPREIS_G40" + """MESSPREIS_G40""" + ELEKTRONISCHER_AUFSATZ = "ELEKTRONISCHER_AUFSATZ" + """ELEKTRONISCHER_AUFSATZ""" + SMART_METER_MESSPREIS_G2_5 = "SMART_METER_MESSPREIS_G2_5" + """SMART_METER_MESSPREIS_G2_5""" + SMART_METER_MESSPREIS_G4 = "SMART_METER_MESSPREIS_G4" + """SMART_METER_MESSPREIS_G4""" + SMART_METER_MESSPREIS_G6 = "SMART_METER_MESSPREIS_G6" + """SMART_METER_MESSPREIS_G6""" + SMART_METER_MESSPREIS_G10 = "SMART_METER_MESSPREIS_G10" + """SMART_METER_MESSPREIS_G10""" + SMART_METER_MESSPREIS_G16 = "SMART_METER_MESSPREIS_G16" + """SMART_METER_MESSPREIS_G16""" + SMART_METER_MESSPREIS_G25 = "SMART_METER_MESSPREIS_G25" + """SMART_METER_MESSPREIS_G25""" + SMART_METER_MESSPREIS_G40 = "SMART_METER_MESSPREIS_G40" + """SMART_METER_MESSPREIS_G40""" + VERRECHNUNGSPREIS_ET_WECHSEL = "VERRECHNUNGSPREIS_ET_WECHSEL" + """VERRECHNUNGSPREIS_ET_WECHSEL""" + VERRECHNUNGSPREIS_ET_DREH = "VERRECHNUNGSPREIS_ET_DREH" + """VERRECHNUNGSPREIS_ET_DREH""" + VERRECHNUNGSPREIS_ZT_WECHSEL = "VERRECHNUNGSPREIS_ZT_WECHSEL" + """VERRECHNUNGSPREIS_ZT_WECHSEL""" + VERRECHNUNGSPREIS_ZT_DREH = "VERRECHNUNGSPREIS_ZT_DREH" + """VERRECHNUNGSPREIS_ZT_DREH""" + VERRECHNUNGSPREIS_L_ET = "VERRECHNUNGSPREIS_L_ET" + """VERRECHNUNGSPREIS_L_ET""" + VERRECHNUNGSPREIS_L_ZT = "VERRECHNUNGSPREIS_L_ZT" + """VERRECHNUNGSPREIS_L_ZT""" + VERRECHNUNGSPREIS_SM = "VERRECHNUNGSPREIS_SM" + """VERRECHNUNGSPREIS_SM""" + AUFSCHLAG_WANDLER = "AUFSCHLAG_WANDLER" + """AUFSCHLAG_WANDLER""" + AUFSCHLAG_TARIFSCHALTUNG = "AUFSCHLAG_TARIFSCHALTUNG" + """AUFSCHLAG_TARIFSCHALTUNG""" diff --git a/src/bo4e/enum/messwerterfassung.py b/src/bo4e/enum/messwerterfassung.py index 9fbb92607..51edfe91c 100644 --- a/src/bo4e/enum/messwerterfassung.py +++ b/src/bo4e/enum/messwerterfassung.py @@ -7,5 +7,7 @@ class Messwerterfassung(StrEnum): Die Messwerterfassung des Zählers """ - FERNAUSLESBAR = "FERNAUSLESBAR" #: fernauslesbare Zähler - MANUELL_AUSGELESENE = "MANUELL_AUSGELESENE" #: manuell ausgelesene Zähler + FERNAUSLESBAR = "FERNAUSLESBAR" + """fernauslesbare Zähler""" + MANUELL_AUSGELESENE = "MANUELL_AUSGELESENE" + """manuell ausgelesene Zähler""" diff --git a/src/bo4e/enum/messwertstatus.py b/src/bo4e/enum/messwertstatus.py index f56ce2a03..ccbf9d21b 100644 --- a/src/bo4e/enum/messwertstatus.py +++ b/src/bo4e/enum/messwertstatus.py @@ -7,12 +7,21 @@ class Messwertstatus(StrEnum): Der Status eines Zählerstandes """ - ABGELESEN = "ABGELESEN" #: ABGELESEN - ERSATZWERT = "ERSATZWERT" #: ERSATZWERT - ANGABE_FUER_LIEFERSCHEIN = "ANGABE_FUER_LIEFERSCHEIN" #: ANGABE_FUER_LIEFERSCHEIN - VORSCHLAGSWERT = "VORSCHLAGSWERT" #: VORSCHLAGSWERT - NICHT_VERWENDBAR = "NICHT_VERWENDBAR" #: NICHT_VERWENDBAR - PROGNOSEWERT = "PROGNOSEWERT" #: PROGNOSEWERT - VORLAEUFIGERWERT = "VORLAEUFIGERWERT" #: VORLAEUFIGERWERT - ENERGIEMENGESUMMIERT = "ENERGIEMENGESUMMIERT" #: ENERGIEMENGESUMMIERT - FEHLT = "FEHLT" #: FEHLT + ABGELESEN = "ABGELESEN" + """ABGELESEN""" + ERSATZWERT = "ERSATZWERT" + """ERSATZWERT""" + ANGABE_FUER_LIEFERSCHEIN = "ANGABE_FUER_LIEFERSCHEIN" + """ANGABE_FUER_LIEFERSCHEIN""" + VORSCHLAGSWERT = "VORSCHLAGSWERT" + """VORSCHLAGSWERT""" + NICHT_VERWENDBAR = "NICHT_VERWENDBAR" + """NICHT_VERWENDBAR""" + PROGNOSEWERT = "PROGNOSEWERT" + """PROGNOSEWERT""" + VORLAEUFIGERWERT = "VORLAEUFIGERWERT" + """VORLAEUFIGERWERT""" + ENERGIEMENGESUMMIERT = "ENERGIEMENGESUMMIERT" + """ENERGIEMENGESUMMIERT""" + FEHLT = "FEHLT" + """FEHLT""" diff --git a/src/bo4e/enum/messwertstatuszusatz.py b/src/bo4e/enum/messwertstatuszusatz.py index 92aadc703..70e0840a0 100644 --- a/src/bo4e/enum/messwertstatuszusatz.py +++ b/src/bo4e/enum/messwertstatuszusatz.py @@ -7,47 +7,81 @@ class Messwertstatuszusatz(StrEnum): Aufzählung von zusätzlichen Informationen zum Status, beispielsweise in Lastgängen oder Zählwerkständen. """ - Z84_LEERSTAND = "Z84_LEERSTAND" #: Z84_LEERSTAND - Z85_REALERZAEHLERUEBERLAUFGEPRUEFT = "Z85_REALERZAEHLERUEBERLAUFGEPRUEFT" #: Z85_REALERZAEHLERUEBERLAUFGEPRUEFT - Z86_PLAUSIBELWGKONTROLLABLESUNG = "Z86_PLAUSIBELWGKONTROLLABLESUNG" #: Z86_PLAUSIBELWGKONTROLLABLESUNG - Z87_PLAUSIBELWGKUNDENHINWEIS = "Z87_PLAUSIBELWGKUNDENHINWEIS" #: Z87_PLAUSIBELWGKUNDENHINWEIS - ZC3_AUSTAUSCHDESERSATZWERTES = "ZC3_AUSTAUSCHDESERSATZWERTES" #: ZC3_AUSTAUSCHDESERSATZWERTES - Z88_VERGLEICHSMESSUNG_GEEICHT = "Z88_VERGLEICHSMESSUNG(GEEICHT)" #: Z88_VERGLEICHSMESSUNG(GEEICHT) - Z89_VERGLEICHSMESSUNG_NICHTGEEICHT = "Z89_VERGLEICHSMESSUNG(NICHTGEEICHT)" #: Z89_VERGLEICHSMESSUNG(NICHTGEEICHT) - #: Z90_MESSWERTNACHBILDUNGAUSGEEICHTENWERTEN + Z84_LEERSTAND = "Z84_LEERSTAND" + """Z84_LEERSTAND""" + Z85_REALERZAEHLERUEBERLAUFGEPRUEFT = "Z85_REALERZAEHLERUEBERLAUFGEPRUEFT" + """Z85_REALERZAEHLERUEBERLAUFGEPRUEFT""" + Z86_PLAUSIBELWGKONTROLLABLESUNG = "Z86_PLAUSIBELWGKONTROLLABLESUNG" + """Z86_PLAUSIBELWGKONTROLLABLESUNG""" + Z87_PLAUSIBELWGKUNDENHINWEIS = "Z87_PLAUSIBELWGKUNDENHINWEIS" + """Z87_PLAUSIBELWGKUNDENHINWEIS""" + ZC3_AUSTAUSCHDESERSATZWERTES = "ZC3_AUSTAUSCHDESERSATZWERTES" + """ZC3_AUSTAUSCHDESERSATZWERTES""" + Z88_VERGLEICHSMESSUNG_GEEICHT = "Z88_VERGLEICHSMESSUNG(GEEICHT)" + """Z88_VERGLEICHSMESSUNG(GEEICHT)""" + Z89_VERGLEICHSMESSUNG_NICHTGEEICHT = "Z89_VERGLEICHSMESSUNG(NICHTGEEICHT)" + """Z89_VERGLEICHSMESSUNG(NICHTGEEICHT)""" Z90_MESSWERTNACHBILDUNGAUSGEEICHTENWERTEN = "Z90_MESSWERTNACHBILDUNGAUSGEEICHTENWERTEN" - #: Z91_MESSWERTNACHBILDUNGAUSNICHTGEEICHTENWERTEN + """Z90_MESSWERTNACHBILDUNGAUSGEEICHTENWERTEN""" Z91_MESSWERTNACHBILDUNGAUSNICHTGEEICHTENWERTEN = "Z91_MESSWERTNACHBILDUNGAUSNICHTGEEICHTENWERTEN" - Z92_INTERPOLATION = "Z92_INTERPOLATION" #: Z92_INTERPOLATION - Z93_HALTEWERT = "Z93_HALTEWERT" #: Z93_HALTEWERT - Z94_BILANZIERUNGNETZABSCHNITT = "Z94_BILANZIERUNGNETZABSCHNITT" #: Z94_BILANZIERUNGNETZABSCHNITT - Z95_HISTORISCHEMESSWERTE = "Z95_HISTORISCHEMESSWERTE" #: Z95_HISTORISCHEMESSWERTE - ZJ2_STATISTISCHEMETHODE = "ZJ2_STATISTISCHEMETHODE" #: ZJ2_STATISTISCHEMETHODE - Z74_KEINZUGANG = "Z74_KEINZUGANG" #: Z74_KEINZUGANG - Z75_KOMMUNIKATIONSSTOERUNG = "Z75_KOMMUNIKATIONSSTOERUNG" #: Z75_KOMMUNIKATIONSSTOERUNG - Z76_NETZAUSFALL = "Z76_NETZAUSFALL" #: Z76_NETZAUSFALL - Z77_SPANNUNGSAUSFALL = "Z77_SPANNUNGSAUSFALL" #: Z77_SPANNUNGSAUSFALL - Z78_GERAETEWECHSEL = "Z78_GERAETEWECHSEL" #: Z78_GERAETEWECHSEL - Z79_KALIBRIERUNG = "Z79_KALIBRIERUNG" #: Z79_KALIBRIERUNG - #: Z80_GERAETARBEITETAUSSERHALBDERBETRIEBSBEDINGUNGEN + """Z91_MESSWERTNACHBILDUNGAUSNICHTGEEICHTENWERTEN""" + Z92_INTERPOLATION = "Z92_INTERPOLATION" + """Z92_INTERPOLATION""" + Z93_HALTEWERT = "Z93_HALTEWERT" + """Z93_HALTEWERT""" + Z94_BILANZIERUNGNETZABSCHNITT = "Z94_BILANZIERUNGNETZABSCHNITT" + """Z94_BILANZIERUNGNETZABSCHNITT""" + Z95_HISTORISCHEMESSWERTE = "Z95_HISTORISCHEMESSWERTE" + """Z95_HISTORISCHEMESSWERTE""" + ZJ2_STATISTISCHEMETHODE = "ZJ2_STATISTISCHEMETHODE" + """ZJ2_STATISTISCHEMETHODE""" + Z74_KEINZUGANG = "Z74_KEINZUGANG" + """Z74_KEINZUGANG""" + Z75_KOMMUNIKATIONSSTOERUNG = "Z75_KOMMUNIKATIONSSTOERUNG" + """Z75_KOMMUNIKATIONSSTOERUNG""" + Z76_NETZAUSFALL = "Z76_NETZAUSFALL" + """Z76_NETZAUSFALL""" + Z77_SPANNUNGSAUSFALL = "Z77_SPANNUNGSAUSFALL" + """Z77_SPANNUNGSAUSFALL""" + Z78_GERAETEWECHSEL = "Z78_GERAETEWECHSEL" + """Z78_GERAETEWECHSEL""" + Z79_KALIBRIERUNG = "Z79_KALIBRIERUNG" + """Z79_KALIBRIERUNG""" Z80_GERAETARBEITETAUSSERHALBDERBETRIEBSBEDINGUNGEN = "Z80_GERAETARBEITETAUSSERHALBDERBETRIEBSBEDINGUNGEN" - Z81_MESSEINRICHTUNGGESTOERT_DEFEKT = "Z81_MESSEINRICHTUNGGESTOERT_DEFEKT" #: Z81_MESSEINRICHTUNGGESTOERT_DEFEKT - Z82_UNSICHERHEITMESSUNG = "Z82_UNSICHERHEITMESSUNG" #: Z82_UNSICHERHEITMESSUNG - #: Z98_BERUECKSICHTIGUNGSTOERMENGENZAEHLWERK + """Z80_GERAETARBEITETAUSSERHALBDERBETRIEBSBEDINGUNGEN""" + Z81_MESSEINRICHTUNGGESTOERT_DEFEKT = "Z81_MESSEINRICHTUNGGESTOERT_DEFEKT" + """Z81_MESSEINRICHTUNGGESTOERT_DEFEKT""" + Z82_UNSICHERHEITMESSUNG = "Z82_UNSICHERHEITMESSUNG" + """Z82_UNSICHERHEITMESSUNG""" Z98_BERUECKSICHTIGUNGSTOERMENGENZAEHLWERK = "Z98_BERUECKSICHTIGUNGSTOERMENGENZAEHLWERK" - Z99_MENGENUMWERTUNGUNVOLLSTAENDIG = "Z99_MENGENUMWERTUNGUNVOLLSTAENDIG" #: Z99_MENGENUMWERTUNGUNVOLLSTAENDIG - ZA0_UHRZEITGESTELLT_SYNCHRONISATION = "ZA0_UHRZEITGESTELLT_SYNCHRONISATION" #: ZA0_UHRZEITGESTELLT_SYNCHRONISATION - ZA1_MESSWERTUNPLAUSIBEL = "ZA1_MESSWERTUNPLAUSIBEL" #: ZA1_MESSWERTUNPLAUSIBEL - ZC2_TARIFSCHALTGERAETDEFEKT = "ZC2_TARIFSCHALTGERAETDEFEKT" #: ZC2_TARIFSCHALTGERAETDEFEKT - #: ZC4_IMPULSWERTIGKEITNICHTAUSREICHEND + """Z98_BERUECKSICHTIGUNGSTOERMENGENZAEHLWERK""" + Z99_MENGENUMWERTUNGUNVOLLSTAENDIG = "Z99_MENGENUMWERTUNGUNVOLLSTAENDIG" + """Z99_MENGENUMWERTUNGUNVOLLSTAENDIG""" + ZA0_UHRZEITGESTELLT_SYNCHRONISATION = "ZA0_UHRZEITGESTELLT_SYNCHRONISATION" + """ZA0_UHRZEITGESTELLT_SYNCHRONISATION""" + ZA1_MESSWERTUNPLAUSIBEL = "ZA1_MESSWERTUNPLAUSIBEL" + """ZA1_MESSWERTUNPLAUSIBEL""" + ZC2_TARIFSCHALTGERAETDEFEKT = "ZC2_TARIFSCHALTGERAETDEFEKT" + """ZC2_TARIFSCHALTGERAETDEFEKT""" ZC4_IMPULSWERTIGKEITNICHTAUSREICHEND = "ZC4_IMPULSWERTIGKEITNICHTAUSREICHEND" - ZA3_FALSCHERWANDLERFAKTOR = "ZA3_FALSCHERWANDLERFAKTOR" #: ZA3_FALSCHERWANDLERFAKTOR - ZA4_FEHLERHAFTEABLESUNG = "ZA4_FEHLERHAFTEABLESUNG" #: ZA4_FEHLERHAFTEABLESUNG - ZA5_AENDERUNGDERBERECHNUNG = "ZA5_AENDERUNGDERBERECHNUNG" #: ZA5_AENDERUNGDERBERECHNUNG - ZA6_UMBAUDERMESSLOKATION = "ZA6_UMBAUDERMESSLOKATION" #: ZA6_UMBAUDERMESSLOKATION - ZA7_DATENBEARBEITUNGSFEHLER = "ZA7_DATENBEARBEITUNGSFEHLER" #: ZA7_DATENBEARBEITUNGSFEHLER - ZA8_BRENNWERTKORREKTUR = "ZA8_BRENNWERTKORREKTUR" #: ZA8_BRENNWERTKORREKTUR - ZA9_Z_ZAHL_KORREKTUR = "ZA9_Z-ZAHL-KORREKTUR" #: ZA9_Z-ZAHL-KORREKTUR - ZB0_STOERUNG_DEFEKTMESSEINRICHTUNG = "ZB0_STOERUNG_DEFEKTMESSEINRICHTUNG" #: ZB0_STOERUNG_DEFEKTMESSEINRICHTUNG - ZB9_AENDERUNGTARIFSCHALTZEITEN = "ZB9_AENDERUNGTARIFSCHALTZEITEN" #: ZB9_AENDERUNGTARIFSCHALTZEITEN - ZG3_UMSTELLUNGGASQUALITAET = "ZG3_UMSTELLUNGGASQUALITAET" #: ZG3_UMSTELLUNGGASQUALITAET + """ZC4_IMPULSWERTIGKEITNICHTAUSREICHEND""" + ZA3_FALSCHERWANDLERFAKTOR = "ZA3_FALSCHERWANDLERFAKTOR" + """ZA3_FALSCHERWANDLERFAKTOR""" + ZA4_FEHLERHAFTEABLESUNG = "ZA4_FEHLERHAFTEABLESUNG" + """ZA4_FEHLERHAFTEABLESUNG""" + ZA5_AENDERUNGDERBERECHNUNG = "ZA5_AENDERUNGDERBERECHNUNG" + """ZA5_AENDERUNGDERBERECHNUNG""" + ZA6_UMBAUDERMESSLOKATION = "ZA6_UMBAUDERMESSLOKATION" + """ZA6_UMBAUDERMESSLOKATION""" + ZA7_DATENBEARBEITUNGSFEHLER = "ZA7_DATENBEARBEITUNGSFEHLER" + """ZA7_DATENBEARBEITUNGSFEHLER""" + ZA8_BRENNWERTKORREKTUR = "ZA8_BRENNWERTKORREKTUR" + """ZA8_BRENNWERTKORREKTUR""" + ZA9_Z_ZAHL_KORREKTUR = "ZA9_Z-ZAHL-KORREKTUR" + """ZA9_Z-ZAHL-KORREKTUR""" + ZB0_STOERUNG_DEFEKTMESSEINRICHTUNG = "ZB0_STOERUNG_DEFEKTMESSEINRICHTUNG" + """ZB0_STOERUNG_DEFEKTMESSEINRICHTUNG""" + ZB9_AENDERUNGTARIFSCHALTZEITEN = "ZB9_AENDERUNGTARIFSCHALTZEITEN" + """ZB9_AENDERUNGTARIFSCHALTZEITEN""" + ZG3_UMSTELLUNGGASQUALITAET = "ZG3_UMSTELLUNGGASQUALITAET" + """ZG3_UMSTELLUNGGASQUALITAET""" diff --git a/src/bo4e/enum/netzebene.py b/src/bo4e/enum/netzebene.py index 312e852e0..66d47f49c 100644 --- a/src/bo4e/enum/netzebene.py +++ b/src/bo4e/enum/netzebene.py @@ -8,13 +8,23 @@ class Netzebene(StrEnum): Auflistung möglicher Netzebenen innerhalb der Energiearten Strom und Gas. """ - NSP = "NSP" #: Niederspannung; Strom - MSP = "MSP" #: Mittelspannung; Strom - HSP = "HSP" #: Hochspannung; Strom - HSS = "HSS" #: Hoechstspannung; Strom - MSP_NSP_UMSP = "MSP_NSP_UMSP" #: MS/NS Umspannung; Strom - HSP_MSP_UMSP = "HSP_MSP_UMSP" #: HS/MS Umspannung; Strom - HSS_HSP_UMSP = "HSS_HSP_UMSP" #: HOES/HS Umspannung; Strom - HD = "HD" #: Hochdruck; Gas - MD = "MD" #: Mitteldruck; Gas - ND = "ND" #: Niederdruck; Gas + NSP = "NSP" + """Niederspannung; Strom""" + MSP = "MSP" + """Mittelspannung; Strom""" + HSP = "HSP" + """Hochspannung; Strom""" + HSS = "HSS" + """Hoechstspannung; Strom""" + MSP_NSP_UMSP = "MSP_NSP_UMSP" + """MS/NS Umspannung; Strom""" + HSP_MSP_UMSP = "HSP_MSP_UMSP" + """HS/MS Umspannung; Strom""" + HSS_HSP_UMSP = "HSS_HSP_UMSP" + """HOES/HS Umspannung; Strom""" + HD = "HD" + """Hochdruck; Gas""" + MD = "MD" + """Mitteldruck; Gas""" + ND = "ND" + """Niederdruck; Gas""" diff --git a/src/bo4e/enum/netznutzungrechnungsart.py b/src/bo4e/enum/netznutzungrechnungsart.py index 881d73799..c0bc97688 100644 --- a/src/bo4e/enum/netznutzungrechnungsart.py +++ b/src/bo4e/enum/netznutzungrechnungsart.py @@ -7,5 +7,7 @@ class NetznutzungRechnungsart(StrEnum): Abbildung verschiedener in der INVOIC angegebenen Rechnungsarten. """ - HANDELSRECHNUNG = "HANDELSRECHNUNG" #: HANDELSRECHNUNG - SELBSTAUSGESTELLT = "SELBSTAUSGESTELLT" #: SELBSTAUSGESTELLT + HANDELSRECHNUNG = "HANDELSRECHNUNG" + """HANDELSRECHNUNG""" + SELBSTAUSGESTELLT = "SELBSTAUSGESTELLT" + """SELBSTAUSGESTELLT""" diff --git a/src/bo4e/enum/netznutzungrechnungstyp.py b/src/bo4e/enum/netznutzungrechnungstyp.py index da9d996c0..e0b5915a3 100644 --- a/src/bo4e/enum/netznutzungrechnungstyp.py +++ b/src/bo4e/enum/netznutzungrechnungstyp.py @@ -7,12 +7,21 @@ class NetznutzungRechnungstyp(StrEnum): Abbildung verschiedener in der INVOIC angegebenen Rechnungstypen. """ - ABSCHLUSSRECHNUNG = "ABSCHLUSSRECHNUNG" #: ABSCHLUSSRECHNUNG - ABSCHLAGSRECHNUNG = "ABSCHLAGSRECHNUNG" #: ABSCHLAGSRECHNUNG - TURNUSRECHNUNG = "TURNUSRECHNUNG" #: TURNUSRECHNUNG - MONATSRECHNUNG = "MONATSRECHNUNG" #: MONATSRECHNUNG - WIMRECHNUNG = "WIMRECHNUNG" #: WIMRECHNUNG - ZWISCHENRECHNUNG = "ZWISCHENRECHNUNG" #: ZWISCHENRECHNUNG - INTEGRIERTE_13TE_RECHNUNG = "INTEGRIERTE_13TE_RECHNUNG" #: INTEGRIERTE_13TE_RECHNUNG - ZUSAETZLICHE_13TE_RECHNUNG = "ZUSAETZLICHE_13TE_RECHNUNG" #: ZUSAETZLICHE_13TE_RECHNUNG - MEHRMINDERMENGENRECHNUNG = "MEHRMINDERMENGENRECHNUNG" #: MEHRMINDERMENGENRECHNUNG + ABSCHLUSSRECHNUNG = "ABSCHLUSSRECHNUNG" + """ABSCHLUSSRECHNUNG""" + ABSCHLAGSRECHNUNG = "ABSCHLAGSRECHNUNG" + """ABSCHLAGSRECHNUNG""" + TURNUSRECHNUNG = "TURNUSRECHNUNG" + """TURNUSRECHNUNG""" + MONATSRECHNUNG = "MONATSRECHNUNG" + """MONATSRECHNUNG""" + WIMRECHNUNG = "WIMRECHNUNG" + """WIMRECHNUNG""" + ZWISCHENRECHNUNG = "ZWISCHENRECHNUNG" + """ZWISCHENRECHNUNG""" + INTEGRIERTE_13TE_RECHNUNG = "INTEGRIERTE_13TE_RECHNUNG" + """INTEGRIERTE_13TE_RECHNUNG""" + ZUSAETZLICHE_13TE_RECHNUNG = "ZUSAETZLICHE_13TE_RECHNUNG" + """ZUSAETZLICHE_13TE_RECHNUNG""" + MEHRMINDERMENGENRECHNUNG = "MEHRMINDERMENGENRECHNUNG" + """MEHRMINDERMENGENRECHNUNG""" diff --git a/src/bo4e/enum/oekolabel.py b/src/bo4e/enum/oekolabel.py index 944130b4b..9892518b4 100644 --- a/src/bo4e/enum/oekolabel.py +++ b/src/bo4e/enum/oekolabel.py @@ -7,15 +7,27 @@ class Oekolabel(StrEnum): Aufzählung der Labels für Öko-Strom von verschiedenen Herausgebern. """ - ENERGREEN = "ENERGREEN" #: ENERGREEN - GASGREEN_GRUENER_STROM = "GASGREEN_GRUENER_STROM" #: GASGREEN_GRUENER_STROM - GASGREEN = "GASGREEN" #: GASGREEN - GRUENER_STROM_GOLD = "GRUENER_STROM_GOLD" #: GRUENER_STROM_GOLD - GRUENER_STROM_SILBER = "GRUENER_STROM_SILBER" #: GRUENER_STROM_SILBER - GRUENER_STROM = "GRUENER_STROM" #: GRUENER_STROM - GRUENES_GAS = "GRUENES_GAS" #: GRUENES_GAS - NATURWATT_STROM = "NATURWATT_STROM" #: NATURWATT_STROM - OK_POWER = "OK_POWER" #: OK_POWER - RENEWABLE_PLUS = "RENEWABLE_PLUS" #: RENEWABLE_PLUS - WATERGREEN = "WATERGREEN" #: WATERGREEN - WATERGREEN_PLUS = "WATERGREEN_PLUS" #: WATERGREEN_PLUS + ENERGREEN = "ENERGREEN" + """ENERGREEN""" + GASGREEN_GRUENER_STROM = "GASGREEN_GRUENER_STROM" + """GASGREEN_GRUENER_STROM""" + GASGREEN = "GASGREEN" + """GASGREEN""" + GRUENER_STROM_GOLD = "GRUENER_STROM_GOLD" + """GRUENER_STROM_GOLD""" + GRUENER_STROM_SILBER = "GRUENER_STROM_SILBER" + """GRUENER_STROM_SILBER""" + GRUENER_STROM = "GRUENER_STROM" + """GRUENER_STROM""" + GRUENES_GAS = "GRUENES_GAS" + """GRUENES_GAS""" + NATURWATT_STROM = "NATURWATT_STROM" + """NATURWATT_STROM""" + OK_POWER = "OK_POWER" + """OK_POWER""" + RENEWABLE_PLUS = "RENEWABLE_PLUS" + """RENEWABLE_PLUS""" + WATERGREEN = "WATERGREEN" + """WATERGREEN""" + WATERGREEN_PLUS = "WATERGREEN_PLUS" + """WATERGREEN_PLUS""" diff --git a/src/bo4e/enum/oekozertifikat.py b/src/bo4e/enum/oekozertifikat.py index 6100cb1e3..19ff71937 100644 --- a/src/bo4e/enum/oekozertifikat.py +++ b/src/bo4e/enum/oekozertifikat.py @@ -7,20 +7,37 @@ class Oekozertifikat(StrEnum): Zertifikate für Ökostrom von verschiedenen Herausgebern. """ - CMS_EE01 = "CMS_EE01" #: CMS_EE01 - CMS_EE02 = "CMS_EE02" #: CMS_EE02 - EECS = "EECS" #: EECS - FRAUNHOFER = "FRAUNHOFER" #: FRAUNHOFER - BET = "BET" #: BET - KLIMA_INVEST = "KLIMA_INVEST" #: KLIMA_INVEST - LGA = "LGA" #: LGA - FREIBERG = "FREIBERG" #: FREIBERG - RECS = "RECS" #: RECS - REGS_EGL = "REGS_EGL" #: REGS_EGL - TUEV = "TUEV" #: TUEV - TUEV_HESSEN = "TUEV_HESSEN" #: TUEV_HESSEN - TUEV_NORD = "TUEV_NORD" #: TUEV_NORD - TUEV_RHEINLAND = "TUEV_RHEINLAND" #: TUEV_RHEINLAND - TUEV_SUED = "TUEV_SUED" #: TUEV_SUED - TUEV_SUED_EE01 = "TUEV_SUED_EE01" #: TUEV_SUED_EE01 - TUEV_SUED_EE02 = "TUEV_SUED_EE02" #: TUEV_SUED_EE02 + CMS_EE01 = "CMS_EE01" + """CMS_EE01""" + CMS_EE02 = "CMS_EE02" + """CMS_EE02""" + EECS = "EECS" + """EECS""" + FRAUNHOFER = "FRAUNHOFER" + """FRAUNHOFER""" + BET = "BET" + """BET""" + KLIMA_INVEST = "KLIMA_INVEST" + """KLIMA_INVEST""" + LGA = "LGA" + """LGA""" + FREIBERG = "FREIBERG" + """FREIBERG""" + RECS = "RECS" + """RECS""" + REGS_EGL = "REGS_EGL" + """REGS_EGL""" + TUEV = "TUEV" + """TUEV""" + TUEV_HESSEN = "TUEV_HESSEN" + """TUEV_HESSEN""" + TUEV_NORD = "TUEV_NORD" + """TUEV_NORD""" + TUEV_RHEINLAND = "TUEV_RHEINLAND" + """TUEV_RHEINLAND""" + TUEV_SUED = "TUEV_SUED" + """TUEV_SUED""" + TUEV_SUED_EE01 = "TUEV_SUED_EE01" + """TUEV_SUED_EE01""" + TUEV_SUED_EE02 = "TUEV_SUED_EE02" + """TUEV_SUED_EE02""" diff --git a/src/bo4e/enum/organisationstyp.py b/src/bo4e/enum/organisationstyp.py index 2142204b6..27e4eff98 100644 --- a/src/bo4e/enum/organisationstyp.py +++ b/src/bo4e/enum/organisationstyp.py @@ -7,7 +7,11 @@ class Organisationstyp(StrEnum): Hier wird festgelegt, ob der Geschäftspartner eine Person, eine Firma oder etwas anderes ist. """ - PRIVATPERSON = "PRIVATPERSON" #: B2C - UNTERNEHMEN = "UNTERNEHMEN" #: B2B - KOMMUNALE_EINRICHTUNG = "KOMMUNALE_EINRICHTUNG" #: B2A - STAATLICHE_BEHOERDE = "STAATLICHE_BEHOERDE" #: B2G + PRIVATPERSON = "PRIVATPERSON" + """B2C""" + UNTERNEHMEN = "UNTERNEHMEN" + """B2B""" + KOMMUNALE_EINRICHTUNG = "KOMMUNALE_EINRICHTUNG" + """B2A""" + STAATLICHE_BEHOERDE = "STAATLICHE_BEHOERDE" + """B2G""" diff --git a/src/bo4e/enum/preisgarantietyp.py b/src/bo4e/enum/preisgarantietyp.py index 09a38242a..24f5b8e7d 100644 --- a/src/bo4e/enum/preisgarantietyp.py +++ b/src/bo4e/enum/preisgarantietyp.py @@ -7,7 +7,11 @@ class Preisgarantietyp(StrEnum): Aufzählung der Möglichkeiten für die Vergabe von Preisgarantien """ - ALLE_PREISBESTANDTEILE_BRUTTO = "ALLE_PREISBESTANDTEILE_BRUTTO" #: ALLE_PREISBESTANDTEILE_BRUTTO - ALLE_PREISBESTANDTEILE_NETTO = "ALLE_PREISBESTANDTEILE_NETTO" #: ALLE_PREISBESTANDTEILE_NETTO - PREISBESTANDTEILE_OHNE_ABGABEN = "PREISBESTANDTEILE_OHNE_ABGABEN" #: PREISBESTANDTEILE_OHNE_ABGABEN - NUR_ENERGIEPREIS = "NUR_ENERGIEPREIS" #: NUR_ENERGIEPREIS + ALLE_PREISBESTANDTEILE_BRUTTO = "ALLE_PREISBESTANDTEILE_BRUTTO" + """ALLE_PREISBESTANDTEILE_BRUTTO""" + ALLE_PREISBESTANDTEILE_NETTO = "ALLE_PREISBESTANDTEILE_NETTO" + """ALLE_PREISBESTANDTEILE_NETTO""" + PREISBESTANDTEILE_OHNE_ABGABEN = "PREISBESTANDTEILE_OHNE_ABGABEN" + """PREISBESTANDTEILE_OHNE_ABGABEN""" + NUR_ENERGIEPREIS = "NUR_ENERGIEPREIS" + """NUR_ENERGIEPREIS""" diff --git a/src/bo4e/enum/preismodell.py b/src/bo4e/enum/preismodell.py index c53d22d48..06c11f19a 100644 --- a/src/bo4e/enum/preismodell.py +++ b/src/bo4e/enum/preismodell.py @@ -7,5 +7,7 @@ class Preismodell(StrEnum): Bezeichnung der Preismodelle in Ausschreibungen für die Energielieferung. """ - FESTPREIS = "FESTPREIS" #: FESTPREIS - TRANCHE = "TRANCHE" #: TRANCHE + FESTPREIS = "FESTPREIS" + """FESTPREIS""" + TRANCHE = "TRANCHE" + """TRANCHE""" diff --git a/src/bo4e/enum/preisstatus.py b/src/bo4e/enum/preisstatus.py index c30881958..064ec69a3 100644 --- a/src/bo4e/enum/preisstatus.py +++ b/src/bo4e/enum/preisstatus.py @@ -7,5 +7,7 @@ class Preisstatus(StrEnum): Statusinformation für Preise """ - VORLAEUFIG = "VORLAEUFIG" #: vorläufig - ENDGUELTIG = "ENDGUELTIG" #: endgültig + VORLAEUFIG = "VORLAEUFIG" + """vorläufig""" + ENDGUELTIG = "ENDGUELTIG" + """endgültig""" diff --git a/src/bo4e/enum/preistyp.py b/src/bo4e/enum/preistyp.py index 90ad7e966..12602c9a0 100644 --- a/src/bo4e/enum/preistyp.py +++ b/src/bo4e/enum/preistyp.py @@ -7,13 +7,23 @@ class Preistyp(StrEnum): Aufschlüsselung der Preistypen in Tarifen. """ - GRUNDPREIS = "GRUNDPREIS" #: Grundpreis - ARBEITSPREIS_EINTARIF = "ARBEITSPREIS_EINTARIF" #: Arbeitspreis_ET - ARBEITSPREIS_HT = "ARBEITSPREIS_HT" #: Arbeitspreis_HT - ARBEITSPREIS_NT = "ARBEITSPREIS_NT" #: Arbeitspreis_NT - LEISTUNGSPREIS = "LEISTUNGSPREIS" #: Leistungspreis - MESSPREIS = "MESSPREIS" #: Messpreis - ENTGELT_ABLESUNG = "ENTGELT_ABLESUNG" #: Entgelt fuer Ablesung - ENTGELT_ABRECHNUNG = "ENTGELT_ABRECHNUNG" #: Entgelt fuer Abrechnung - ENTGELT_MSB = "ENTGELT_MSB" #: Entgelt für MSB (Entgelt für Einbau, Betrieb und Wartung der Messtechnik) - PROVISION = "PROVISION" #: Provision + GRUNDPREIS = "GRUNDPREIS" + """Grundpreis""" + ARBEITSPREIS_EINTARIF = "ARBEITSPREIS_EINTARIF" + """Arbeitspreis_ET""" + ARBEITSPREIS_HT = "ARBEITSPREIS_HT" + """Arbeitspreis_HT""" + ARBEITSPREIS_NT = "ARBEITSPREIS_NT" + """Arbeitspreis_NT""" + LEISTUNGSPREIS = "LEISTUNGSPREIS" + """Leistungspreis""" + MESSPREIS = "MESSPREIS" + """Messpreis""" + ENTGELT_ABLESUNG = "ENTGELT_ABLESUNG" + """Entgelt fuer Ablesung""" + ENTGELT_ABRECHNUNG = "ENTGELT_ABRECHNUNG" + """Entgelt fuer Abrechnung""" + ENTGELT_MSB = "ENTGELT_MSB" + """Entgelt für MSB (Entgelt für Einbau, Betrieb und Wartung der Messtechnik)""" + PROVISION = "PROVISION" + """Provision""" diff --git a/src/bo4e/enum/rechnungslegung.py b/src/bo4e/enum/rechnungslegung.py index 71f1fbf69..cd937c136 100644 --- a/src/bo4e/enum/rechnungslegung.py +++ b/src/bo4e/enum/rechnungslegung.py @@ -7,8 +7,13 @@ class Rechnungslegung(StrEnum): Aufzählung der Möglichkeiten zur Rechnungslegung in Ausschreibungen. """ - MONATSRECHN = "MONATSRECHN" #: monatsscharfe Rechnung - ABSCHL_MONATSRECHN = "ABSCHL_MONATSRECHN" #: Abschlag mit Monatsrechnung - ABSCHL_JAHRESRECHN = "ABSCHL_JAHRESRECHN" #: Abschlag mit Jahresrechnung - MONATSRECHN_JAHRESRECHN = "MONATSRECHN_JAHRESRECHN" #: Monatsrechnung mit Jahresrechnung - VORKASSE = "VORKASSE" #: Vorkasse + MONATSRECHN = "MONATSRECHN" + """monatsscharfe Rechnung""" + ABSCHL_MONATSRECHN = "ABSCHL_MONATSRECHN" + """Abschlag mit Monatsrechnung""" + ABSCHL_JAHRESRECHN = "ABSCHL_JAHRESRECHN" + """Abschlag mit Jahresrechnung""" + MONATSRECHN_JAHRESRECHN = "MONATSRECHN_JAHRESRECHN" + """Monatsrechnung mit Jahresrechnung""" + VORKASSE = "VORKASSE" + """Vorkasse""" diff --git a/src/bo4e/enum/rechnungsstatus.py b/src/bo4e/enum/rechnungsstatus.py index 4c2a9fcbb..9ca851ffb 100644 --- a/src/bo4e/enum/rechnungsstatus.py +++ b/src/bo4e/enum/rechnungsstatus.py @@ -7,8 +7,13 @@ class Rechnungsstatus(StrEnum): Abbildung verschiedener Zustände, die im Rahmen der Rechnungsbearbeitung durchlaufen werden. """ - UNGEPRUEFT = "UNGEPRUEFT" #: Die Rechnung wurde erstellt bzw ist eingegangen, wurde aber noch nicht geprüft. - GEPRUEFT_OK = "GEPRUEFT_OK" #: Die Rechnung wurde geprüft und als korrekt befunden. - GEPRUEFT_FEHLERHAFT = "GEPRUEFT_FEHLERHAFT" #: Bei der Prüfung der Rechnung hat sich herausgestellt, dass die Rechnung Fehler aufweist. - GEBUCHT = "GEBUCHT" #: Die Buchhaltung hat die Rechnung aufgenommen und berücksichtigt. - BEZAHLT = "BEZAHLT" #: Die Rechnung wurde beglichen. + UNGEPRUEFT = "UNGEPRUEFT" + """Die Rechnung wurde erstellt bzw ist eingegangen, wurde aber noch nicht geprüft.""" + GEPRUEFT_OK = "GEPRUEFT_OK" + """Die Rechnung wurde geprüft und als korrekt befunden.""" + GEPRUEFT_FEHLERHAFT = "GEPRUEFT_FEHLERHAFT" + """Bei der Prüfung der Rechnung hat sich herausgestellt, dass die Rechnung Fehler aufweist.""" + GEBUCHT = "GEBUCHT" + """Die Buchhaltung hat die Rechnung aufgenommen und berücksichtigt.""" + BEZAHLT = "BEZAHLT" + """Die Rechnung wurde beglichen.""" diff --git a/src/bo4e/enum/rechnungstyp.py b/src/bo4e/enum/rechnungstyp.py index df1c066d7..37d120e54 100644 --- a/src/bo4e/enum/rechnungstyp.py +++ b/src/bo4e/enum/rechnungstyp.py @@ -7,11 +7,15 @@ class Rechnungstyp(StrEnum): Abbildung verschiedener Rechnungstypen zur Kennzeichnung von Rechnungen """ - #: Eine Rechnung vom Lieferanten an einen Endkunden über die Lieferung von Energie. ENDKUNDENRECHNUNG = "ENDKUNDENRECHNUNG" - NETZNUTZUNGSRECHNUNG = "NETZNUTZUNGSRECHNUNG" #: Eine Rechnung vom Netzbetreiber an den Netznutzer. (i.d.R. der Lieferant) über die Netznutzung. - MEHRMINDERMENGENRECHNUNG = "MEHRMINDERMENGENRECHNUNG" #: Eine Rechnung vom Netzbetreiber an den Netznutzer. (i.d.R. der Lieferant) zur Abrechnung von Mengen-Differenzen zwischen Bilanzierung und Messung. - #: Rechnung eines Messstellenbetreibers an den Messkunden. + """Eine Rechnung vom Lieferanten an einen Endkunden über die Lieferung von Energie.""" + NETZNUTZUNGSRECHNUNG = "NETZNUTZUNGSRECHNUNG" + """Eine Rechnung vom Netzbetreiber an den Netznutzer. (i.d.R. der Lieferant) über die Netznutzung.""" + MEHRMINDERMENGENRECHNUNG = "MEHRMINDERMENGENRECHNUNG" + """Eine Rechnung vom Netzbetreiber an den Netznutzer. (i.d.R. der Lieferant) zur Abrechnung von Mengen-Differenzen zwischen Bilanzierung und Messung.""" MESSSTELLENBETRIEBSRECHNUNG = "MESSSTELLENBETRIEBSRECHNUNG" - BESCHAFFUNGSRECHNUNG = "BESCHAFFUNGSRECHNUNG" #: Rechnungen zwischen einem Händler und Einkäufer von Energie. - AUSGLEICHSENERGIERECHNUNG = "AUSGLEICHSENERGIERECHNUNG" #: Rechnung an den Verursacher von Ausgleichsenergie. + """Rechnung eines Messstellenbetreibers an den Messkunden.""" + BESCHAFFUNGSRECHNUNG = "BESCHAFFUNGSRECHNUNG" + """Rechnungen zwischen einem Händler und Einkäufer von Energie.""" + AUSGLEICHSENERGIERECHNUNG = "AUSGLEICHSENERGIERECHNUNG" + """Rechnung an den Verursacher von Ausgleichsenergie.""" diff --git a/src/bo4e/enum/regionskriteriumtyp.py b/src/bo4e/enum/regionskriteriumtyp.py index 168bcfbb9..6fc0af17f 100644 --- a/src/bo4e/enum/regionskriteriumtyp.py +++ b/src/bo4e/enum/regionskriteriumtyp.py @@ -7,39 +7,69 @@ class Regionskriteriumtyp(StrEnum): Klassifizierung der Kriterien für eine regionale Eingrenzung. """ - BUNDESLANDKENNZIFFER = "BUNDESLANDKENNZIFFER" #: offizielle Bundeslandkennziffer - BUNDESLAND_NAME = "BUNDESLAND_NAME" #: Bundesland Name - MARKTGEBIET_NUMMER = "MARKTGEBIET_NUMMER" #: offizielle Marktgebiet-Codenummer - MARKTGEBIET_NAME = "MARKTGEBIET_NAME" #: Marktgebiet Name - REGELGEBIET_NUMMER = "REGELGEBIET_NUMMER" #: offizielle Regelgebiet Nummer - REGELGEBIET_NAME = "REGELGEBIET_NAME" #: Regelgebiet Name - NETZ_STROM = "NETZ_STROM" #: Identifikation des Netzes Strom - NETZ_GAS = "NETZ_GAS" #: Identifikation des Netzes Gas - NETZBETREIBER_NUMMER_STROM = "NETZBETREIBER_NUMMER_STROM" #: offizielle Netzbetreiber-Codenummer Strom - NETZBETREIBER_NUMMER_GAS = "NETZBETREIBER_NUMMER_GAS" #: offizielle Netzbetreiber-Codenummer Gas - NETZBETREIBER_NAME_STROM = "NETZBETREIBER_NAME_STROM" #: Netzbetreiber Name Strom - NETZBETREIBER_NAME_GAS = "NETZBETREIBER_NAME_GAS" #: Netzbetreiber Name Gas - #: Strom: Bilanzierungsgebietsnummer, Gas: Netzkontonummer + BUNDESLANDKENNZIFFER = "BUNDESLANDKENNZIFFER" + """offizielle Bundeslandkennziffer""" + BUNDESLAND_NAME = "BUNDESLAND_NAME" + """Bundesland Name""" + MARKTGEBIET_NUMMER = "MARKTGEBIET_NUMMER" + """offizielle Marktgebiet-Codenummer""" + MARKTGEBIET_NAME = "MARKTGEBIET_NAME" + """Marktgebiet Name""" + REGELGEBIET_NUMMER = "REGELGEBIET_NUMMER" + """offizielle Regelgebiet Nummer""" + REGELGEBIET_NAME = "REGELGEBIET_NAME" + """Regelgebiet Name""" + NETZ_STROM = "NETZ_STROM" + """Identifikation des Netzes Strom""" + NETZ_GAS = "NETZ_GAS" + """Identifikation des Netzes Gas""" + NETZBETREIBER_NUMMER_STROM = "NETZBETREIBER_NUMMER_STROM" + """offizielle Netzbetreiber-Codenummer Strom""" + NETZBETREIBER_NUMMER_GAS = "NETZBETREIBER_NUMMER_GAS" + """offizielle Netzbetreiber-Codenummer Gas""" + NETZBETREIBER_NAME_STROM = "NETZBETREIBER_NAME_STROM" + """Netzbetreiber Name Strom""" + NETZBETREIBER_NAME_GAS = "NETZBETREIBER_NAME_GAS" + """Netzbetreiber Name Gas""" BILANZIERUNGS_GEBIET_NUMMER = "BILANZIERUNGS_GEBIET_NUMMER" - MSB_NUMMER = "MSB_NUMMER" #: offizielle Messstellenbetreiber-Codenummer - MSB_NAME = "MSB_NAME" #: Name des MSB - VERSORGER_NUMMER = "VERSORGER_NUMMER" #: offizielle Lieferanten-Codenummer eines Versorgers - VERSORGER_NAME = "VERSORGER_NAME" #: Name eines Versorgers - #: offizielle Lieferanten-Codenummer des Strom-Grundversorgers + """Strom: Bilanzierungsgebietsnummer, Gas: Netzkontonummer""" + MSB_NUMMER = "MSB_NUMMER" + """offizielle Messstellenbetreiber-Codenummer""" + MSB_NAME = "MSB_NAME" + """Name des MSB""" + VERSORGER_NUMMER = "VERSORGER_NUMMER" + """offizielle Lieferanten-Codenummer eines Versorgers""" + VERSORGER_NAME = "VERSORGER_NAME" + """Name eines Versorgers""" GRUNDVERSORGER_NUMMER_STROM = "GRUNDVERSORGER_NUMMER_STROM" - GRUNDVERSORGER_NAME_STROM = "GRUNDVERSORGER_NAME_STROM" #: Name des Strom-Grundversorgers - #: offizielle Lieferanten-Codenummer des Gas-Grundversorgers + """offizielle Lieferanten-Codenummer des Strom-Grundversorgers""" + GRUNDVERSORGER_NAME_STROM = "GRUNDVERSORGER_NAME_STROM" + """Name des Strom-Grundversorgers""" GRUNDVERSORGER_NUMMER_GAS = "GRUNDVERSORGER_NUMMER_GAS" - GRUNDVERSORGER_NAME_GAS = "GRUNDVERSORGER_NAME_GAS" #: Name des Gas-Grundversorgers - KREIS_NAME = "KREIS_NAME" #: Kreis - KREISKENNZIFFER = "KREISKENNZIFFER" #: offizielle Kreiskennziffer - GEMEINDE_NAME = "GEMEINDE_NAME" #: Gemeinde - GEMEINDEKENNZIFFER = "GEMEINDEKENNZIFFER" #: offizielle Gemeindekennziffer - POSTLEITZAHL = "POSTLEITZAHL" #: Postleitzahl - ORT = "ORT" #: Ort - POSTORT = "POSTORT" #: Kriterium bestehend aus Postleitzahl und Ort - EINWOHNERZAHL_GEMEINDE = "EINWOHNERZAHL_GEMEINDE" #: Einwohnerzahl Gemeinde - EINWOHNERZAHL_ORT = "EINWOHNERZAHL_ORT" #: Einwohnerzahl Ort - KM_UMKREIS = "KM_UMKREIS" #: km Umkreis - BUNDESWEIT = "BUNDESWEIT" #: Bundesweite Betrachtung - PLZ_BEREICH = "PLZ_BEREICH" #: Postleitzahlenbereich + """offizielle Lieferanten-Codenummer des Gas-Grundversorgers""" + GRUNDVERSORGER_NAME_GAS = "GRUNDVERSORGER_NAME_GAS" + """Name des Gas-Grundversorgers""" + KREIS_NAME = "KREIS_NAME" + """Kreis""" + KREISKENNZIFFER = "KREISKENNZIFFER" + """offizielle Kreiskennziffer""" + GEMEINDE_NAME = "GEMEINDE_NAME" + """Gemeinde""" + GEMEINDEKENNZIFFER = "GEMEINDEKENNZIFFER" + """offizielle Gemeindekennziffer""" + POSTLEITZAHL = "POSTLEITZAHL" + """Postleitzahl""" + ORT = "ORT" + """Ort""" + POSTORT = "POSTORT" + """Kriterium bestehend aus Postleitzahl und Ort""" + EINWOHNERZAHL_GEMEINDE = "EINWOHNERZAHL_GEMEINDE" + """Einwohnerzahl Gemeinde""" + EINWOHNERZAHL_ORT = "EINWOHNERZAHL_ORT" + """Einwohnerzahl Ort""" + KM_UMKREIS = "KM_UMKREIS" + """km Umkreis""" + BUNDESWEIT = "BUNDESWEIT" + """Bundesweite Betrachtung""" + PLZ_BEREICH = "PLZ_BEREICH" + """Postleitzahlenbereich""" diff --git a/src/bo4e/enum/registeranzahl.py b/src/bo4e/enum/registeranzahl.py index 59b295e09..96803d5a2 100644 --- a/src/bo4e/enum/registeranzahl.py +++ b/src/bo4e/enum/registeranzahl.py @@ -8,6 +8,9 @@ class Registeranzahl(StrEnum): Die Registeranzahl wird verwendet zur Charakterisierung von Zählern und daraus resultierenden Tarifen. """ - EINTARIF = "EINTARIF" #: Eintarif - ZWEITARIF = "ZWEITARIF" #: Zweitarif - MEHRTARIF = "MEHRTARIF" #: Mehrtarif + EINTARIF = "EINTARIF" + """Eintarif""" + ZWEITARIF = "ZWEITARIF" + """Zweitarif""" + MEHRTARIF = "MEHRTARIF" + """Mehrtarif""" diff --git a/src/bo4e/enum/rollencodetyp.py b/src/bo4e/enum/rollencodetyp.py index 38a0a1f71..1631d5eda 100644 --- a/src/bo4e/enum/rollencodetyp.py +++ b/src/bo4e/enum/rollencodetyp.py @@ -8,6 +8,9 @@ class Rollencodetyp(StrEnum): Gibt den Codetyp einer Rolle, beispielsweise einer Marktrolle, an. """ - BDEW = "BDEW" #: Bundesverband der Energie- u. Wasserwirtschaft - DVGW = "DVGW" #: Deutscher Verein des Gas- und Wasserfaches - GLN = "GLN" #: Global Location Number + BDEW = "BDEW" + """Bundesverband der Energie- u. Wasserwirtschaft""" + DVGW = "DVGW" + """Deutscher Verein des Gas- und Wasserfaches""" + GLN = "GLN" + """Global Location Number""" diff --git a/src/bo4e/enum/steuerkennzeichen.py b/src/bo4e/enum/steuerkennzeichen.py index dd48d4c3f..74cf7d86c 100644 --- a/src/bo4e/enum/steuerkennzeichen.py +++ b/src/bo4e/enum/steuerkennzeichen.py @@ -7,12 +7,21 @@ class Steuerkennzeichen(StrEnum): Zur Kennzeichnung verschiedener Steuersätze und Verfahren. """ - UST_0 = "UST_0" #: Keine Umsatzsteuer, bzw. nicht steuerbar. - UST_19 = "UST_19" #: Umsatzsteuer 19% - UST_16 = "UST_16" #: Umsatzsteuer 16% - UST_7 = "UST_7" #: Umsatzsteuer 7% - VST_0 = "VST_0" #: Keine Vorsteuer, bzw. nicht steuerbar. - VST_19 = "VST_19" #: Vorsteuer 19% - VST_16 = "VST_16" #: Vorsteuer 16% - VST_7 = "VST_7" #: Vorsteuer 7% - RCV = "RCV" #: Reverse Charge Verfahren (Umkehrung der Steuerpflicht) + UST_0 = "UST_0" + """Keine Umsatzsteuer, bzw. nicht steuerbar.""" + UST_19 = "UST_19" + """Umsatzsteuer 19%""" + UST_16 = "UST_16" + """Umsatzsteuer 16%""" + UST_7 = "UST_7" + """Umsatzsteuer 7%""" + VST_0 = "VST_0" + """Keine Vorsteuer, bzw. nicht steuerbar.""" + VST_19 = "VST_19" + """Vorsteuer 19%""" + VST_16 = "VST_16" + """Vorsteuer 16%""" + VST_7 = "VST_7" + """Vorsteuer 7%""" + RCV = "RCV" + """Reverse Charge Verfahren (Umkehrung der Steuerpflicht)""" diff --git a/src/bo4e/enum/tarifkalkulationsmethode.py b/src/bo4e/enum/tarifkalkulationsmethode.py index a7cd46baa..dbf5d2442 100644 --- a/src/bo4e/enum/tarifkalkulationsmethode.py +++ b/src/bo4e/enum/tarifkalkulationsmethode.py @@ -7,8 +7,13 @@ class Tarifkalkulationsmethode(StrEnum): Auflistung der verschiedenen Berechnungsmethoden für ein Preisblatt. """ - KEINE = "KEINE" #: Es wird keine Berechnung durchgeführt, sondern lediglich die Menge mit dem Preis multipliziert. - STAFFELN = "STAFFELN" #: Staffelmodell, d.h. die Gesamtmenge wird in eine Staffel eingeordnet und für die gesamte Menge gilt der so ermittelte Preis - ZONEN = "ZONEN" #: Zonenmodell, d.h. die Gesamtmenge wird auf die Zonen aufgeteilt und für die Teilmengen gilt der jeweilige Preis der Zone. - BESTABRECHNUNG_STAFFEL = "BESTABRECHNUNG_STAFFEL" #: Bestabrechnung innerhalb der Staffelung - PAKETPREIS = "PAKETPREIS" #: Preis für ein Paket (eine Menge). + KEINE = "KEINE" + """Es wird keine Berechnung durchgeführt, sondern lediglich die Menge mit dem Preis multipliziert.""" + STAFFELN = "STAFFELN" + """Staffelmodell, d.h. die Gesamtmenge wird in eine Staffel eingeordnet und für die gesamte Menge gilt der so ermittelte Preis""" + ZONEN = "ZONEN" + """Zonenmodell, d.h. die Gesamtmenge wird auf die Zonen aufgeteilt und für die Teilmengen gilt der jeweilige Preis der Zone.""" + BESTABRECHNUNG_STAFFEL = "BESTABRECHNUNG_STAFFEL" + """Bestabrechnung innerhalb der Staffelung""" + PAKETPREIS = "PAKETPREIS" + """Preis für ein Paket (eine Menge).""" diff --git a/src/bo4e/enum/tarifmerkmal.py b/src/bo4e/enum/tarifmerkmal.py index 69eae9259..02b14f4ba 100644 --- a/src/bo4e/enum/tarifmerkmal.py +++ b/src/bo4e/enum/tarifmerkmal.py @@ -7,12 +7,21 @@ class Tarifmerkmal(StrEnum): Produktmerkmale im Zusammenhang mit der Tarifdefinition. """ - STANDARD = "STANDARD" #: Standardprodukt - VORKASSE = "VORKASSE" #: Vorkassenprodukt - PAKET = "PAKET" #: Paketpreisprodukt - KOMBI = "KOMBI" #: Kombiprodukt - FESTPREIS = "FESTPREIS" #: Festpreisprodukt - BAUSTROM = "BAUSTROM" #: Baustromprodukt - HAUSLICHT = "HAUSLICHT" #: Hauslichtprodukt - HEIZSTROM = "HEIZSTROM" #: Heizstromprodukt - ONLINE = "ONLINE" #: Onlineprodukt + STANDARD = "STANDARD" + """Standardprodukt""" + VORKASSE = "VORKASSE" + """Vorkassenprodukt""" + PAKET = "PAKET" + """Paketpreisprodukt""" + KOMBI = "KOMBI" + """Kombiprodukt""" + FESTPREIS = "FESTPREIS" + """Festpreisprodukt""" + BAUSTROM = "BAUSTROM" + """Baustromprodukt""" + HAUSLICHT = "HAUSLICHT" + """Hauslichtprodukt""" + HEIZSTROM = "HEIZSTROM" + """Heizstromprodukt""" + ONLINE = "ONLINE" + """Onlineprodukt""" diff --git a/src/bo4e/enum/tarifregionskriterium.py b/src/bo4e/enum/tarifregionskriterium.py index 37f009a6a..da273b774 100644 --- a/src/bo4e/enum/tarifregionskriterium.py +++ b/src/bo4e/enum/tarifregionskriterium.py @@ -7,8 +7,13 @@ class Tarifregionskriterium(StrEnum): Mit diesen Kriterien können regionale Bereiche definiert werden. """ - NETZ_NUMMER = "NETZ_NUMMER" #: Netznummer - POSTLEITZAHL = "POSTLEITZAHL" #: Postleitzahl - ORT = "ORT" #: Ort - GRUNDVERSORGER_NUMMER = "GRUNDVERSORGER_NUMMER" #: Nummer des Grundversorgers - REGION = "REGION" #: Referenz auf ein BO Region (URL) + NETZ_NUMMER = "NETZ_NUMMER" + """Netznummer""" + POSTLEITZAHL = "POSTLEITZAHL" + """Postleitzahl""" + ORT = "ORT" + """Ort""" + GRUNDVERSORGER_NUMMER = "GRUNDVERSORGER_NUMMER" + """Nummer des Grundversorgers""" + REGION = "REGION" + """Referenz auf ein BO Region (URL)""" diff --git a/src/bo4e/enum/tariftyp.py b/src/bo4e/enum/tariftyp.py index dfd271ab8..2361e96a7 100644 --- a/src/bo4e/enum/tariftyp.py +++ b/src/bo4e/enum/tariftyp.py @@ -7,7 +7,11 @@ class Tariftyp(StrEnum): Zur Differenzierung von Grund/Ersatzversorgungstarifen und sonstigen angebotenen Tarifen. """ - GRUND_ERSATZVERSORGUNG = "GRUND_ERSATZVERSORGUNG" #: Grund- und Ersatzversorgung - GRUNDVERSORGUNG = "GRUNDVERSORGUNG" #: Grundversorgung - ERSATZVERSORGUNG = "ERSATZVERSORGUNG" #: Ersatzversorgung - SONDERTARIF = "SONDERTARIF" #: Sondertarif + GRUND_ERSATZVERSORGUNG = "GRUND_ERSATZVERSORGUNG" + """Grund- und Ersatzversorgung""" + GRUNDVERSORGUNG = "GRUNDVERSORGUNG" + """Grundversorgung""" + ERSATZVERSORGUNG = "ERSATZVERSORGUNG" + """Ersatzversorgung""" + SONDERTARIF = "SONDERTARIF" + """Sondertarif""" diff --git a/src/bo4e/enum/tarifzeit.py b/src/bo4e/enum/tarifzeit.py index 63a5ace40..0d48694ed 100644 --- a/src/bo4e/enum/tarifzeit.py +++ b/src/bo4e/enum/tarifzeit.py @@ -7,6 +7,9 @@ class Tarifzeit(StrEnum): Zur Kennzeichnung verschiedener Tarifzeiten, beispielsweise zur Bepreisung oder zur Verbrauchsermittlung. """ - TZ_STANDARD = "TZ_STANDARD" #: Tarifzeit Standard für Eintarif-Konfigurationen - TZ_HT = "TZ_HT" #: Tarifzeit für Hochtarif bei Mehrtarif-Konfigurationen - TZ_NT = "TZ_NT" #: Tarifzeit für Niedrigtarif bei Mehrtarif-Konfigurationen + TZ_STANDARD = "TZ_STANDARD" + """Tarifzeit Standard für Eintarif-Konfigurationen""" + TZ_HT = "TZ_HT" + """Tarifzeit für Hochtarif bei Mehrtarif-Konfigurationen""" + TZ_NT = "TZ_NT" + """Tarifzeit für Niedrigtarif bei Mehrtarif-Konfigurationen""" diff --git a/src/bo4e/enum/themengebiet.py b/src/bo4e/enum/themengebiet.py index ca18d2fd0..50c85fa82 100644 --- a/src/bo4e/enum/themengebiet.py +++ b/src/bo4e/enum/themengebiet.py @@ -8,65 +8,125 @@ class Themengebiet(StrEnum): Über dieses ENUM kann eine thematische Zuordnung, beispielsweise eines Ansprechpartners, vorgenommen werden. """ - ALLGEMEINER_INFORMATIONSAUSTAUSCH = "ALLGEMEINER_INFORMATIONSAUSTAUSCH" #: Allgemeiner Informationsaustausch - AN_UND_ABMELDUNG = "AN_UND_ABMELDUNG" #: An- und Abmeldung - ANSPRECHPARTNER_ALLGEMEIN = "ANSPRECHPARTNER_ALLGEMEIN" #: Ansprechpartner Allgemein - ANSPRECHPARTNER_BDEW_DVGW = "ANSPRECHPARTNER_BDEW_DVGW" #: Ansprechpartner BDEW/DVGW - ANSPRECHPARTNER_IT_TECHNIK = "ANSPRECHPARTNER_IT_TECHNIK" #: Ansprechpartner IT/Technik - BILANZIERUNG = "BILANZIERUNG" #: Bilanzierung - BILANZKREISKOORDINATOR = "BILANZKREISKOORDINATOR" #: Bilanzkreiskoordinator - BILANZKREISVERANTWORTLICHER = "BILANZKREISVERANTWORTLICHER" #: Bilanzkreisverantwortlicher - #: Datenformate, Zertifikate, Verschlüsselungen + ALLGEMEINER_INFORMATIONSAUSTAUSCH = "ALLGEMEINER_INFORMATIONSAUSTAUSCH" + """Allgemeiner Informationsaustausch""" + AN_UND_ABMELDUNG = "AN_UND_ABMELDUNG" + """An- und Abmeldung""" + ANSPRECHPARTNER_ALLGEMEIN = "ANSPRECHPARTNER_ALLGEMEIN" + """Ansprechpartner Allgemein""" + ANSPRECHPARTNER_BDEW_DVGW = "ANSPRECHPARTNER_BDEW_DVGW" + """Ansprechpartner BDEW/DVGW""" + ANSPRECHPARTNER_IT_TECHNIK = "ANSPRECHPARTNER_IT_TECHNIK" + """Ansprechpartner IT/Technik""" + BILANZIERUNG = "BILANZIERUNG" + """Bilanzierung""" + BILANZKREISKOORDINATOR = "BILANZKREISKOORDINATOR" + """Bilanzkreiskoordinator""" + BILANZKREISVERANTWORTLICHER = "BILANZKREISVERANTWORTLICHER" + """Bilanzkreisverantwortlicher""" DATENFORMATE_ZERTIFIKATE_VERSCHLUESSELUNGEN = "DATENFORMATE_ZERTIFIKATE_VERSCHLUESSELUNGEN" - DEBITORENMANAGEMENT = "DEBITORENMANAGEMENT" #: Debitorenmanagement - DEMAND_SIDE_MANAGEMENT = "DEMAND_SIDE_MANAGEMENT" #: Demand-Side-Management - EDI_VEREINBARUNG = "EDI_VEREINBARUNG" #: EDI-Vereinbarung - EDIFACT = "EDIFACT" #: EDIFACT - ENERGIEDATENMANAGEMENT = "ENERGIEDATENMANAGEMENT" #: Energiedatenmanagement - FAHRPLANMANAGEMENT = "FAHRPLANMANAGEMENT" #: Fahrplanmanagement - ALOCAT = "ALOCAT" #: Format:ALOCAT - APERAK = "APERAK" #: Format:APERAK - CONTRL = "CONTRL" #: Format:CONTRL - INVOIC = "INVOIC" #: Format:INVOIC - MSCONS = "MSCONS" #: Format:MSCONS - ORDERS = "ORDERS" #: Format:ORDERS - ORDERSP = "ORDERSP" #: Format:ORDERSP - REMADV = "REMADV" #: Format:REMADV - UTILMD = "UTILMD" #: Format:UTILMD - GABI = "GABI" #: GaBi Gas - GELI = "GELI" #: GeLi Gas - GERAETERUECKGABE = "GERAETERUECKGABE" #: Geräterückgabe - GERAETEWECHSEL = "GERAETEWECHSEL" #: Gerätewechsel - GPKE = "GPKE" #: GPKE - INBETRIEBNAHME = "INBETRIEBNAHME" #: Inbetriebnahme - KAPAZITAETSMANAGEMENT = "KAPAZITAETSMANAGEMENT" #: Kapazitätsmanagement - KLAERFAELLE = "KLAERFAELLE" #: Klärfälle - LASTGAENGE_RLM = "LASTGAENGE_RLM" #: Lastgänge RLM - LIEFERANTENRAHMENVERTRAG = "LIEFERANTENRAHMENVERTRAG" #: Lieferantenrahmenvertrag - LIEFERANTENWECHSEL = "LIEFERANTENWECHSEL" #: Lieferantenwechsel - MABIS = "MABIS" #: MaBiS - MAHNWESEN = "MAHNWESEN" #: Mahnwesen - MARKTGEBIETSVERANTWORTLICHER = "MARKTGEBIETSVERANTWORTLICHER" #: Marktgebietsverantwortlicher - MARKTKOMMUNIKATION = "MARKTKOMMUNIKATION" #: Marktkommunikation - MEHR_MINDERMENGEN = "MEHR_MINDERMENGEN" #: Mehr- Mindermengen - MSB_MDL = "MSB_MDL" #: MSB - MDL - NETZABRECHNUNG = "NETZABRECHNUNG" #: Netzabrechnung - NETZENTGELTE = "NETZENTGELTE" #: Netzentgelte - NETZMANAGEMENT = "NETZMANAGEMENT" #: Netzmanagement - RECHT = "RECHT" #: Recht - REGULIERUNGSMANAGEMENT = "REGULIERUNGSMANAGEMENT" #: Regulierungsmanagement - REKLAMATIONEN = "REKLAMATIONEN" #: Reklamationen - SPERREN_ENTSPERREN_INKASSO = "SPERREN_ENTSPERREN_INKASSO" #: Sperren/Entsperren/Inkasso - STAMMDATEN = "STAMMDATEN" #: Stammdaten - STOERUNGSFAELLE = "STOERUNGSFAELLE" #: Übermittlung_Störungsfälle - TECHNISCHE_FRAGEN = "TECHNISCHE_FRAGEN" #: Technische Fragen - UMSTELLUNG_INVOIC = "UMSTELLUNG_INVOIC" #: Umstellung INVOIC - VERSCHLUESSELUNG_SIGNATUR = "VERSCHLUESSELUNG_SIGNATUR" #: Verschlüsselung/Signatur - VERTRAGSMANAGEMENT = "VERTRAGSMANAGEMENT" #: Vertragsmanagement - VERTRIEB = "VERTRIEB" #: Vertrieb - WIM = "WIM" #: WiM - ZAEHLERSTAENDE_SLP = "ZAEHLERSTAENDE_SLP" #: Zählerstände SLP - ZAHLUNGSVERKEHR = "ZAHLUNGSVERKEHR" #: Zahlungsverkehr - ZUORDNUNGSVEREINBARUNG = "ZUORDNUNGSVEREINBARUNG" #: Zuordnungsvereinbarung - EINSPEISUNG = "EINSPEISUNG" #: Einspeisung - BEWEGUNGSDATEN = "BEWEGUNGSDATEN" #: Bewegungsdaten + """Datenformate, Zertifikate, Verschlüsselungen""" + DEBITORENMANAGEMENT = "DEBITORENMANAGEMENT" + """Debitorenmanagement""" + DEMAND_SIDE_MANAGEMENT = "DEMAND_SIDE_MANAGEMENT" + """Demand-Side-Management""" + EDI_VEREINBARUNG = "EDI_VEREINBARUNG" + """EDI-Vereinbarung""" + EDIFACT = "EDIFACT" + """EDIFACT""" + ENERGIEDATENMANAGEMENT = "ENERGIEDATENMANAGEMENT" + """Energiedatenmanagement""" + FAHRPLANMANAGEMENT = "FAHRPLANMANAGEMENT" + """Fahrplanmanagement""" + ALOCAT = "ALOCAT" + """Format:ALOCAT""" + APERAK = "APERAK" + """Format:APERAK""" + CONTRL = "CONTRL" + """Format:CONTRL""" + INVOIC = "INVOIC" + """Format:INVOIC""" + MSCONS = "MSCONS" + """Format:MSCONS""" + ORDERS = "ORDERS" + """Format:ORDERS""" + ORDERSP = "ORDERSP" + """Format:ORDERSP""" + REMADV = "REMADV" + """Format:REMADV""" + UTILMD = "UTILMD" + """Format:UTILMD""" + GABI = "GABI" + """GaBi Gas""" + GELI = "GELI" + """GeLi Gas""" + GERAETERUECKGABE = "GERAETERUECKGABE" + """Geräterückgabe""" + GERAETEWECHSEL = "GERAETEWECHSEL" + """Gerätewechsel""" + GPKE = "GPKE" + """GPKE""" + INBETRIEBNAHME = "INBETRIEBNAHME" + """Inbetriebnahme""" + KAPAZITAETSMANAGEMENT = "KAPAZITAETSMANAGEMENT" + """Kapazitätsmanagement""" + KLAERFAELLE = "KLAERFAELLE" + """Klärfälle""" + LASTGAENGE_RLM = "LASTGAENGE_RLM" + """Lastgänge RLM""" + LIEFERANTENRAHMENVERTRAG = "LIEFERANTENRAHMENVERTRAG" + """Lieferantenrahmenvertrag""" + LIEFERANTENWECHSEL = "LIEFERANTENWECHSEL" + """Lieferantenwechsel""" + MABIS = "MABIS" + """MaBiS""" + MAHNWESEN = "MAHNWESEN" + """Mahnwesen""" + MARKTGEBIETSVERANTWORTLICHER = "MARKTGEBIETSVERANTWORTLICHER" + """Marktgebietsverantwortlicher""" + MARKTKOMMUNIKATION = "MARKTKOMMUNIKATION" + """Marktkommunikation""" + MEHR_MINDERMENGEN = "MEHR_MINDERMENGEN" + """Mehr- Mindermengen""" + MSB_MDL = "MSB_MDL" + """MSB - MDL""" + NETZABRECHNUNG = "NETZABRECHNUNG" + """Netzabrechnung""" + NETZENTGELTE = "NETZENTGELTE" + """Netzentgelte""" + NETZMANAGEMENT = "NETZMANAGEMENT" + """Netzmanagement""" + RECHT = "RECHT" + """Recht""" + REGULIERUNGSMANAGEMENT = "REGULIERUNGSMANAGEMENT" + """Regulierungsmanagement""" + REKLAMATIONEN = "REKLAMATIONEN" + """Reklamationen""" + SPERREN_ENTSPERREN_INKASSO = "SPERREN_ENTSPERREN_INKASSO" + """Sperren/Entsperren/Inkasso""" + STAMMDATEN = "STAMMDATEN" + """Stammdaten""" + STOERUNGSFAELLE = "STOERUNGSFAELLE" + """Übermittlung_Störungsfälle""" + TECHNISCHE_FRAGEN = "TECHNISCHE_FRAGEN" + """Technische Fragen""" + UMSTELLUNG_INVOIC = "UMSTELLUNG_INVOIC" + """Umstellung INVOIC""" + VERSCHLUESSELUNG_SIGNATUR = "VERSCHLUESSELUNG_SIGNATUR" + """Verschlüsselung/Signatur""" + VERTRAGSMANAGEMENT = "VERTRAGSMANAGEMENT" + """Vertragsmanagement""" + VERTRIEB = "VERTRIEB" + """Vertrieb""" + WIM = "WIM" + """WiM""" + ZAEHLERSTAENDE_SLP = "ZAEHLERSTAENDE_SLP" + """Zählerstände SLP""" + ZAHLUNGSVERKEHR = "ZAHLUNGSVERKEHR" + """Zahlungsverkehr""" + ZUORDNUNGSVEREINBARUNG = "ZUORDNUNGSVEREINBARUNG" + """Zuordnungsvereinbarung""" + EINSPEISUNG = "EINSPEISUNG" + """Einspeisung""" + BEWEGUNGSDATEN = "BEWEGUNGSDATEN" + """Bewegungsdaten""" diff --git a/src/bo4e/enum/titel.py b/src/bo4e/enum/titel.py index 169cbdfdc..c04d14614 100644 --- a/src/bo4e/enum/titel.py +++ b/src/bo4e/enum/titel.py @@ -8,6 +8,9 @@ class Titel(StrEnum): Übersicht möglicher Titel, z.B. eines Geschäftspartners. """ - DR = "DR" #: Doktor*In - PROF = "PROF" #: Professor*In - PROF_DR = "PROF_DR" #: Professor*In Dr. + DR = "DR" + """Doktor*In""" + PROF = "PROF" + """Professor*In""" + PROF_DR = "PROF_DR" + """Professor*In Dr.""" diff --git a/src/bo4e/enum/verbrauchsart.py b/src/bo4e/enum/verbrauchsart.py index 4ccdb1b95..b3280d8a8 100644 --- a/src/bo4e/enum/verbrauchsart.py +++ b/src/bo4e/enum/verbrauchsart.py @@ -8,8 +8,13 @@ class Verbrauchsart(StrEnum): Verbrauchsart einer Marktlokation. """ - KL = "KL" #: Kraft/Licht - KLW = "KLW" #: Kraft/Licht/Wärme - KLWS = "KLWS" #: Kraft/Licht/Wärme/Speicherheizung - W = "W" #: Wärme - WS = "WS" #: Wärme/Speicherheizung + KL = "KL" + """Kraft/Licht""" + KLW = "KLW" + """Kraft/Licht/Wärme""" + KLWS = "KLWS" + """Kraft/Licht/Wärme/Speicherheizung""" + W = "W" + """Wärme""" + WS = "WS" + """Wärme/Speicherheizung""" diff --git a/src/bo4e/enum/vertragsart.py b/src/bo4e/enum/vertragsart.py index 347c061c7..907725239 100644 --- a/src/bo4e/enum/vertragsart.py +++ b/src/bo4e/enum/vertragsart.py @@ -8,8 +8,13 @@ class Vertragsart(StrEnum): Aufzählung der Vertragsarten. """ - ENERGIELIEFERVERTRAG = "ENERGIELIEFERVERTRAG" #: Energieliefervertrag - NETZNUTZUNGSVERTRAG = "NETZNUTZUNGSVERTRAG" #: Netznutzungsvertrag - BILANZIERUNGSVERTRAG = "BILANZIERUNGSVERTRAG" #: Bilanzierungsvertrag - MESSSTELLENBETRIEBSVERTRAG = "MESSSTELLENBETRIEBSVERTRAG" #: Messstellenabetriebsvertrag - BUENDELVERTRAG = "BUENDELVERTRAG" #: Bündelvertrag + ENERGIELIEFERVERTRAG = "ENERGIELIEFERVERTRAG" + """Energieliefervertrag""" + NETZNUTZUNGSVERTRAG = "NETZNUTZUNGSVERTRAG" + """Netznutzungsvertrag""" + BILANZIERUNGSVERTRAG = "BILANZIERUNGSVERTRAG" + """Bilanzierungsvertrag""" + MESSSTELLENBETRIEBSVERTRAG = "MESSSTELLENBETRIEBSVERTRAG" + """Messstellenabetriebsvertrag""" + BUENDELVERTRAG = "BUENDELVERTRAG" + """Bündelvertrag""" diff --git a/src/bo4e/enum/vertragsform.py b/src/bo4e/enum/vertragsform.py index 33258e56b..8da168033 100644 --- a/src/bo4e/enum/vertragsform.py +++ b/src/bo4e/enum/vertragsform.py @@ -7,6 +7,9 @@ class Vertragsform(StrEnum): Aufzählung der Möglichkeiten zu Vertragsformen in Ausschreibungen. """ - ONLINE = "ONLINE" #: Online - DIREKT = "DIREKT" #: Direkt - FAX = "FAX" #: Auftragsfax + ONLINE = "ONLINE" + """Online""" + DIREKT = "DIREKT" + """Direkt""" + FAX = "FAX" + """Auftragsfax""" diff --git a/src/bo4e/enum/vertragsstatus.py b/src/bo4e/enum/vertragsstatus.py index b744cd348..c6535647d 100644 --- a/src/bo4e/enum/vertragsstatus.py +++ b/src/bo4e/enum/vertragsstatus.py @@ -8,12 +8,21 @@ class Vertragsstatus(StrEnum): Abbildung einer Statusinformation für Verträge. """ - IN_ARBEIT = "IN_ARBEIT" #: in Arbeit - UEBERMITTELT = "UEBERMITTELT" #: übermittelt - ANGENOMMEN = "ANGENOMMEN" #: angenommen - AKTIV = "AKTIV" #: aktiv - ABGELEHNT = "ABGELEHNT" #: abgelehnt - WIDERRUFEN = "WIDERRUFEN" #: widerrufen - STORNIERT = "STORNIERT" #: storniert - GEKUENDIGT = "GEKUENDIGT" #: gekündigt - BEENDET = "BEENDET" #: beendet + IN_ARBEIT = "IN_ARBEIT" + """in Arbeit""" + UEBERMITTELT = "UEBERMITTELT" + """übermittelt""" + ANGENOMMEN = "ANGENOMMEN" + """angenommen""" + AKTIV = "AKTIV" + """aktiv""" + ABGELEHNT = "ABGELEHNT" + """abgelehnt""" + WIDERRUFEN = "WIDERRUFEN" + """widerrufen""" + STORNIERT = "STORNIERT" + """storniert""" + GEKUENDIGT = "GEKUENDIGT" + """gekündigt""" + BEENDET = "BEENDET" + """beendet""" diff --git a/src/bo4e/enum/verwendungszweck.py b/src/bo4e/enum/verwendungszweck.py index 0569b7dc2..4a61cb9be 100644 --- a/src/bo4e/enum/verwendungszweck.py +++ b/src/bo4e/enum/verwendungszweck.py @@ -8,10 +8,15 @@ class Verwendungszweck(StrEnum): Verwendungszweck der Werte Marktlokation """ - NETZNUTZUNGSABRECHNUNG = "NETZNUTZUNGSABRECHNUNG" #: Netznutzungsabrechnung - BILANZKREISABRECHNUNG = "BILANZKREISABRECHNUNG" #: Bilanzkreisabrechnung - MEHRMINDERMENGENABRECHNUNG = "MEHRMINDERMENGENABRECHNUNG" #: Mehrmindermengenabrechnung - ENDKUNDENABRECHNUNG = "ENDKUNDENABRECHNUNG" #: Endkundenabrechnung - UEBERMITTLUNG_AN_DAS_HKNR = "UEBERMITTLUNG_AN_DAS_HKNR" #: Übermittlung an das Herkunftsnachweisregister (HKNR) - #: Zur Ermittlung der Ausgeglichenheit von Bilanzkreisen + NETZNUTZUNGSABRECHNUNG = "NETZNUTZUNGSABRECHNUNG" + """Netznutzungsabrechnung""" + BILANZKREISABRECHNUNG = "BILANZKREISABRECHNUNG" + """Bilanzkreisabrechnung""" + MEHRMINDERMENGENABRECHNUNG = "MEHRMINDERMENGENABRECHNUNG" + """Mehrmindermengenabrechnung""" + ENDKUNDENABRECHNUNG = "ENDKUNDENABRECHNUNG" + """Endkundenabrechnung""" + UEBERMITTLUNG_AN_DAS_HKNR = "UEBERMITTLUNG_AN_DAS_HKNR" + """Übermittlung an das Herkunftsnachweisregister (HKNR)""" ERMITTLUNG_AUSGEGLICHENHEIT_BILANZKREIS = "ERMITTLUNG_AUSGEGLICHENHEIT_BILANZKREIS" + """Zur Ermittlung der Ausgeglichenheit von Bilanzkreisen""" diff --git a/src/bo4e/enum/voraussetzungen.py b/src/bo4e/enum/voraussetzungen.py index 31c2a5827..cde7e72fb 100644 --- a/src/bo4e/enum/voraussetzungen.py +++ b/src/bo4e/enum/voraussetzungen.py @@ -7,56 +7,81 @@ class Voraussetzungen(StrEnum): Voraussetzungen, die erfüllt sein müssen, damit dieser Tarif zur Anwendung kommen kann. """ - EINZUGSERMAECHTIGUNG = "EINZUGSERMAECHTIGUNG" #: Einzugsermaechtigung - ZEITPUNKT = "ZEITPUNKT" #: Vertrag muss zu einem bestimmten Zeitpunkt noch bestehen - LIEFERANBINDUNG_EINE = "LIEFERANBINDUNG_EINE" #: Lieferantenbindung für diese Energieart - #: Lieferantenbindung für alle Energiearten, die der Versorger anbietet + EINZUGSERMAECHTIGUNG = "EINZUGSERMAECHTIGUNG" + """Einzugsermaechtigung""" + ZEITPUNKT = "ZEITPUNKT" + """Vertrag muss zu einem bestimmten Zeitpunkt noch bestehen""" + LIEFERANBINDUNG_EINE = "LIEFERANBINDUNG_EINE" + """Lieferantenbindung für diese Energieart""" LIEFERANBINDUNG_ALLE = "LIEFERANBINDUNG_ALLE" - GEWERBE = "GEWERBE" #: Gewerbenachweis - LASTPROFIL = "LASTPROFIL" #: Kunde muss einem bestimmten Lastprofil zuzuordnen sein - ZAEHLERTYP_GROESSE = "ZAEHLERTYP_GROESSE" #: bestimmter Zaehlertyp oder Zaehlergroeße - AUSSCHLUSS_GROSSVERBRAUCHER = "AUSSCHLUSS_GROSSVERBRAUCHER" #: Ausschluss von Großverbrauchern wie Industriekunden oder produzierendes Gewerbe - NEUKUNDE = "NEUKUNDE" #: Neukunden ohne bisherige Lieferanbindung - BESTIMMTE_VERTRAGSFORMALITAETEN = "BESTIMMTE_VERTRAGSFORMALITAETEN" #: bestimmte Vertragsformalitaeten wie z.B. Anmeldeformular muss an bestimmte Adresse versandt werden - SELBSTABLESUNG = "SELBSTABLESUNG" #: Selbstablesung durch den Kunden - ONLINEVORAUSSETZUNG = "ONLINEVORAUSSETZUNG" #: Onlinevoraussetzung - #: Mindestumsatz in einer bestimmten Zeiteinheit wie z.B. Mindestjahresumsatz 2500 EURO + """Lieferantenbindung für alle Energiearten, die der Versorger anbietet""" + GEWERBE = "GEWERBE" + """Gewerbenachweis""" + LASTPROFIL = "LASTPROFIL" + """Kunde muss einem bestimmten Lastprofil zuzuordnen sein""" + ZAEHLERTYP_GROESSE = "ZAEHLERTYP_GROESSE" + """bestimmter Zaehlertyp oder Zaehlergroeße""" + AUSSCHLUSS_GROSSVERBRAUCHER = "AUSSCHLUSS_GROSSVERBRAUCHER" + """Ausschluss von Großverbrauchern wie Industriekunden oder produzierendes Gewerbe""" + NEUKUNDE = "NEUKUNDE" + """Neukunden ohne bisherige Lieferanbindung""" + BESTIMMTE_VERTRAGSFORMALITAETEN = "BESTIMMTE_VERTRAGSFORMALITAETEN" + """bestimmte Vertragsformalitaeten wie z.B. Anmeldeformular muss an bestimmte Adresse versandt werden""" + SELBSTABLESUNG = "SELBSTABLESUNG" + """Selbstablesung durch den Kunden""" + ONLINEVORAUSSETZUNG = "ONLINEVORAUSSETZUNG" + """Onlinevoraussetzung""" MINDESTUMSATZ = "MINDESTUMSATZ" - #: Zusatzprodukt zu bereits bestehendem Lieferverhaeltnis beim Versorger in dieser Energieart + """Mindestumsatz in einer bestimmten Zeiteinheit wie z.B. Mindestjahresumsatz 2500 EURO""" ZUSATZPRODUKT = "ZUSATZPRODUKT" - #: geworbener Neukunde muss bestimmte Voraussetzungen erfüllen + """Zusatzprodukt zu bereits bestehendem Lieferverhaeltnis beim Versorger in dieser Energieart""" NEUKUNDE_MIT_VORAUSSETZUNGEN = "NEUKUNDE_MIT_VORAUSSETZUNGEN" - DIREKTVERTRIEB = "DIREKTVERTRIEB" #: Kunde wird durch Direktvertrieb gewonnen - ANSCHLUSSART = "ANSCHLUSSART" #: Anlage mit bestimmter Anschlussart wie z.B. Festanschluss - ANSCHLUSSWERT = "ANSCHLUSSWERT" #: bestimmte Anschlusswerte wie z. B. mindestens 30 kW - #: Alter einer Kundenanlage (z.B. Anlage wurde nach dem 01.01.2005 installiert) + """geworbener Neukunde muss bestimmte Voraussetzungen erfüllen""" + DIREKTVERTRIEB = "DIREKTVERTRIEB" + """Kunde wird durch Direktvertrieb gewonnen""" + ANSCHLUSSART = "ANSCHLUSSART" + """Anlage mit bestimmter Anschlussart wie z.B. Festanschluss""" + ANSCHLUSSWERT = "ANSCHLUSSWERT" + """bestimmte Anschlusswerte wie z. B. mindestens 30 kW""" ALTER_KUNDENANLAGE = "ALTER_KUNDENANLAGE" - #: bestimmte Anlagebeschaffenheit, wie bivalente Energieversorgung, Geräte o.ä. + """Alter einer Kundenanlage (z.B. Anlage wurde nach dem 01.01.2005 installiert)""" ANLAGEBESCHAFFENHEIT = "ANLAGEBESCHAFFENHEIT" - #: Betriebsstundenbegrenzung z.B. max 1500h/a oder mindestens 1000h/a + """bestimmte Anlagebeschaffenheit, wie bivalente Energieversorgung, Geräte o.ä.""" BETRIEBSSTUNDENBEGRENZUNG = "BETRIEBSSTUNDENBEGRENZUNG" - FREIGABEZEITEN = "FREIGABEZEITEN" #: vorgeschriebene Freigabezeiten - #: Familienstruktur wie z.B. bestimmte Anzahl Kinder oder Personen im Haushalt oder Eheleute + """Betriebsstundenbegrenzung z.B. max 1500h/a oder mindestens 1000h/a""" + FREIGABEZEITEN = "FREIGABEZEITEN" + """vorgeschriebene Freigabezeiten""" FAMILIENSTRUKTUR = "FAMILIENSTRUKTUR" - MITGLIEDSCHAFT = "MITGLIEDSCHAFT" #: Mitgliedschaft in bestimmten Vereinen oder Verbaenden - STAATLICHE_FOERDERUNG = "STAATLICHE_FOERDERUNG" #: staatliche Foerderung wie z.B. Sozialtarif oder Studentenausweis - #: besondere Verbrauchsstellen wie Kirchen, Vereinsgebaeude usw. + """Familienstruktur wie z.B. bestimmte Anzahl Kinder oder Personen im Haushalt oder Eheleute""" + MITGLIEDSCHAFT = "MITGLIEDSCHAFT" + """Mitgliedschaft in bestimmten Vereinen oder Verbaenden""" + STAATLICHE_FOERDERUNG = "STAATLICHE_FOERDERUNG" + """staatliche Foerderung wie z.B. Sozialtarif oder Studentenausweis""" BESONDERE_VERBRAUCHSSTELLE = "BESONDERE_VERBRAUCHSSTELLE" - NIEDRIGENERGIE = "NIEDRIGENERGIE" #: Niedrigenergieaustattung des Hauses - ORTSTEILE_LIEFERGEBIET = "ORTSTEILE_LIEFERGEBIET" #: nur für bestimmte Ortsteile in diesem Liefergebiet - WAERMEBEDARF_ERDGAS = "WAERMEBEDARF_ERDGAS" #: Wärmebedarf wird nur oder überwiegend mit Erdgas gedeckt - MAX_ZAEHLER_LIEFERSTELLEN = "MAX_ZAEHLER_LIEFERSTELLEN" #: beschränkt auf max. Anzahl Zähler oder Abnahmestellen - #: Lieferungsbeschraenkung auf bestimmte Gasart, wie H-Gas oder L-Gas + """besondere Verbrauchsstellen wie Kirchen, Vereinsgebaeude usw.""" + NIEDRIGENERGIE = "NIEDRIGENERGIE" + """Niedrigenergieaustattung des Hauses""" + ORTSTEILE_LIEFERGEBIET = "ORTSTEILE_LIEFERGEBIET" + """nur für bestimmte Ortsteile in diesem Liefergebiet""" + WAERMEBEDARF_ERDGAS = "WAERMEBEDARF_ERDGAS" + """Wärmebedarf wird nur oder überwiegend mit Erdgas gedeckt""" + MAX_ZAEHLER_LIEFERSTELLEN = "MAX_ZAEHLER_LIEFERSTELLEN" + """beschränkt auf max. Anzahl Zähler oder Abnahmestellen""" LIEFERUNGSBESCHRAENKUNG_GASART = "LIEFERUNGSBESCHRAENKUNG_GASART" - #: Kombination von Boni, von denen mindestens einer sehr unwahrscheinlich zu erreichen ist + """Lieferungsbeschraenkung auf bestimmte Gasart, wie H-Gas oder L-Gas""" KOMBI_BONI = "KOMBI_BONI" - ALTVERTRAG = "ALTVERTRAG" #: nur für Altvertraege, die weiterhin gueltig sind - #: vorgeschriebene Zusatzanlage wie z.B. Solaranlage etc. + """Kombination von Boni, von denen mindestens einer sehr unwahrscheinlich zu erreichen ist""" + ALTVERTRAG = "ALTVERTRAG" + """nur für Altvertraege, die weiterhin gueltig sind""" VORGESCHRIEBENE_ZUSATZANLAGE = "VORGESCHRIEBENE_ZUSATZANLAGE" - MEHRERE_ZAEHLER_ABNAHMESTELLEN = "MEHRERE_ZAEHLER_ABNAHMESTELLEN" #: mehr als 1 Zaehler oder 1 Abnahmestelle - #: bestimmter Abnahmefall wie z.B. nur Gemeinschaftsheizungen o.ae. + """vorgeschriebene Zusatzanlage wie z.B. Solaranlage etc.""" + MEHRERE_ZAEHLER_ABNAHMESTELLEN = "MEHRERE_ZAEHLER_ABNAHMESTELLEN" + """mehr als 1 Zaehler oder 1 Abnahmestelle""" BESTIMMTER_ABNAHMEFALL = "BESTIMMTER_ABNAHMEFALL" - ZUSATZMODALITAET = "ZUSATZMODALITAET" #: Zahlungsmodalitaet wie z.B. halbjaehrliche Zahlungsweise - #: Nachweis der Zahlungsfaehigkeit wie z.B. Bonitaetsprüfung + """bestimmter Abnahmefall wie z.B. nur Gemeinschaftsheizungen o.ae.""" + ZUSATZMODALITAET = "ZUSATZMODALITAET" + """Zahlungsmodalitaet wie z.B. halbjaehrliche Zahlungsweise""" NACHWEIS_ZAHLUNGSFAEHIGKEIT = "NACHWEIS_ZAHLUNGSFAEHIGKEIT" - UMSTELLUNG_ENERGIEART = "UMSTELLUNG_ENERGIEART" #: Umstellung der Energieart + """Nachweis der Zahlungsfaehigkeit wie z.B. Bonitaetsprüfung""" + UMSTELLUNG_ENERGIEART = "UMSTELLUNG_ENERGIEART" + """Umstellung der Energieart""" diff --git a/src/bo4e/enum/waehrungscode.py b/src/bo4e/enum/waehrungscode.py index f6aec55c1..444d60f3a 100644 --- a/src/bo4e/enum/waehrungscode.py +++ b/src/bo4e/enum/waehrungscode.py @@ -7,185 +7,367 @@ class Waehrungscode(StrEnum): Aufzählung der Währungscodes. """ - AED = "AED" #: UAE Dirham - AFN = "AFN" #: Afghani - ALL = "ALL" #: Lek - AMD = "AMD" #: Armenian Dram - ANG = "ANG" #: Netherlands Antillean Guilder - AOA = "AOA" #: Kwanza - ARS = "ARS" #: Argentine Peso - AUD = "AUD" #: Australian Dollar - AWG = "AWG" #: Aruban Florin - AZN = "AZN" #: Azerbaijanian Manat - BAM = "BAM" #: Convertible Mark - BBD = "BBD" #: Barbados Dollar - BDT = "BDT" #: Taka - BGN = "BGN" #: Bulgarian Lev - BHD = "BHD" #: Bahraini Dinar - BIF = "BIF" #: Burundi Franc - BMD = "BMD" #: Bermudian Dollar - BND = "BND" #: Brunei Dollar - BOB = "BOB" #: Boliviano - BOV = "BOV" #: Mvdol - BRL = "BRL" #: Brazilian Real - BSD = "BSD" #: Bahamian Dollar - BTN = "BTN" #: Ngultrum - BWP = "BWP" #: Pula - BYN = "BYN" #: Belarusian Ruble - BYR = "BYR" #: Belarusian Ruble - BZD = "BZD" #: Belize Dollar - CAD = "CAD" #: Canadian Dollar - CDF = "CDF" #: Congolese Franc - CHE = "CHE" #: WIR Euro - CHF = "CHF" #: Swiss Franc - CHW = "CHW" #: WIR Franc - CLF = "CLF" #: Unidad de Fomento - CLP = "CLP" #: Chilean Peso - CNY = "CNY" #: Yuan Renminbi - COP = "COP" #: Colombian Peso - COU = "COU" #: Unidad de Valor Real - CRC = "CRC" #: Costa Rican Colon - CUC = "CUC" #: Peso Convertible - CUP = "CUP" #: Cuban Peso - CVE = "CVE" #: Cape Verde Escudo - CZK = "CZK" #: Czech Koruna - DJF = "DJF" #: Djibouti Franc - DKK = "DKK" #: Danish Krone - DOP = "DOP" #: Dominican Peso - DZD = "DZD" #: Algerian Dinar - EGP = "EGP" #: Egyptian Pound - ERN = "ERN" #: Nakfa - ETB = "ETB" #: Ethiopian Birr - EUR = "EUR" #: Euro - FJD = "FJD" #: Fiji Dollar - FKP = "FKP" #: Falkland Islands Pound - GBP = "GBP" #: Pound Sterling - GEL = "GEL" #: Lari - GHS = "GHS" #: Ghana Cedi - GIP = "GIP" #: Gibraltar Pound - GMD = "GMD" #: Dalasi - GNF = "GNF" #: Guinea Franc - GTQ = "GTQ" #: Quetzal - GYD = "GYD" #: Guyana Dollar - HKD = "HKD" #: Hong Kong Dollar - HNL = "HNL" #: Lempira - HRK = "HRK" #: Croatian Kuna - HTG = "HTG" #: Gourde - HUF = "HUF" #: Forint - IDR = "IDR" #: Rupiah - ILS = "ILS" #: New Israeli Sheqel - INR = "INR" #: Indian Rupee - IQD = "IQD" #: Iraqi Dinar - IRR = "IRR" #: Iranian Rial - ISK = "ISK" #: Iceland Krona - JMD = "JMD" #: Jamaican Dollar - JOD = "JOD" #: Jordanian Dinar - JPY = "JPY" #: Yen - KES = "KES" #: Kenyan Shilling - KGS = "KGS" #: Som - KHR = "KHR" #: Riel - KMF = "KMF" #: Comoro Franc - KPW = "KPW" #: North Korean Won - KRW = "KRW" #: Won - KWD = "KWD" #: Kuwaiti Dinar - KYD = "KYD" #: Cayman Islands Dollar - KZT = "KZT" #: Tenge - LAK = "LAK" #: Kip - LBP = "LBP" #: Lebanese Pound - LKR = "LKR" #: Sri Lanka Rupee - LRD = "LRD" #: Liberian Dollar - LSL = "LSL" #: Loti - LTL = "LTL" #: Lithuanian Litas - LYD = "LYD" #: Libyan Dinar - MAD = "MAD" #: Moroccan Dirham - MDL = "MDL" #: Moldovan Leu - MGA = "MGA" #: Malagasy Ariary - MKD = "MKD" #: Denar - MMK = "MMK" #: Kyat - MNT = "MNT" #: Tugrik - MOP = "MOP" #: Pataca - MRO = "MRO" #: Ouguiya - MUR = "MUR" #: Mauritius Rupee - MVR = "MVR" #: Rufiyaa - MWK = "MWK" #: Kwacha - MXN = "MXN" #: Mexican Peso - MXV = "MXV" #: Mexican Unidad de Inversion (UDI) - MYR = "MYR" #: Malaysian Ringgit - MZN = "MZN" #: Mozambique Metical - NAD = "NAD" #: Namibia Dollar - NGN = "NGN" #: Naira - NIO = "NIO" #: Cordoba Oro - NOK = "NOK" #: Norwegian Krone - NPR = "NPR" #: Nepalese Rupee - NZD = "NZD" #: New Zealand Dollar - OMR = "OMR" #: Rial Omani - PAB = "PAB" #: Balboa - PEN = "PEN" #: Nuevo Sol - PGK = "PGK" #: Kina - PHP = "PHP" #: Philippine Peso - PKR = "PKR" #: Pakistan Rupee - PLN = "PLN" #: Zloty - PYG = "PYG" #: Guarani - QAR = "QAR" #: Qatari Rial - RON = "RON" #: New Romanian Leu - RSD = "RSD" #: Serbian Dinar - RUB = "RUB" #: Russian Ruble - RUR = "RUR" #: Russian Ruble - RWF = "RWF" #: Rwanda Franc - SAR = "SAR" #: Saudi Riyal - SBD = "SBD" #: Solomon Islands Dollar - SCR = "SCR" #: Seychelles Rupee - SDG = "SDG" #: Sudanese Pound - SEK = "SEK" #: Swedish Krona - SGD = "SGD" #: Singapore Dollar - SHP = "SHP" #: Saint Helena Pound - SLL = "SLL" #: Leone - SOS = "SOS" #: Somali Shilling - SRD = "SRD" #: Surinam Dollar - SSP = "SSP" #: South Sudanese Pound - STD = "STD" #: Dobra - SVC = "SVC" #: El Salvador Colon - SYP = "SYP" #: Syrian Pound - SZL = "SZL" #: Lilangeni - THB = "THB" #: Baht - TJS = "TJS" #: Somoni - TMT = "TMT" #: Turkmenistan New Manat - TND = "TND" #: Tunisian Dinar - TOP = "TOP" #: Paʻanga - TRY = "TRY" #: Turkish Lira - TTD = "TTD" #: Trinidad and Tobago Dollar - TWD = "TWD" #: New Taiwan Dollar - TZS = "TZS" #: Tanzanian Shilling - UAH = "UAH" #: Hryvnia - UGX = "UGX" #: Uganda Shilling - USD = "USD" #: US Dollar - USN = "USN" #: US Dollar (Next day) - USS = "USS" #: US Dollar (Same day) - UYI = "UYI" #: Uruguay Peso en Unidades Indexadas (URUIURUI) - UYU = "UYU" #: Peso Uruguayo - UZS = "UZS" #: Uzbekistan Sum - VEF = "VEF" #: Bolivar - VND = "VND" #: Dong - VUV = "VUV" #: Vatu - WST = "WST" #: Tala - XAF = "XAF" #: CFA Franc BEAC - XAG = "XAG" #: Silver - XAU = "XAU" #: Gold - XBA = "XBA" #: Bond Markets Unit European Composite Unit (EURCO) - XBB = "XBB" #: Bond Markets Unit European Monetary Unit (E.M.U.-6) - XBC = "XBC" #: Bond Markets Unit European Unit of Account 9 (E.U.A.-9) - XBD = "XBD" #: Bond Markets Unit European Unit of Account 17 (E.U.A.-17) - XCD = "XCD" #: East Caribbean Dollar - XDR = "XDR" #: SDR (Special Drawing Right) - XOF = "XOF" #: CFA Franc BCEAO - XPD = "XPD" #: Palladium - XPF = "XPF" #: CFP Franc - XPT = "XPT" #: Platinum - XSU = "XSU" #: Sucre - XTS = "XTS" #: Codes specifically reserved for testing purposes - XUA = "XUA" #: ADB Unit of Account - XXX = "XXX" #: The codes assigned for transactions where no currency ist involved - YER = "YER" #: Yemeni Rial - ZAR = "ZAR" #: Rand - ZMW = "ZMW" #: Zambian Kwacha - ZWL = "ZWL" #: Zimbabwe Dollar + AED = "AED" + """UAE Dirham""" + AFN = "AFN" + """Afghani""" + ALL = "ALL" + """Lek""" + AMD = "AMD" + """Armenian Dram""" + ANG = "ANG" + """Netherlands Antillean Guilder""" + AOA = "AOA" + """Kwanza""" + ARS = "ARS" + """Argentine Peso""" + AUD = "AUD" + """Australian Dollar""" + AWG = "AWG" + """Aruban Florin""" + AZN = "AZN" + """Azerbaijanian Manat""" + BAM = "BAM" + """Convertible Mark""" + BBD = "BBD" + """Barbados Dollar""" + BDT = "BDT" + """Taka""" + BGN = "BGN" + """Bulgarian Lev""" + BHD = "BHD" + """Bahraini Dinar""" + BIF = "BIF" + """Burundi Franc""" + BMD = "BMD" + """Bermudian Dollar""" + BND = "BND" + """Brunei Dollar""" + BOB = "BOB" + """Boliviano""" + BOV = "BOV" + """Mvdol""" + BRL = "BRL" + """Brazilian Real""" + BSD = "BSD" + """Bahamian Dollar""" + BTN = "BTN" + """Ngultrum""" + BWP = "BWP" + """Pula""" + BYN = "BYN" + """Belarusian Ruble""" + BYR = "BYR" + """Belarusian Ruble""" + BZD = "BZD" + """Belize Dollar""" + CAD = "CAD" + """Canadian Dollar""" + CDF = "CDF" + """Congolese Franc""" + CHE = "CHE" + """WIR Euro""" + CHF = "CHF" + """Swiss Franc""" + CHW = "CHW" + """WIR Franc""" + CLF = "CLF" + """Unidad de Fomento""" + CLP = "CLP" + """Chilean Peso""" + CNY = "CNY" + """Yuan Renminbi""" + COP = "COP" + """Colombian Peso""" + COU = "COU" + """Unidad de Valor Real""" + CRC = "CRC" + """Costa Rican Colon""" + CUC = "CUC" + """Peso Convertible""" + CUP = "CUP" + """Cuban Peso""" + CVE = "CVE" + """Cape Verde Escudo""" + CZK = "CZK" + """Czech Koruna""" + DJF = "DJF" + """Djibouti Franc""" + DKK = "DKK" + """Danish Krone""" + DOP = "DOP" + """Dominican Peso""" + DZD = "DZD" + """Algerian Dinar""" + EGP = "EGP" + """Egyptian Pound""" + ERN = "ERN" + """Nakfa""" + ETB = "ETB" + """Ethiopian Birr""" + EUR = "EUR" + """Euro""" + FJD = "FJD" + """Fiji Dollar""" + FKP = "FKP" + """Falkland Islands Pound""" + GBP = "GBP" + """Pound Sterling""" + GEL = "GEL" + """Lari""" + GHS = "GHS" + """Ghana Cedi""" + GIP = "GIP" + """Gibraltar Pound""" + GMD = "GMD" + """Dalasi""" + GNF = "GNF" + """Guinea Franc""" + GTQ = "GTQ" + """Quetzal""" + GYD = "GYD" + """Guyana Dollar""" + HKD = "HKD" + """Hong Kong Dollar""" + HNL = "HNL" + """Lempira""" + HRK = "HRK" + """Croatian Kuna""" + HTG = "HTG" + """Gourde""" + HUF = "HUF" + """Forint""" + IDR = "IDR" + """Rupiah""" + ILS = "ILS" + """New Israeli Sheqel""" + INR = "INR" + """Indian Rupee""" + IQD = "IQD" + """Iraqi Dinar""" + IRR = "IRR" + """Iranian Rial""" + ISK = "ISK" + """Iceland Krona""" + JMD = "JMD" + """Jamaican Dollar""" + JOD = "JOD" + """Jordanian Dinar""" + JPY = "JPY" + """Yen""" + KES = "KES" + """Kenyan Shilling""" + KGS = "KGS" + """Som""" + KHR = "KHR" + """Riel""" + KMF = "KMF" + """Comoro Franc""" + KPW = "KPW" + """North Korean Won""" + KRW = "KRW" + """Won""" + KWD = "KWD" + """Kuwaiti Dinar""" + KYD = "KYD" + """Cayman Islands Dollar""" + KZT = "KZT" + """Tenge""" + LAK = "LAK" + """Kip""" + LBP = "LBP" + """Lebanese Pound""" + LKR = "LKR" + """Sri Lanka Rupee""" + LRD = "LRD" + """Liberian Dollar""" + LSL = "LSL" + """Loti""" + LTL = "LTL" + """Lithuanian Litas""" + LYD = "LYD" + """Libyan Dinar""" + MAD = "MAD" + """Moroccan Dirham""" + MDL = "MDL" + """Moldovan Leu""" + MGA = "MGA" + """Malagasy Ariary""" + MKD = "MKD" + """Denar""" + MMK = "MMK" + """Kyat""" + MNT = "MNT" + """Tugrik""" + MOP = "MOP" + """Pataca""" + MRO = "MRO" + """Ouguiya""" + MUR = "MUR" + """Mauritius Rupee""" + MVR = "MVR" + """Rufiyaa""" + MWK = "MWK" + """Kwacha""" + MXN = "MXN" + """Mexican Peso""" + MXV = "MXV" + """Mexican Unidad de Inversion (UDI)""" + MYR = "MYR" + """Malaysian Ringgit""" + MZN = "MZN" + """Mozambique Metical""" + NAD = "NAD" + """Namibia Dollar""" + NGN = "NGN" + """Naira""" + NIO = "NIO" + """Cordoba Oro""" + NOK = "NOK" + """Norwegian Krone""" + NPR = "NPR" + """Nepalese Rupee""" + NZD = "NZD" + """New Zealand Dollar""" + OMR = "OMR" + """Rial Omani""" + PAB = "PAB" + """Balboa""" + PEN = "PEN" + """Nuevo Sol""" + PGK = "PGK" + """Kina""" + PHP = "PHP" + """Philippine Peso""" + PKR = "PKR" + """Pakistan Rupee""" + PLN = "PLN" + """Zloty""" + PYG = "PYG" + """Guarani""" + QAR = "QAR" + """Qatari Rial""" + RON = "RON" + """New Romanian Leu""" + RSD = "RSD" + """Serbian Dinar""" + RUB = "RUB" + """Russian Ruble""" + RUR = "RUR" + """Russian Ruble""" + RWF = "RWF" + """Rwanda Franc""" + SAR = "SAR" + """Saudi Riyal""" + SBD = "SBD" + """Solomon Islands Dollar""" + SCR = "SCR" + """Seychelles Rupee""" + SDG = "SDG" + """Sudanese Pound""" + SEK = "SEK" + """Swedish Krona""" + SGD = "SGD" + """Singapore Dollar""" + SHP = "SHP" + """Saint Helena Pound""" + SLL = "SLL" + """Leone""" + SOS = "SOS" + """Somali Shilling""" + SRD = "SRD" + """Surinam Dollar""" + SSP = "SSP" + """South Sudanese Pound""" + STD = "STD" + """Dobra""" + SVC = "SVC" + """El Salvador Colon""" + SYP = "SYP" + """Syrian Pound""" + SZL = "SZL" + """Lilangeni""" + THB = "THB" + """Baht""" + TJS = "TJS" + """Somoni""" + TMT = "TMT" + """Turkmenistan New Manat""" + TND = "TND" + """Tunisian Dinar""" + TOP = "TOP" + """Paʻanga""" + TRY = "TRY" + """Turkish Lira""" + TTD = "TTD" + """Trinidad and Tobago Dollar""" + TWD = "TWD" + """New Taiwan Dollar""" + TZS = "TZS" + """Tanzanian Shilling""" + UAH = "UAH" + """Hryvnia""" + UGX = "UGX" + """Uganda Shilling""" + USD = "USD" + """US Dollar""" + USN = "USN" + """US Dollar (Next day)""" + USS = "USS" + """US Dollar (Same day)""" + UYI = "UYI" + """Uruguay Peso en Unidades Indexadas (URUIURUI)""" + UYU = "UYU" + """Peso Uruguayo""" + UZS = "UZS" + """Uzbekistan Sum""" + VEF = "VEF" + """Bolivar""" + VND = "VND" + """Dong""" + VUV = "VUV" + """Vatu""" + WST = "WST" + """Tala""" + XAF = "XAF" + """CFA Franc BEAC""" + XAG = "XAG" + """Silver""" + XAU = "XAU" + """Gold""" + XBA = "XBA" + """Bond Markets Unit European Composite Unit (EURCO)""" + XBB = "XBB" + """Bond Markets Unit European Monetary Unit (E.M.U.-6)""" + XBC = "XBC" + """Bond Markets Unit European Unit of Account 9 (E.U.A.-9)""" + XBD = "XBD" + """Bond Markets Unit European Unit of Account 17 (E.U.A.-17)""" + XCD = "XCD" + """East Caribbean Dollar""" + XDR = "XDR" + """SDR (Special Drawing Right)""" + XOF = "XOF" + """CFA Franc BCEAO""" + XPD = "XPD" + """Palladium""" + XPF = "XPF" + """CFP Franc""" + XPT = "XPT" + """Platinum""" + XSU = "XSU" + """Sucre""" + XTS = "XTS" + """Codes specifically reserved for testing purposes""" + XUA = "XUA" + """ADB Unit of Account""" + XXX = "XXX" + """The codes assigned for transactions where no currency ist involved""" + YER = "YER" + """Yemeni Rial""" + ZAR = "ZAR" + """Rand""" + ZMW = "ZMW" + """Zambian Kwacha""" + ZWL = "ZWL" + """Zimbabwe Dollar""" diff --git a/src/bo4e/enum/waehrungseinheit.py b/src/bo4e/enum/waehrungseinheit.py index 838725d91..603af1244 100644 --- a/src/bo4e/enum/waehrungseinheit.py +++ b/src/bo4e/enum/waehrungseinheit.py @@ -7,5 +7,7 @@ class Waehrungseinheit(StrEnum): In diesem Enum werden die Währungen und ihre Untereinheiten definiert, beispielsweise für die Verwendung in Preisen. """ - EUR = "EUR" #: Euro - CT = "CT" #: Eurocent + EUR = "EUR" + """Euro""" + CT = "CT" + """Eurocent""" diff --git a/src/bo4e/enum/waermenutzung.py b/src/bo4e/enum/waermenutzung.py index b72a2c530..1f8ecf5af 100644 --- a/src/bo4e/enum/waermenutzung.py +++ b/src/bo4e/enum/waermenutzung.py @@ -7,6 +7,9 @@ class Waermenutzung(StrEnum): Wärmenutzung Marktlokation """ - SPEICHERHEIZUNG = "SPEICHERHEIZUNG" #: Speicherheizung - WAERMEPUMPE = "WAERMEPUMPE" #: Wärmepumpe - DIREKTHEIZUNG = "DIREKTHEIZUNG" #: Direktheizung + SPEICHERHEIZUNG = "SPEICHERHEIZUNG" + """Speicherheizung""" + WAERMEPUMPE = "WAERMEPUMPE" + """Wärmepumpe""" + DIREKTHEIZUNG = "DIREKTHEIZUNG" + """Direktheizung""" diff --git a/src/bo4e/enum/wertermittlungsverfahren.py b/src/bo4e/enum/wertermittlungsverfahren.py index 508ea8ab2..d9779e344 100644 --- a/src/bo4e/enum/wertermittlungsverfahren.py +++ b/src/bo4e/enum/wertermittlungsverfahren.py @@ -7,5 +7,7 @@ class Wertermittlungsverfahren(StrEnum): Gibt an, ob es sich um eine Prognose oder eine Messung handelt, beispielsweise bei der Abbildung eines Verbrauchs. """ - PROGNOSE = "PROGNOSE" #: Prognose - MESSUNG = "MESSUNG" #: Messung + PROGNOSE = "PROGNOSE" + """Prognose""" + MESSUNG = "MESSUNG" + """Messung""" diff --git a/src/bo4e/enum/zaehlerauspraegung.py b/src/bo4e/enum/zaehlerauspraegung.py index 7c23e290e..8d2fb2ca7 100644 --- a/src/bo4e/enum/zaehlerauspraegung.py +++ b/src/bo4e/enum/zaehlerauspraegung.py @@ -8,5 +8,7 @@ class Zaehlerauspraegung(StrEnum): Gibt an, ob es sich um einen Einrichtungs- oder Zweirichtungszähler handelt. """ - EINRICHTUNGSZAEHLER = "EINRICHTUNGSZAEHLER" #: Einrichtungszaehler - ZWEIRICHTUNGSZAEHLER = "ZWEIRICHTUNGSZAEHLER" #: Zweirichtungszaehler + EINRICHTUNGSZAEHLER = "EINRICHTUNGSZAEHLER" + """Einrichtungszaehler""" + ZWEIRICHTUNGSZAEHLER = "ZWEIRICHTUNGSZAEHLER" + """Zweirichtungszaehler""" diff --git a/src/bo4e/enum/zaehlergroesse.py b/src/bo4e/enum/zaehlergroesse.py index 73e7587eb..6000a60fc 100644 --- a/src/bo4e/enum/zaehlergroesse.py +++ b/src/bo4e/enum/zaehlergroesse.py @@ -8,24 +8,45 @@ class Zaehlergroesse(StrEnum): Auflistung möglicher Größen von Zählern """ - G2KOMMAP5 = "G2KOMMA5" #: Gaszähler Größe G2.5 - G4 = "G4" #: Gaszähler Größe G4 - G6 = "G6" #: Gaszähler Größe G6 - G10 = "G10" #: Gaszähler Größe G10 - G16 = "G16" #: Gaszähler Größe G16 - G25 = "G25" #: Gaszähler Größe G25 - G40 = "G40" #: Gaszähler Größe G40 - G65 = "G65" #: Gaszähler Größe G65 - G100 = "G100" #: Gaszähler Größe G100 - G160 = "G160" #: Gaszähler Größe G160 - G250 = "G250" #: Gaszähler Größe G250 - G400 = "G400" #: Gaszähler Größe G400 - G650 = "G650" #: Gaszähler Größe G650 - G1000 = "G1000" #: Gaszähler Größe G1000 - G1600 = "G1600" #: Gaszähler Größe G1600 - G2500 = "G2500" #: Gaszähler Größe G2500 - G4000 = "G4000" #: Gaszähler Größe G4000 - G6500 = "G6500" #: Gaszähler Größe G6500 - G10000 = "G10000" #: Gaszähler Größe G10000 - G12500 = "G12500" #: Gaszähler Größe G12500 - G16000 = "G16000" #: Gaszähler Größe G16000 + G2KOMMAP5 = "G2KOMMA5" + """Gaszähler Größe G2.5""" + G4 = "G4" + """Gaszähler Größe G4""" + G6 = "G6" + """Gaszähler Größe G6""" + G10 = "G10" + """Gaszähler Größe G10""" + G16 = "G16" + """Gaszähler Größe G16""" + G25 = "G25" + """Gaszähler Größe G25""" + G40 = "G40" + """Gaszähler Größe G40""" + G65 = "G65" + """Gaszähler Größe G65""" + G100 = "G100" + """Gaszähler Größe G100""" + G160 = "G160" + """Gaszähler Größe G160""" + G250 = "G250" + """Gaszähler Größe G250""" + G400 = "G400" + """Gaszähler Größe G400""" + G650 = "G650" + """Gaszähler Größe G650""" + G1000 = "G1000" + """Gaszähler Größe G1000""" + G1600 = "G1600" + """Gaszähler Größe G1600""" + G2500 = "G2500" + """Gaszähler Größe G2500""" + G4000 = "G4000" + """Gaszähler Größe G4000""" + G6500 = "G6500" + """Gaszähler Größe G6500""" + G10000 = "G10000" + """Gaszähler Größe G10000""" + G12500 = "G12500" + """Gaszähler Größe G12500""" + G16000 = "G16000" + """Gaszähler Größe G16000""" diff --git a/src/bo4e/enum/zaehlertyp.py b/src/bo4e/enum/zaehlertyp.py index 8332f09ab..b683d1c0b 100644 --- a/src/bo4e/enum/zaehlertyp.py +++ b/src/bo4e/enum/zaehlertyp.py @@ -8,17 +8,27 @@ class Zaehlertyp(StrEnum): Bei diesem Enum handelt es sich um die Abbildung von Zählertypen der Sparten Strom und Gas. """ - #: Drehstromzähler - dieser Zählertyp wird für dreiphasige Ferraris-Zähler verwendet DREHSTROMZAEHLER = "DREHSTROMZAEHLER" - BALGENGASZAEHLER = "BALGENGASZAEHLER" #: Balgengaszähler - DREHKOLBENZAEHLER = "DREHKOLBENZAEHLER" #: Drehkolbengaszähler - LEISTUNGSZAEHLER = "LEISTUNGSZAEHLER" #: leistungsmessender Zähler - MAXIMUMZAEHLER = "MAXIMUMZAEHLER" #: Maximumzähler - TURBINENRADGASZAEHLER = "TURBINENRADGASZAEHLER" #: Turbinenradgaszähler - ULTRASCHALLGASZAEHLER = "ULTRASCHALLGASZAEHLER" #: Ultraschallgaszähler - #: Wechselstromzähler - dieser Zählertyp wird für einphasige Ferraris-Zähler verwendet + """Drehstromzähler - dieser Zählertyp wird für dreiphasige Ferraris-Zähler verwendet""" + BALGENGASZAEHLER = "BALGENGASZAEHLER" + """Balgengaszähler""" + DREHKOLBENZAEHLER = "DREHKOLBENZAEHLER" + """Drehkolbengaszähler""" + LEISTUNGSZAEHLER = "LEISTUNGSZAEHLER" + """leistungsmessender Zähler""" + MAXIMUMZAEHLER = "MAXIMUMZAEHLER" + """Maximumzähler""" + TURBINENRADGASZAEHLER = "TURBINENRADGASZAEHLER" + """Turbinenradgaszähler""" + ULTRASCHALLGASZAEHLER = "ULTRASCHALLGASZAEHLER" + """Ultraschallgaszähler""" WECHSELSTROMZAEHLER = "WECHSELSTROMZAEHLER" - MODERNE_MESSEINRICHTUNG = "MODERNE_MESSEINRICHTUNG" #: Moderne Messeinrichtung - INTELLIGENTES_MESSSYSTEM = "INTELLIGENTES_MESSSYSTEM" #: Intelligentes Messsystem - ELEKTRONISCHER_ZAEHLER = "ELEKTRONISCHER_ZAEHLER" #: Elektronischer Zähler - WIRBELGASZAEHLER = "WIRBELGASZAEHLER" #: Wirbelgaszähler + """Wechselstromzähler - dieser Zählertyp wird für einphasige Ferraris-Zähler verwendet""" + MODERNE_MESSEINRICHTUNG = "MODERNE_MESSEINRICHTUNG" + """Moderne Messeinrichtung""" + INTELLIGENTES_MESSSYSTEM = "INTELLIGENTES_MESSSYSTEM" + """Intelligentes Messsystem""" + ELEKTRONISCHER_ZAEHLER = "ELEKTRONISCHER_ZAEHLER" + """Elektronischer Zähler""" + WIRBELGASZAEHLER = "WIRBELGASZAEHLER" + """Wirbelgaszähler""" diff --git a/src/bo4e/enum/zaehlertypspezifikation.py b/src/bo4e/enum/zaehlertypspezifikation.py index 3e3716280..92c6da3f5 100644 --- a/src/bo4e/enum/zaehlertypspezifikation.py +++ b/src/bo4e/enum/zaehlertypspezifikation.py @@ -8,8 +8,13 @@ class ZaehlertypSpezifikation(StrEnum): Bei diesem Enum handelt es sich um die Abbildung von besonderen Zählertyp-Spezifikationen der Sparten Strom und Gas. """ - EDL40 = "EDL40" #: EDL40 - EDL21 = "EDL21" #: EDL21 - SONSTIGER_EHZ = "SONSTIGER_EHZ" #: SONSTIGER_EHZ - MME_STANDARD = "MME_STANDARD" #: MME_STANDARD - MME_MEDA = "MME_MEDA" #: MME_MEDA + EDL40 = "EDL40" + """EDL40""" + EDL21 = "EDL21" + """EDL21""" + SONSTIGER_EHZ = "SONSTIGER_EHZ" + """SONSTIGER_EHZ""" + MME_STANDARD = "MME_STANDARD" + """MME_STANDARD""" + MME_MEDA = "MME_MEDA" + """MME_MEDA""" From 3a2c4a312128057bf38357392df2b029b0f4e8f1 Mon Sep 17 00:00:00 2001 From: Leon Haffmans Date: Fri, 24 Jan 2025 16:42:23 +0100 Subject: [PATCH 3/4] Only use pydantics docstring feature instead of custom logic --- src/bo4e/bo/geschaeftsobjekt.py | 1 + src/bo4e/utils/__init__.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/src/bo4e/bo/geschaeftsobjekt.py b/src/bo4e/bo/geschaeftsobjekt.py index 728b956c6..1b5ea648c 100644 --- a/src/bo4e/bo/geschaeftsobjekt.py +++ b/src/bo4e/bo/geschaeftsobjekt.py @@ -57,4 +57,5 @@ class Geschaeftsobjekt(BaseModel): # pragma: no cover # an annotated version of Decimal, but you would have to use it everywhere in the pydantic models. # See this issue for more info: https://github.com/pydantic/pydantic/issues/6375 json_encoders={Decimal: str}, + use_attribute_docstrings=True, ) diff --git a/src/bo4e/utils/__init__.py b/src/bo4e/utils/__init__.py index 014a08155..ce5cf0cfe 100644 --- a/src/bo4e/utils/__init__.py +++ b/src/bo4e/utils/__init__.py @@ -75,5 +75,5 @@ def postprocess_docstring(cls: type[T]) -> type[T]: """ if cls.__doc__ is not None: cls.__doc__ = cls.__doc__.format(__gh_version__=__gh_version__) - add_comments_to_description(cls) + # add_comments_to_description(cls) return cls From 2a8e914b4e32460fdd0917324b243ab65941a513 Mon Sep 17 00:00:00 2001 From: Leon Haffmans Date: Fri, 24 Jan 2025 17:08:48 +0100 Subject: [PATCH 4/4] =?UTF-8?q?=F0=9F=94=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/bo4e/utils/__init__.py | 56 -------------------------------------- 1 file changed, 56 deletions(-) diff --git a/src/bo4e/utils/__init__.py b/src/bo4e/utils/__init__.py index ce5cf0cfe..74035807f 100644 --- a/src/bo4e/utils/__init__.py +++ b/src/bo4e/utils/__init__.py @@ -2,8 +2,6 @@ utils necessary for reflection/inspection and documentation runs """ -import inspect -import re from typing import TypeVar from pydantic import BaseModel @@ -11,59 +9,6 @@ from ..version import __gh_version__ T = TypeVar("T", bound=BaseModel) -REGEX_CLASS_START = re.compile(r"class \w+\(.*\):(?:\s*#[^\n]*)?\n\s+\"{3}(?:\"{0,2}[^\"])*\"{3}\n") -# https://regex101.com/r/dQPi06/1 - - -def add_comments_to_description(cls: type[T]) -> type[T]: - """ - Add comments of fields to the description of the fields. This enables the generation of JSON-Schemas with proper - descriptions. - """ - code = inspect.getsource(cls) - split_result = REGEX_CLASS_START.split(code) - assert len(split_result) == 2, "The class source code structure is not as expected." - fields_code = split_result[1] - regex_comment_above = r"#: ?(?P[^\n]*)\n\s+{field_name}:" - # https://regex101.com/r/aJrvol/1 - regex_comment_inline = r"{field_name}:[^:]*#: ?(?P[^\n]*)\n" - # https://regex101.com/r/0PaUmw/1 - - for field_name, field_info in cls.model_fields.items(): - if field_info.description is not None: - field_info.description = field_info.description.strip() - continue - # search for (single line) comments above the field - match = re.search(regex_comment_above.format(field_name=field_name), fields_code) - if match is not None: - field_info.description = match.group("comment").strip() - continue - # search for (single line) comments inline with the field - match = re.search(regex_comment_inline.format(field_name=field_name), fields_code) - if match is not None: - field_info.description = match.group("comment").strip() - continue - # (multi line) comments below the field aka docstrings are now handled by pydantic - # Try to find the comment in the bases - description = None - for base in cls.__bases__: - if base == BaseModel: - continue - if not issubclass(base, BaseModel): - continue - if field_name in base.model_fields: - if base.model_fields[field_name].description is None: - add_comments_to_description(base) - description = base.model_fields[field_name].description - break - if description is not None: - field_info.description = description - continue - - # cls.model_rebuild(force=True) - # Unnecessary here since the models will be rebuilt in __init__.py. - # Keeping this here as comment though. - return cls def postprocess_docstring(cls: type[T]) -> type[T]: @@ -75,5 +20,4 @@ def postprocess_docstring(cls: type[T]) -> type[T]: """ if cls.__doc__ is not None: cls.__doc__ = cls.__doc__.format(__gh_version__=__gh_version__) - # add_comments_to_description(cls) return cls