diff --git a/docs/conf.py b/docs/conf.py index c17b18aca..4fedc840f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -90,7 +90,7 @@ # General information about the project. project = u"bo4e" -copyright = u"2021, Hochfrequenz GmbH" +copyright = u"2022, Hochfrequenz GmbH" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/src/bo4e/bo/angebot.py b/src/bo4e/bo/angebot.py index 1dcd75783..440e37d2a 100644 --- a/src/bo4e/bo/angebot.py +++ b/src/bo4e/bo/angebot.py @@ -29,6 +29,7 @@ class Angebot(Geschaeftsobjekt): .. HINT:: `Angebot JSON Schema `_ + """ bo_typ: BoTyp = attr.ib(default=BoTyp.ANGEBOT) diff --git a/src/bo4e/bo/ansprechpartner.py b/src/bo4e/bo/ansprechpartner.py index ea313d01f..48fa074b3 100644 --- a/src/bo4e/bo/ansprechpartner.py +++ b/src/bo4e/bo/ansprechpartner.py @@ -24,6 +24,7 @@ class Ansprechpartner(Geschaeftsobjekt): .. HINT:: `Ansprechpartner JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/ausschreibung.py b/src/bo4e/bo/ausschreibung.py index e28a88586..7fc8da680 100644 --- a/src/bo4e/bo/ausschreibung.py +++ b/src/bo4e/bo/ausschreibung.py @@ -27,6 +27,7 @@ class Ausschreibung(Geschaeftsobjekt): .. HINT:: `Ausschreibung JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/buendelvertrag.py b/src/bo4e/bo/buendelvertrag.py index 6c016202d..561ec7278 100644 --- a/src/bo4e/bo/buendelvertrag.py +++ b/src/bo4e/bo/buendelvertrag.py @@ -21,6 +21,7 @@ class Buendelvertrag(Geschaeftsobjekt): .. HINT:: `Buendelvertrag JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/energiemenge.py b/src/bo4e/bo/energiemenge.py index 689931858..691ff8060 100644 --- a/src/bo4e/bo/energiemenge.py +++ b/src/bo4e/bo/energiemenge.py @@ -23,6 +23,7 @@ class Energiemenge(Geschaeftsobjekt): .. HINT:: `Energiemenge JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/fremdkosten.py b/src/bo4e/bo/fremdkosten.py index a942a384a..b807c548f 100644 --- a/src/bo4e/bo/fremdkosten.py +++ b/src/bo4e/bo/fremdkosten.py @@ -23,6 +23,7 @@ class Fremdkosten(Geschaeftsobjekt): .. HINT:: `Fremdkosten JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/geschaeftspartner.py b/src/bo4e/bo/geschaeftspartner.py index a6586636d..d021eb3f9 100644 --- a/src/bo4e/bo/geschaeftspartner.py +++ b/src/bo4e/bo/geschaeftspartner.py @@ -27,6 +27,7 @@ class Geschaeftspartner(Geschaeftsobjekt): .. HINT:: `Geschaeftspartner JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/marktlokation.py b/src/bo4e/bo/marktlokation.py index b6f88059f..a2ee9fcac 100644 --- a/src/bo4e/bo/marktlokation.py +++ b/src/bo4e/bo/marktlokation.py @@ -32,6 +32,7 @@ class Marktlokation(Geschaeftsobjekt): .. HINT:: `Marktlokation JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/marktteilnehmer.py b/src/bo4e/bo/marktteilnehmer.py index 0458e1817..3cf2771cf 100644 --- a/src/bo4e/bo/marktteilnehmer.py +++ b/src/bo4e/bo/marktteilnehmer.py @@ -21,6 +21,7 @@ class Marktteilnehmer(Geschaeftspartner): .. HINT:: `Marktteilnehmer JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/messlokation.py b/src/bo4e/bo/messlokation.py index 117faba07..3e2773f97 100644 --- a/src/bo4e/bo/messlokation.py +++ b/src/bo4e/bo/messlokation.py @@ -39,6 +39,7 @@ class Messlokation(Geschaeftsobjekt): .. HINT:: `Messlokation JSON Schema `_ + """ # pylint: disable=unused-argument, no-self-use diff --git a/src/bo4e/bo/netznutzungsrechnung.py b/src/bo4e/bo/netznutzungsrechnung.py index c76724980..2dd928a6e 100644 --- a/src/bo4e/bo/netznutzungsrechnung.py +++ b/src/bo4e/bo/netznutzungsrechnung.py @@ -22,6 +22,7 @@ class Netznutzungsrechnung(Rechnung): .. HINT:: `Netznutzungsrechnung JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/preisblatt.py b/src/bo4e/bo/preisblatt.py index e93577732..ba0a41928 100644 --- a/src/bo4e/bo/preisblatt.py +++ b/src/bo4e/bo/preisblatt.py @@ -31,6 +31,7 @@ class Preisblatt(Geschaeftsobjekt): .. HINT:: `Preisblatt JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/preisblattdienstleistung.py b/src/bo4e/bo/preisblattdienstleistung.py index c65ff2b7b..4d0fbec15 100644 --- a/src/bo4e/bo/preisblattdienstleistung.py +++ b/src/bo4e/bo/preisblattdienstleistung.py @@ -22,6 +22,7 @@ class PreisblattDienstleistung(Preisblatt): .. HINT:: `PreisblattDienstleistung JSON Schema `_ + """ bo_typ: BoTyp = attr.ib(default=BoTyp.PREISBLATTDIENSTLEISTUNG) diff --git a/src/bo4e/bo/preisblattkonzessionsabgabe.py b/src/bo4e/bo/preisblattkonzessionsabgabe.py index dd7430685..6d21188ce 100644 --- a/src/bo4e/bo/preisblattkonzessionsabgabe.py +++ b/src/bo4e/bo/preisblattkonzessionsabgabe.py @@ -18,6 +18,7 @@ class PreisblattKonzessionsabgabe(Preisblatt): .. HINT:: `PreisblattKonzessionsabgabe JSON Schema `_ + """ bo_typ: BoTyp = attr.ib(default=BoTyp.PREISBLATTKONZESSIONSABGABE) diff --git a/src/bo4e/bo/preisblattmessung.py b/src/bo4e/bo/preisblattmessung.py index 71db6cf3b..14ba54e89 100644 --- a/src/bo4e/bo/preisblattmessung.py +++ b/src/bo4e/bo/preisblattmessung.py @@ -23,6 +23,7 @@ class PreisblattMessung(Preisblatt): .. HINT:: `PreisblattMessung JSON Schema `_ + """ bo_typ: BoTyp = attr.ib(default=BoTyp.PREISBLATTMESSUNG) diff --git a/src/bo4e/bo/preisblattnetznutzung.py b/src/bo4e/bo/preisblattnetznutzung.py index 00e75cf7d..04941ddd7 100644 --- a/src/bo4e/bo/preisblattnetznutzung.py +++ b/src/bo4e/bo/preisblattnetznutzung.py @@ -20,6 +20,7 @@ class PreisblattNetznutzung(Preisblatt): .. HINT:: `PreisblattNetznutzung JSON Schema `_ + """ bo_typ: BoTyp = attr.ib(default=BoTyp.PREISBLATTNETZNUTZUNG) diff --git a/src/bo4e/bo/region.py b/src/bo4e/bo/region.py index 593cd213a..e8012070d 100644 --- a/src/bo4e/bo/region.py +++ b/src/bo4e/bo/region.py @@ -20,6 +20,7 @@ class Region(Geschaeftsobjekt): .. HINT:: `Region JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/regionaltarif.py b/src/bo4e/bo/regionaltarif.py index dc47f0026..083666dd0 100644 --- a/src/bo4e/bo/regionaltarif.py +++ b/src/bo4e/bo/regionaltarif.py @@ -27,6 +27,7 @@ class Regionaltarif(Tarifinfo): .. HINT:: `Regionaltarif JSON Schema `_ + """ bo_typ: BoTyp = attr.ib(default=BoTyp.REGIONALTARIF) diff --git a/src/bo4e/bo/standorteigenschaften.py b/src/bo4e/bo/standorteigenschaften.py index af46fed1b..7de5b90cf 100644 --- a/src/bo4e/bo/standorteigenschaften.py +++ b/src/bo4e/bo/standorteigenschaften.py @@ -23,6 +23,7 @@ class Standorteigenschaften(Geschaeftsobjekt): .. HINT:: `Standorteigenschaften JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/tarif.py b/src/bo4e/bo/tarif.py index ba6ee5cbc..ffde3279c 100644 --- a/src/bo4e/bo/tarif.py +++ b/src/bo4e/bo/tarif.py @@ -26,6 +26,7 @@ class Tarif(Tarifinfo): .. HINT:: `Tarif JSON Schema `_ + """ bo_typ: BoTyp = attr.ib(default=BoTyp.TARIF) diff --git a/src/bo4e/bo/tarifinfo.py b/src/bo4e/bo/tarifinfo.py index e8e5aff14..1848aa3f1 100644 --- a/src/bo4e/bo/tarifinfo.py +++ b/src/bo4e/bo/tarifinfo.py @@ -31,6 +31,7 @@ class Tarifinfo(Geschaeftsobjekt): .. HINT:: `Tarifinfo JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/tarifkosten.py b/src/bo4e/bo/tarifkosten.py index b54f5aeea..91f0e1666 100644 --- a/src/bo4e/bo/tarifkosten.py +++ b/src/bo4e/bo/tarifkosten.py @@ -18,6 +18,7 @@ class Tarifkosten(Tarifinfo): .. HINT:: `Tarifkosten JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/tarifpreisblatt.py b/src/bo4e/bo/tarifpreisblatt.py index a0788172a..cc0ddfea2 100644 --- a/src/bo4e/bo/tarifpreisblatt.py +++ b/src/bo4e/bo/tarifpreisblatt.py @@ -25,6 +25,7 @@ class Tarifpreisblatt(Tarifinfo): .. HINT:: `Tarifpreisblatt JSON Schema `_ + """ bo_typ: BoTyp = attr.ib(default=BoTyp.TARIFPREISBLATT) diff --git a/src/bo4e/bo/vertrag.py b/src/bo4e/bo/vertrag.py index a1d85a30c..972cdf2a7 100644 --- a/src/bo4e/bo/vertrag.py +++ b/src/bo4e/bo/vertrag.py @@ -38,6 +38,7 @@ class Vertrag(Geschaeftsobjekt): .. HINT:: `Vertrag JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/bo/zaehler.py b/src/bo4e/bo/zaehler.py index eca842d79..ca7686e81 100644 --- a/src/bo4e/bo/zaehler.py +++ b/src/bo4e/bo/zaehler.py @@ -37,6 +37,7 @@ class Zaehler(Geschaeftsobjekt): .. HINT:: `Zaehler JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/adresse.py b/src/bo4e/com/adresse.py index f0824d0f4..24ee34fb6 100644 --- a/src/bo4e/com/adresse.py +++ b/src/bo4e/com/adresse.py @@ -33,7 +33,8 @@ class Adresse(COM): Contains an address that can be used for most purposes. .. HINT:: - `Adresse JSON Schema `_ + `Adresse JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/angebotsposition.py b/src/bo4e/com/angebotsposition.py index 52df78b49..ce2b728b4 100644 --- a/src/bo4e/com/angebotsposition.py +++ b/src/bo4e/com/angebotsposition.py @@ -23,7 +23,7 @@ class Angebotsposition(COM): Positionskosten: 982,40 EUR .. HINT:: - `Angebotsposition JSON Schema `_ + `Angebotsposition JSON Schema `_ """ diff --git a/src/bo4e/com/angebotsteil.py b/src/bo4e/com/angebotsteil.py index 6cff10c0a..8eab5813b 100644 --- a/src/bo4e/com/angebotsteil.py +++ b/src/bo4e/com/angebotsteil.py @@ -28,7 +28,7 @@ class Angebotsteil(COM): Eine Variante besteht mindestens aus einem Angebotsteil. .. HINT:: - `Angebotsteil JSON Schema `_ + `Angebotsteil JSON Schema `_ """ diff --git a/src/bo4e/com/angebotsvariante.py b/src/bo4e/com/angebotsvariante.py index 5b25c0119..06a88484e 100644 --- a/src/bo4e/com/angebotsvariante.py +++ b/src/bo4e/com/angebotsvariante.py @@ -23,7 +23,8 @@ class Angebotsvariante(COM): Führt die verschiedenen Ausprägungen der Angebotsberechnung auf .. HINT:: - `Angebotsvariante JSON Schema `_ + `Angebotsvariante JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/aufabschlag.py b/src/bo4e/com/aufabschlag.py index f626243c9..86c6946b7 100644 --- a/src/bo4e/com/aufabschlag.py +++ b/src/bo4e/com/aufabschlag.py @@ -26,7 +26,8 @@ class AufAbschlag(COM): die individuell zu einem neuen oder bestehenden Liefervertrag abgeschlossen wurden. .. HINT:: - `AufAbschlag JSON Schema `_ + `AufAbschlag JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/aufabschlagproort.py b/src/bo4e/com/aufabschlagproort.py index a0d3a7661..8b73de6ea 100644 --- a/src/bo4e/com/aufabschlagproort.py +++ b/src/bo4e/com/aufabschlagproort.py @@ -21,7 +21,7 @@ class AufAbschlagProOrt(COM): mit örtlichen Gültigkeiten abgebildet werden. .. HINT:: - `AufAbschlagProOrt JSON Schema `_ + `AufAbschlagProOrt JSON Schema `_ """ diff --git a/src/bo4e/com/aufabschlagregional.py b/src/bo4e/com/aufabschlagregional.py index 1851a2184..bec08b177 100644 --- a/src/bo4e/com/aufabschlagregional.py +++ b/src/bo4e/com/aufabschlagregional.py @@ -31,7 +31,7 @@ class AufAbschlagRegional(COM): die sich durch die Auswahl eines Auf- oder Abschlags ergeben. .. HINT:: - `AufAbschlagRegional JSON Schema `_ + `AufAbschlagRegional JSON Schema `_ """ diff --git a/src/bo4e/com/aufabschlagstaffelproort.py b/src/bo4e/com/aufabschlagstaffelproort.py index d9e0a8fa3..6d936bef0 100644 --- a/src/bo4e/com/aufabschlagstaffelproort.py +++ b/src/bo4e/com/aufabschlagstaffelproort.py @@ -18,7 +18,8 @@ class AufAbschlagstaffelProOrt(COM): Gibt den Wert eines Auf- oder Abschlags und dessen Staffelgrenzen an .. HINT:: - `AufAbschlagstaffelProOrt JSON Schema `_ + `AufAbschlagstaffelProOrt JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/ausschreibungsdetail.py b/src/bo4e/com/ausschreibungsdetail.py index bed79901a..2f13a2bf3 100644 --- a/src/bo4e/com/ausschreibungsdetail.py +++ b/src/bo4e/com/ausschreibungsdetail.py @@ -24,7 +24,7 @@ class Ausschreibungsdetail(COM): Ausschreibungsloses abzubilden. .. HINT:: - `Ausschreibungsdetail JSON Schema `_ + `Ausschreibungsdetail JSON Schema `_ """ diff --git a/src/bo4e/com/ausschreibungslos.py b/src/bo4e/com/ausschreibungslos.py index 78677de97..5ef2ecd53 100644 --- a/src/bo4e/com/ausschreibungslos.py +++ b/src/bo4e/com/ausschreibungslos.py @@ -26,7 +26,7 @@ class Ausschreibungslos(COM): Eine Komponente zur Abbildung einzelner Lose einer Ausschreibung .. HINT:: - `Ausschreibungslos JSON Schema `_ + `Ausschreibungslos JSON Schema `_ """ diff --git a/src/bo4e/com/betrag.py b/src/bo4e/com/betrag.py index 4eebaa5e5..91b3118fe 100644 --- a/src/bo4e/com/betrag.py +++ b/src/bo4e/com/betrag.py @@ -21,7 +21,7 @@ class Betrag(COM): abzubilden. Die Einheit ist dabei immer die Hauptwährung also Euro, Dollar etc… .. HINT:: - `Betrag JSON Schema `_ + `Betrag JSON Schema `_ """ diff --git a/src/bo4e/com/dienstleistung.py b/src/bo4e/com/dienstleistung.py index 92f1db4dc..117b5f868 100644 --- a/src/bo4e/com/dienstleistung.py +++ b/src/bo4e/com/dienstleistung.py @@ -18,7 +18,8 @@ class Dienstleistung(COM): Abbildung einer abrechenbaren Dienstleistung. .. HINT:: - `Dienstleistung JSON Schema `_ + `Dienstleistung JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/energieherkunft.py b/src/bo4e/com/energieherkunft.py index ecf177c16..1d62353a9 100644 --- a/src/bo4e/com/energieherkunft.py +++ b/src/bo4e/com/energieherkunft.py @@ -20,7 +20,7 @@ class Energieherkunft(COM): Abbildung einer Energieherkunft .. HINT:: - `Energieherkunft JSON Schema `_ + `Energieherkunft JSON Schema `_ """ diff --git a/src/bo4e/com/energiemix.py b/src/bo4e/com/energiemix.py index a0ec5b94f..2a87781ac 100644 --- a/src/bo4e/com/energiemix.py +++ b/src/bo4e/com/energiemix.py @@ -25,7 +25,7 @@ class Energiemix(COM): Zusammensetzung der gelieferten Energie aus den verschiedenen Primärenergieformen. .. HINT:: - `Energiemix JSON Schema `_ + `Energiemix JSON Schema `_ """ diff --git a/src/bo4e/com/externereferenz.py b/src/bo4e/com/externereferenz.py index ff8b5b31f..a175e69fe 100644 --- a/src/bo4e/com/externereferenz.py +++ b/src/bo4e/com/externereferenz.py @@ -17,7 +17,7 @@ class ExterneReferenz(COM): sich die eindeutigen IDs der anzubindenden Systeme zu merken. .. HINT:: - `ExterneReferenz JSON Schema `_ + `ExterneReferenz JSON Schema `_ """ diff --git a/src/bo4e/com/fremdkostenblock.py b/src/bo4e/com/fremdkostenblock.py index b506db88b..6cce381ba 100644 --- a/src/bo4e/com/fremdkostenblock.py +++ b/src/bo4e/com/fremdkostenblock.py @@ -20,7 +20,7 @@ class Fremdkostenblock(COM): Komponente zur Abbildung eines Kostenblocks in den Fremdkosten .. HINT:: - `Fremdkostenblock JSON Schema `_ + `Fremdkostenblock JSON Schema `_ """ diff --git a/src/bo4e/com/fremdkostenposition.py b/src/bo4e/com/fremdkostenposition.py index 3d4833b91..fa9767851 100644 --- a/src/bo4e/com/fremdkostenposition.py +++ b/src/bo4e/com/fremdkostenposition.py @@ -16,7 +16,7 @@ class Fremdkostenposition(Kostenposition): Eine Kostenposition im Bereich der Fremdkosten .. HINT:: - `Fremdkostenposition JSON Schema `_ + `Fremdkostenposition JSON Schema `_ """ diff --git a/src/bo4e/com/geokoordinaten.py b/src/bo4e/com/geokoordinaten.py index 3695d4d8c..38b1e59f1 100644 --- a/src/bo4e/com/geokoordinaten.py +++ b/src/bo4e/com/geokoordinaten.py @@ -17,7 +17,8 @@ class Geokoordinaten(COM): This component provides the geo-coordinates for a location. .. HINT:: - `Geokoordinaten JSON Schema `_ + `Geokoordinaten JSON Schema `_ + """ # = attr.ib() has to be there, to make the validator work diff --git a/src/bo4e/com/geraet.py b/src/bo4e/com/geraet.py index da3a858ed..81b30232c 100644 --- a/src/bo4e/com/geraet.py +++ b/src/bo4e/com/geraet.py @@ -19,7 +19,8 @@ class Geraet(COM): Mit dieser Komponente werden alle Geräte modelliert, die keine Zähler sind. .. HINT:: - `Geraet JSON Schema `_ + `Geraet JSON Schema `_ + """ # optional attributes diff --git a/src/bo4e/com/geraeteeigenschaften.py b/src/bo4e/com/geraeteeigenschaften.py index aacab7491..e865b137d 100644 --- a/src/bo4e/com/geraeteeigenschaften.py +++ b/src/bo4e/com/geraeteeigenschaften.py @@ -18,7 +18,8 @@ class Geraeteeigenschaften(COM): Mit dieser Komponente werden die Eigenschaften eines Gerätes in Bezug auf den Typ und weitere Merkmale modelliert .. HINT:: - `Geraeteeigenschaften JSON Schema `_ + `Geraeteeigenschaften JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/hardware.py b/src/bo4e/com/hardware.py index 95c5a8256..66fb363fe 100644 --- a/src/bo4e/com/hardware.py +++ b/src/bo4e/com/hardware.py @@ -18,7 +18,8 @@ class Hardware(COM): Abbildung einer abrechenbaren Hardware. .. HINT:: - `Hardware JSON Schema `_ + `Hardware JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/katasteradresse.py b/src/bo4e/com/katasteradresse.py index e88d77b57..0203d4d7c 100644 --- a/src/bo4e/com/katasteradresse.py +++ b/src/bo4e/com/katasteradresse.py @@ -15,7 +15,8 @@ class Katasteradresse(COM): Dient der Adressierung über die Liegenschafts-Information. .. HINT:: - `Katasteradresse JSON Schema `_ + `Katasteradresse JSON Schema `_ + """ gemarkung_flur: str diff --git a/src/bo4e/com/kostenblock.py b/src/bo4e/com/kostenblock.py index 45e7c93c1..5a3520823 100644 --- a/src/bo4e/com/kostenblock.py +++ b/src/bo4e/com/kostenblock.py @@ -18,7 +18,8 @@ class Kostenblock(COM): Mit dieser Komponente werden mehrere Kostenpositionen zusammengefasst. .. HINT:: - `Kostenblock JSON Schema `_ + `Kostenblock JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/kostenposition.py b/src/bo4e/com/kostenposition.py index 93722daaf..def7e661f 100644 --- a/src/bo4e/com/kostenposition.py +++ b/src/bo4e/com/kostenposition.py @@ -21,7 +21,8 @@ class Kostenposition(COM): Diese Komponente wird zur Übertagung der Details zu einer Kostenposition verwendet. .. HINT:: - `Kostenposition JSON Schema `_ + `Kostenposition JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/kriteriumwert.py b/src/bo4e/com/kriteriumwert.py index 396d6f8c0..9e93c0440 100644 --- a/src/bo4e/com/kriteriumwert.py +++ b/src/bo4e/com/kriteriumwert.py @@ -19,7 +19,8 @@ class KriteriumWert(COM): Mit dieser Komponente können Kriterien und deren Werte definiert werden .. HINT:: - `KriteriumWert JSON Schema `_ + `KriteriumWert JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/marktgebietinfo.py b/src/bo4e/com/marktgebietinfo.py index 90fb95e8c..b75de5fbe 100644 --- a/src/bo4e/com/marktgebietinfo.py +++ b/src/bo4e/com/marktgebietinfo.py @@ -15,7 +15,8 @@ class MarktgebietInfo(COM): Informationen zum Marktgebiet im Gas. .. HINT:: - `MarktgebietInfo JSON Schema `_ + `MarktgebietInfo JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/menge.py b/src/bo4e/com/menge.py index 635a17342..8bc923fb3 100644 --- a/src/bo4e/com/menge.py +++ b/src/bo4e/com/menge.py @@ -20,7 +20,8 @@ class Menge(COM): Abbildung einer Menge mit Wert und Einheit. .. HINT:: - `Menge JSON Schema `_ + `Menge JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/messlokationszuordnung.py b/src/bo4e/com/messlokationszuordnung.py index 91e852a32..521b1253c 100644 --- a/src/bo4e/com/messlokationszuordnung.py +++ b/src/bo4e/com/messlokationszuordnung.py @@ -21,7 +21,7 @@ class Messlokationszuordnung(COM): mit der die Messlokation zum Verbrauch der Marktlokation beiträgt. .. HINT:: - `Messlokationszuordnung JSON Schema `_ + `Messlokationszuordnung JSON Schema `_ """ diff --git a/src/bo4e/com/positionsaufabschlag.py b/src/bo4e/com/positionsaufabschlag.py index 017fd2282..ffa798ccb 100644 --- a/src/bo4e/com/positionsaufabschlag.py +++ b/src/bo4e/com/positionsaufabschlag.py @@ -22,7 +22,8 @@ class PositionsAufAbschlag(COM): Es können mehrere Auf-/Abschläge gleichzeitig ausgewählt werden. .. HINT:: - `PositionsAufAbschlag JSON Schema `_ + `PositionsAufAbschlag JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/preis.py b/src/bo4e/com/preis.py index ca5d3108b..bfa90ff9c 100644 --- a/src/bo4e/com/preis.py +++ b/src/bo4e/com/preis.py @@ -23,7 +23,8 @@ class Preis(COM): Abbildung eines Preises mit Wert, Einheit, Bezugswert und Status. .. HINT:: - `Preis JSON Schema `_ + `Preis JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/preisgarantie.py b/src/bo4e/com/preisgarantie.py index a4411096e..cf6bb571e 100644 --- a/src/bo4e/com/preisgarantie.py +++ b/src/bo4e/com/preisgarantie.py @@ -21,7 +21,8 @@ class Preisgarantie(COM): Definition für eine Preisgarantie mit der Möglichkeit verschiedener Ausprägungen. .. HINT:: - `Preisgarantie JSON Schema `_ + `Preisgarantie JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/preisposition.py b/src/bo4e/com/preisposition.py index b8a259acc..3963b827f 100644 --- a/src/bo4e/com/preisposition.py +++ b/src/bo4e/com/preisposition.py @@ -29,7 +29,8 @@ class Preisposition(COM): Preis für eine definierte Lieferung oder Leistung innerhalb eines Preisblattes .. HINT:: - `Preisposition JSON Schema `_ + `Preisposition JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/preisstaffel.py b/src/bo4e/com/preisstaffel.py index 8a2b6d1d6..155872741 100644 --- a/src/bo4e/com/preisstaffel.py +++ b/src/bo4e/com/preisstaffel.py @@ -19,7 +19,8 @@ class Preisstaffel(COM): Gibt die Staffelgrenzen der jeweiligen Preise an .. HINT:: - `Preisstaffel JSON Schema `_ + `Preisstaffel JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/rechnungsposition.py b/src/bo4e/com/rechnungsposition.py index 791418fdc..ebd2da52e 100644 --- a/src/bo4e/com/rechnungsposition.py +++ b/src/bo4e/com/rechnungsposition.py @@ -27,7 +27,8 @@ class Rechnungsposition(COM): In einem Rechnungsteil wird jeweils eine in sich geschlossene Leistung abgerechnet. .. HINT:: - `Rechnungsposition JSON Schema `_ + `Rechnungsposition JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/regionalegueltigkeit.py b/src/bo4e/com/regionalegueltigkeit.py index ab66e73b7..ce13fdf76 100644 --- a/src/bo4e/com/regionalegueltigkeit.py +++ b/src/bo4e/com/regionalegueltigkeit.py @@ -21,7 +21,8 @@ class RegionaleGueltigkeit(COM): Mit dieser Komponente können regionale Gültigkeiten, z.B. für Tarife, Zu- und Abschläge und Preise definiert werden. .. HINT:: - `RegionaleGueltigkeit JSON Schema `_ + `RegionaleGueltigkeit JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/regionalepreisgarantie.py b/src/bo4e/com/regionalepreisgarantie.py index 32bb05437..290f6745a 100644 --- a/src/bo4e/com/regionalepreisgarantie.py +++ b/src/bo4e/com/regionalepreisgarantie.py @@ -17,7 +17,8 @@ class RegionalePreisgarantie(Preisgarantie): Abbildung einer Preisgarantie mit regionaler Abgrenzung .. HINT:: - `RegionalePreisgarantie JSON Schema `_ + `RegionalePreisgarantie JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/regionalepreisstaffel.py b/src/bo4e/com/regionalepreisstaffel.py index 01a89c033..3c1e35cca 100644 --- a/src/bo4e/com/regionalepreisstaffel.py +++ b/src/bo4e/com/regionalepreisstaffel.py @@ -16,7 +16,8 @@ class RegionalePreisstaffel(Preisstaffel): Abbildung einer Preisstaffel mit regionaler Abgrenzung .. HINT:: - `RegionalePreisstaffel JSON Schema `_ + `RegionalePreisstaffel JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/regionaleraufabschlag.py b/src/bo4e/com/regionaleraufabschlag.py index fcb81d697..e42e663cc 100644 --- a/src/bo4e/com/regionaleraufabschlag.py +++ b/src/bo4e/com/regionaleraufabschlag.py @@ -31,7 +31,8 @@ class RegionalerAufAbschlag(COM): oder Abschlags ergeben. .. HINT:: - `RegionalerAufAbschlag JSON Schema `_ + `RegionalerAufAbschlag JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/regionaletarifpreisposition.py b/src/bo4e/com/regionaletarifpreisposition.py index 442e0a0eb..072a1e425 100644 --- a/src/bo4e/com/regionaletarifpreisposition.py +++ b/src/bo4e/com/regionaletarifpreisposition.py @@ -23,7 +23,8 @@ class RegionaleTarifpreisposition(COM): werden. .. HINT:: - `RegionaleTarifpreisposition JSON Schema `_ + `RegionaleTarifpreisposition JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/regionskriterium.py b/src/bo4e/com/regionskriterium.py index eb5b84f0c..e9d6f8cd6 100644 --- a/src/bo4e/com/regionskriterium.py +++ b/src/bo4e/com/regionskriterium.py @@ -19,7 +19,8 @@ class Regionskriterium(COM): Komponente zur Abbildung eines Regionskriteriums .. HINT:: - `Regionskriterium JSON Schema `_ + `Regionskriterium JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/rufnummer.py b/src/bo4e/com/rufnummer.py index 40bb6cc7f..8d2d691d5 100644 --- a/src/bo4e/com/rufnummer.py +++ b/src/bo4e/com/rufnummer.py @@ -17,7 +17,8 @@ class Rufnummer(COM): Contains information to call or fax someone .. HINT:: - `Rufnummer JSON Schema `_ + `Rufnummer JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/sigmoidparameter.py b/src/bo4e/com/sigmoidparameter.py index 8a7b2ec87..2f7c46aea 100644 --- a/src/bo4e/com/sigmoidparameter.py +++ b/src/bo4e/com/sigmoidparameter.py @@ -18,7 +18,8 @@ class Sigmoidparameter(COM): LP=A/(1+(P/B)^C)+D .. HINT:: - `Sigmoidparameter JSON Schema `_ + `Sigmoidparameter JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/standorteigenschaftenallgemein.py b/src/bo4e/com/standorteigenschaftenallgemein.py index ca1877948..b28aac975 100644 --- a/src/bo4e/com/standorteigenschaftenallgemein.py +++ b/src/bo4e/com/standorteigenschaftenallgemein.py @@ -17,7 +17,8 @@ class StandorteigenschaftenAllgemein(COM): Allgemeine Standorteigenschaften .. HINT:: - `StandorteigenschaftenAllgemein JSON Schema `_ + `StandorteigenschaftenAllgemein JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/standorteigenschaftengas.py b/src/bo4e/com/standorteigenschaftengas.py index 50aa1d916..206c962b2 100644 --- a/src/bo4e/com/standorteigenschaftengas.py +++ b/src/bo4e/com/standorteigenschaftengas.py @@ -19,7 +19,8 @@ class StandorteigenschaftenGas(COM): Standorteigenschaften der Sparte Gas .. HINT:: - `StandorteigenschaftenGas JSON Schema `_ + `StandorteigenschaftenGas JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/standorteigenschaftenstrom.py b/src/bo4e/com/standorteigenschaftenstrom.py index b60f5dd27..ba61780ed 100644 --- a/src/bo4e/com/standorteigenschaftenstrom.py +++ b/src/bo4e/com/standorteigenschaftenstrom.py @@ -16,7 +16,8 @@ class StandorteigenschaftenStrom(COM): Standorteigenschaften der Sparte Strom .. HINT:: - `StandorteigenschaftenStrom JSON Schema `_ + `StandorteigenschaftenStrom JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/steuerbetrag.py b/src/bo4e/com/steuerbetrag.py index 6a991db7f..cfb7c53e7 100644 --- a/src/bo4e/com/steuerbetrag.py +++ b/src/bo4e/com/steuerbetrag.py @@ -21,7 +21,8 @@ class Steuerbetrag(COM): Abbildung eines Steuerbetrages. .. HINT:: - `Steuerbetrag JSON Schema `_ + `Steuerbetrag JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/tagesvektor.py b/src/bo4e/com/tagesvektor.py index dd4b1f746..fd2826cfb 100644 --- a/src/bo4e/com/tagesvektor.py +++ b/src/bo4e/com/tagesvektor.py @@ -20,7 +20,8 @@ class Tagesvektor(COM): Abbildung eines Tagesvektors eines beliebigen äquidistanten Zeitrasters .. HINT:: - `Tagesvektor JSON Schema `_ + `Tagesvektor JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/tarifberechnungsparameter.py b/src/bo4e/com/tarifberechnungsparameter.py index 06f388356..9539de4fe 100644 --- a/src/bo4e/com/tarifberechnungsparameter.py +++ b/src/bo4e/com/tarifberechnungsparameter.py @@ -24,7 +24,8 @@ class Tarifberechnungsparameter(COM): """ .. HINT:: - `Tarifberechnungsparameter JSON Schema `_ + `Tarifberechnungsparameter JSON Schema `_ + """ # there are no required attributes diff --git a/src/bo4e/com/tarifeinschraenkung.py b/src/bo4e/com/tarifeinschraenkung.py index 9ac188edc..9c47cb01e 100644 --- a/src/bo4e/com/tarifeinschraenkung.py +++ b/src/bo4e/com/tarifeinschraenkung.py @@ -20,7 +20,8 @@ class Tarifeinschraenkung(COM): Mit dieser Komponente werden Einschränkungen für die Anwendung von Tarifen modelliert. .. HINT:: - `Tarifeinschraenkung JSON Schema `_ + `Tarifeinschraenkung JSON Schema `_ + """ # optional attributes diff --git a/src/bo4e/com/tarifpreis.py b/src/bo4e/com/tarifpreis.py index 74baf47d9..896d8eb31 100644 --- a/src/bo4e/com/tarifpreis.py +++ b/src/bo4e/com/tarifpreis.py @@ -20,7 +20,8 @@ class Tarifpreis(Preis): Abbildung eines Tarifpreises mit Preistyp und Beschreibung abgeleitet von COM Preis. .. HINT:: - `Tarifpreis JSON Schema `_ + `Tarifpreis JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/tarifpreisposition.py b/src/bo4e/com/tarifpreisposition.py index f436c1c6b..2cc833c7f 100644 --- a/src/bo4e/com/tarifpreisposition.py +++ b/src/bo4e/com/tarifpreisposition.py @@ -24,7 +24,7 @@ class Tarifpreisposition(COM): Mit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden. .. HINT:: - `Tarifpreisposition JSON Schema `_ + `Tarifpreisposition JSON Schema `_ """ diff --git a/src/bo4e/com/tarifpreispositionproort.py b/src/bo4e/com/tarifpreispositionproort.py index c0b73fff4..4fcc7357c 100644 --- a/src/bo4e/com/tarifpreispositionproort.py +++ b/src/bo4e/com/tarifpreispositionproort.py @@ -20,7 +20,8 @@ class TarifpreispositionProOrt(COM): Mit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden .. HINT:: - `TarifpreispositionProOrt JSON Schema `_ + `TarifpreispositionProOrt JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/tarifpreisstaffelproort.py b/src/bo4e/com/tarifpreisstaffelproort.py index 485a520ba..e4b5f77ae 100644 --- a/src/bo4e/com/tarifpreisstaffelproort.py +++ b/src/bo4e/com/tarifpreisstaffelproort.py @@ -17,7 +17,7 @@ class TarifpreisstaffelProOrt(COM): Gibt die Staffelgrenzen der jeweiligen Preise an .. HINT:: - `TarifpreisstaffelProOrt JSON Schema `_ + `TarifpreisstaffelProOrt JSON Schema `_ """ diff --git a/src/bo4e/com/unterschrift.py b/src/bo4e/com/unterschrift.py index 7a499a0ae..5d936a21e 100644 --- a/src/bo4e/com/unterschrift.py +++ b/src/bo4e/com/unterschrift.py @@ -17,7 +17,8 @@ class Unterschrift(COM): Modellierung einer Unterschrift, z.B. für Verträge, Angebote etc. .. HINT:: - `Unterschrift JSON Schema `_ + `Unterschrift JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/verbrauch.py b/src/bo4e/com/verbrauch.py index c377f6768..4aeaac1c0 100644 --- a/src/bo4e/com/verbrauch.py +++ b/src/bo4e/com/verbrauch.py @@ -22,7 +22,8 @@ class Verbrauch(COM): Abbildung eines zeitlich abgegrenzten Verbrauchs .. HINT:: - `Verbrauch JSON Schema `_ + `Verbrauch JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/vertragskonditionen.py b/src/bo4e/com/vertragskonditionen.py index e0fe0ea39..f795f8e1f 100644 --- a/src/bo4e/com/vertragskonditionen.py +++ b/src/bo4e/com/vertragskonditionen.py @@ -18,7 +18,8 @@ class Vertragskonditionen(COM): Abbildung für Vertragskonditionen. Die Komponente wird sowohl im Vertrag als auch im Tarif verwendet. .. HINT:: - `Vertragskonditionen JSON Schema `_ + `Vertragskonditionen JSON Schema `_ + """ # optional attributes diff --git a/src/bo4e/com/vertragsteil.py b/src/bo4e/com/vertragsteil.py index 08f5f6749..9d5ff5789 100644 --- a/src/bo4e/com/vertragsteil.py +++ b/src/bo4e/com/vertragsteil.py @@ -20,7 +20,8 @@ class Vertragsteil(COM): eine vertragliche Leistung in Bezug zu einer Lokation (Markt- oder Messlokation) festzulegen. .. HINT:: - `Vertragsteil JSON Schema `_ + `Vertragsteil JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/zaehlwerk.py b/src/bo4e/com/zaehlwerk.py index 271112537..35daa1620 100644 --- a/src/bo4e/com/zaehlwerk.py +++ b/src/bo4e/com/zaehlwerk.py @@ -21,7 +21,8 @@ class Zaehlwerk(COM): Mit dieser Komponente werden Zählwerke modelliert. .. HINT:: - `Zaehlwerk JSON Schema `_ + `Zaehlwerk JSON Schema `_ + """ zaehlwerk_id: str = attr.ib( diff --git a/src/bo4e/com/zeitintervall.py b/src/bo4e/com/zeitintervall.py index 2a565e262..774596609 100644 --- a/src/bo4e/com/zeitintervall.py +++ b/src/bo4e/com/zeitintervall.py @@ -18,7 +18,8 @@ class Zeitintervall(COM): Z.B. zur Anwendung als Raster in äquidistanten Zeitreihen/Lastgängen, beispielsweise 15 Minuten. .. HINT:: - `Zeitintervall JSON Schema `_ + `Zeitintervall JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/zeitraum.py b/src/bo4e/com/zeitraum.py index 5b507d31f..562d039b1 100644 --- a/src/bo4e/com/zeitraum.py +++ b/src/bo4e/com/zeitraum.py @@ -20,10 +20,8 @@ def time_range_possibilities(instance, attribute, value): """ An address is valid if it contains a postfach XOR (a strasse AND hausnummer). This functions checks for these conditions of a valid address. - - .. HINT:: - `Zeitraum JSON Schema `_ """ + if ( instance.einheit and instance.dauer @@ -62,6 +60,10 @@ class Zeitraum(COM): - Einheit und Dauer oder - Zeitraum: Startdatum bis Enddatum oder - Zeitraum: Startzeitpunkt (Datum und Uhrzeit) bis Endzeitpunkt (Datum und Uhrzeit) + + .. HINT:: + `Zeitraum JSON Schema `_ + """ # optional attributes diff --git a/src/bo4e/com/zeitreihenwert.py b/src/bo4e/com/zeitreihenwert.py index af5e89c86..663d23212 100644 --- a/src/bo4e/com/zeitreihenwert.py +++ b/src/bo4e/com/zeitreihenwert.py @@ -18,7 +18,8 @@ class Zeitreihenwert(Zeitreihenwertkompakt): Abbildung eines Zeitreihenwertes bestehend aus Zeitraum, Wert und Statusinformationen. .. HINT:: - `Zeitreihenwert JSON Schema `_ + `Zeitreihenwert JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/zeitreihenwertkompakt.py b/src/bo4e/com/zeitreihenwertkompakt.py index 1649ff97e..b9a3c6282 100644 --- a/src/bo4e/com/zeitreihenwertkompakt.py +++ b/src/bo4e/com/zeitreihenwertkompakt.py @@ -21,7 +21,8 @@ class Zeitreihenwertkompakt(COM): Abbildung eines kompakten Zeitreihenwertes in dem ausschliesslich der Wert und Statusinformationen stehen. .. HINT:: - `Zeitreihenwertkompakt JSON Schema `_ + `Zeitreihenwertkompakt JSON Schema `_ + """ # required attributes diff --git a/src/bo4e/com/zustaendigkeit.py b/src/bo4e/com/zustaendigkeit.py index 09c5adf48..e45f56459 100644 --- a/src/bo4e/com/zustaendigkeit.py +++ b/src/bo4e/com/zustaendigkeit.py @@ -18,7 +18,8 @@ class Zustaendigkeit(COM): Enthält die zeitliche Zuordnung eines Ansprechpartners zu Abteilungen und Zuständigkeiten. .. HINT:: - `Zustaendigkeit JSON Schema `_ + `Zustaendigkeit JSON Schema `_ + """ # required attributes