Some small fixes to be compatible with a database structure (#28)

* Add Links in README.rst to Open PR/Draft a Release

* Add more detail to serialization test

* Correct typos in test_missing_required_attributes

* Fix typo in street name

* Add postfach as alternative to strasse

Before strasse and hausnummer were required attributes and postfach was optional.  Since postfach should be an alternative address to strasse and hausnummer this was changed to either strasse and hausnummer or postfach are required attributes.
Additionally the other required attributes are made sure to be strings and not empty.

* ✅ Add tests for postfach as required field

Add two test: one for postfach as regular required field, the second for different combinations of strasse, hausnummer and postfach to test the validator in the Adresse class (adresse.py)

* Add assertion for landescode

Co-authored-by: hf-krechan <68426071+hf-krechan@users.noreply.github.com>

* Correct Landescode assertion

Landescode has to be an Enum

* Update address requirements

The minimal address in Germany is only a zip code and city  (for example for institutions like universities or big companies or postfächer without a number but a special zip code) 
A street always needs a hausnummer and vice versa.
Postfächer don't have a street, but a number OR a zipcode.

* ✅ Update tests for updated address requirements

Added test for only postleitzahl and ort
Added docstrings to serialization tests of strasse and postleitzahl
Updated test for the function strasse_xor_postfach in Class Adresse (adresse.py) for the updates in the requirements of a german address

* 🏷️ fix wrongly defined enumerations

* ✅ update the tests accordingly.

* ➕ Add marshmallow and marshmallow-enum to dependencies

* ♻️ Rebuild serialisation with marshmallow instead of jsons

* ✅ Fix tests to match new serialisation setup with marshmallow

* 🐛 Fix case conversion during de-/serialisiation

Javascript uses CamelCase and python uses snake_case.
Therefore you have to convert the keys during the de- and serialisation

* ➖ remove jsons dependency 

I will miss you 😥

* 🩹 Remove jsons import in test_adresse

* ♻️ Replace jsons with marshmallow in externereferenz

* ♻️ Replace jsons with marshmallow in geokoordinaten

* ✅ Add test for deserialisation of geschaeftspartner

* ♻️ Replace jsons with marshmallow in katasteradresse

* Replace jsons with marshmallow

For marshmallow we have to create a Schema for each class we would like to de-/serialise.

* Fix casing

* 🔥 Remove old code

* ✅ Update tests to marshmallow de-/serialisation

* ♻️ Improve deserialisation of all Geschaeftsobjekte

Thanks to Jack Smith we got a nice and central way to deserialise Geschaeftsobjekte. The new ansatz reduces also the amount of source code 
https://stackoverflow.com/questions/65668561/marshmallow-schema-and-class-inheritance/65668854#65668854

* ✅ Update assertions for geschaeftsobjekt test

* 🎨 Rename deserialisation functions

* ♻️ Replace jsons with marshmallow in setup.cfg

* 🔥 Remove jsons import

* 🎨 Add new lines at the end of files

* ➖ ➕ Replace jsons with marshmallow and marshmallow-enum

* 📝 Automatically documentation update

* 💡 Add docstring to JavaScriptMixin class

The docstring explains the purpose of th functions to_snakecase and to_camelcase

* 💡 Add comments to clarify which attributes are required or optional

Rearranged lines to the required and optional categories to get a better overview.

* 💡 Translate and rearrange docstrings

* 🎨 Remove JavaScriptMixin from GeschaeftsobjektSchema children

The GeschaeftsobjektSchema has already the JavaScriptMixin. This property will inherited, so there is no need to inherit JavaScriptMixin in each BO

* 🎨 Remove bo_typ from BO Schemas

bo_typ is already defined in GeschaeftsobjektSchema.
Cause all BOs-Schema inherit from GeschaeftsobjektSchema the attribute bo_typ is already defined.

* 💡 Add explanation for the class_name variable

* 🎨 Move bo_typ to the required attributes

remove additional section called `required attributes with default value`
You can quickly see if an attribute use a default value

* 💡 Translate and reformat docstring

* ✅ Add assertion for BoTyp.MARKTLOKATION

* 🐛 Make marktlokation to required attribute

* 🐛 Make unterbrechbar an optional attribute

* 🐛 Use nested GeschaeftspartnerSchema for endkunde

Before it was a string field, which leads to errors after deserialisation.
You would get a string object in endkunde, but we would like to have a Geschaeftspartner object.

* ✅ Update tests for de-/serialisation of marktlokation

Test serialisation with required attributes only as well as required attributes plus optional attributes.

Additionally I added a test for a broken json_string which misses the required attribute marktlokations_id.

* 🔥 Remove not used packages from the documentation

* ✅ Switch result and expection

Co-authored-by: hf-kklein <konstantin.klein@hochfrequenz.de>

* Add component messlokationszuordnung

* ✅ Add tests for messlokationszuordnung

* Add enumeration ArithmetischeOperation

This is needed by the component messlokationszuordnung

* 🐛 Make postleitzahl and ort required in address

postleitzahl and ort were optional, but they are necessary for each kind of address.

* 🐛 Change zugehoerige_messlokation from string to Messlokation

zugehoerige_messlokation should be a Messlokationszuordnung object.
So this commit changes the typehint in the class Messlokationszuordnung and the related marshmallow schema

* 🖤 black formatting

* 📝 Update documentation

Add component messlokationszuordnung and enumeration arithmetische operation

* 🎨 Remove one whitespace

Flake8 does not like double spaces after assert

* Improve translated docstring of Geschaeftspartner

Co-authored-by: hf-kklein <konstantin.klein@hochfrequenz.de>

* Improve translated docstring for Marktlokation

Co-authored-by: hf-kklein <konstantin.klein@hochfrequenz.de>

* 💡 Improve understanding of docstring in cases.py

Co-authored-by: hf-kklein <konstantin.klein@hochfrequenz.de>

* ✏️ Fix typo

Co-authored-by: hf-kklein <konstantin.klein@hochfrequenz.de>

* ✅ Specify the assumption in test

The `is` operator is stricter than the `==` operator. Besides the value, the type is also compared

Co-authored-by: hf-kklein <konstantin.klein@hochfrequenz.de>

* ✏️ Fix typo in comment

Co-authored-by: hf-aschloegl <73470827+hf-aschloegl@users.noreply.github.com>

* ✏️ Fix typo in comment

Co-authored-by: hf-aschloegl <73470827+hf-aschloegl@users.noreply.github.com>

* ✏️ Fix typo in comment

Co-authored-by: hf-aschloegl <73470827+hf-aschloegl@users.noreply.github.com>

* 💡 Switch to American English

Cause this is an open source project and the American English is the international English version we should use it

* 👥 Add Annika to contributors

* 🔧 Add marshmallow-enum and stringcase to setup.py

New dependencies for our bo4e package.
Came through the shift from jsons to marshmallow

* 💡 Add comment to test_marktlokation for clarification

* 💡 Remove unnecessary comment

* 💡 Improve the understanding of a comment

Co-authored-by: hf-aschloegl <73470827+hf-aschloegl@users.noreply.github.com>

* 💡 Translate comments in marktrolle.py

Co-authored-by: hf-kklein <konstantin.klein@hochfrequenz.de>

* 🎨 Change order of odd and even checksum

To be more consistent with the BDEW Anwendungshilfe
https://bdew-codes.de/Content/Files/MaLo/2017-04-28-BDEW-Anwendungshilfe-MaLo-ID_Version1.0_FINAL.PDF

* ✅ Use dictionaries for assertions instead of strings

* 💩 Update tox.ini to get a positive linter check

I will remove the E501 (ignore line length) in the next PR.
I will update the format settings for black and flake9 in the next PR

* 💡 Translate docstring for gebietstyp.py

* ✏️ Fix typo in the word function

* ✏️Fix typos

* 💡 Translate comments

Co-authored-by: hf-aschloegl <73470827+hf-aschloegl@users.noreply.github.com>

* 💡 Add Multiplikation and Division as arithmetic operations in docstring

* ✏️ Fix typo in gebiettyp

Remove s in gebietstyp to match the same naming like the BO4E documenation

* 🐛 Set empty list to default for externe_referenzen

Empty list makes the implementation into a database easier compared to None type.

* 🩹 Add BoTyp.GESCHAEFTSOBJEKT and set it to default

The BoTyp can be used as a descriminator in databases.
But the Geschaeftsobjekt itself has no BoTyp in the documentation.
To realize a good table inheritance you have to define a table for each class and **each** class have to identified by a discriminator. Therefore we added the BoTyp.GESCHAEFTSOBJEKT to the BoTyp enumeration.

* 🐛 Change type from geschaeftspartnerrolle and kontaktweg to List

* ✅ Update tests to List type

kontaktweg and geschaeftspartnerrolle changed to List type

* 🩹 Fix import of Gebiettyp enumeration

Removed the s between tt

* 🎨 Use the same structure for marktrolle like in the other enumerations

* 🩹 Change type of versionstruktur

* 🐛 Change type of versionsstruktur in GeschaeftsobjektSchema to string

* ✅ Update tests to string type of versionstruktur

* 📝 Update gebiettyp enumeration in documentation

* ✅ Update tests to string type of versionstruktur

* 📝🐛 Replace `-` with `_` 

Got error in sphinx documentation: 

invalid signature for autoattribute ('bo4e.enum.marktrolle::Marktrolle.KUNDE-SELBST-NN')

Co-authored-by: hf-kklein <konstantin.klein@hochfrequenz.de>
Co-authored-by: Annika Schlögl <annika.schloegl@hochfrequenz.de>
Co-authored-by: hf-aschloegl <73470827+hf-aschloegl@users.noreply.github.com>

Author: 3 people

docs/api/bo4e.enum.rst

@@ -52,10 +52,10 @@ bo4e.enum.gasqualitaet module
    :undoc-members:
    :show-inheritance:
 
-bo4e.enum.gebietstyp module
----------------------------
+bo4e.enum.gebiettyp module
+--------------------------
 
-.. automodule:: bo4e.enum.gebietstyp
+.. automodule:: bo4e.enum.gebiettyp
    :members:
    :undoc-members:
    :show-inheritance:

src/bo4e/bo/geschaeftsobjekt.py

@@ -16,12 +16,12 @@ class Geschaeftsobjekt:
     """
 
     # required attributes
-    versionstruktur: int = attr.ib(default=2)
-    bo_typ: BoTyp
+    versionstruktur: str = attr.ib(default="2")
+    bo_typ: BoTyp = attr.ib(default=BoTyp.GESCHAEFTSOBJEKT)
 
     # optional attributes
     externe_referenzen: Optional[List[ExterneReferenz]] = attr.ib(
-        default=None, validator=attr.validators.instance_of((type(None), List))
+        default=[], validator=attr.validators.instance_of(List)
     )
 
 
@@ -35,7 +35,7 @@ class GeschaeftsobjektSchema(Schema, JavaScriptMixin):
     class_name = Geschaeftsobjekt
 
     # required attributes
-    versionstruktur = fields.Integer()
+    versionstruktur = fields.String()
     bo_typ = EnumField(BoTyp)
 
     # optional attributes

src/bo4e/bo/geschaeftspartner.py

@@ -2,6 +2,7 @@
 
 from marshmallow import fields
 from marshmallow_enum import EnumField
+from typing import List
 
 from bo4e.bo.geschaeftsobjekt import Geschaeftsobjekt, GeschaeftsobjektSchema
 from bo4e.com.adresse import Adresse, AdresseSchema
@@ -21,7 +22,7 @@ class Geschaeftspartner(Geschaeftsobjekt):
     bo_typ: BoTyp = attr.ib(default=BoTyp.GESCHAEFTSPARTNER)
     name1: str
     gewerbekennzeichnung: bool
-    geschaeftspartnerrolle: Geschaeftspartnerrolle
+    geschaeftspartnerrolle: List[Geschaeftspartnerrolle]
     partneradresse: Adresse
 
     # optional attributes
@@ -30,7 +31,7 @@ class Geschaeftspartner(Geschaeftsobjekt):
     name3: str = attr.ib(default=None)
     hrnummer: str = attr.ib(default=None)
     amtsgericht: str = attr.ib(default=None)
-    kontaktweg: Kontaktart = attr.ib(default=None)
+    kontaktweg: List[Kontaktart] = attr.ib(default=[])
     umsatzsteuer_id: str = attr.ib(default=None)
     glaeubiger_id: str = attr.ib(default=None)
     e_mail_adresse: str = attr.ib(default=None)
@@ -45,7 +46,7 @@ class GeschaeftspartnerSchema(GeschaeftsobjektSchema):
     # required attributes
     name1 = fields.Str()
     gewerbekennzeichnung = fields.Bool()
-    geschaeftspartnerrolle = EnumField(Geschaeftspartnerrolle)
+    geschaeftspartnerrolle = fields.List(EnumField(Geschaeftspartnerrolle))
     partneradresse = fields.Nested(AdresseSchema)
 
     # optional attributes
@@ -54,7 +55,7 @@ class GeschaeftspartnerSchema(GeschaeftsobjektSchema):
     name3 = fields.Str(missing=None)
     hrnummer = fields.Str(missing=None)
     amtsgericht = fields.Str(missing=None)
-    kontaktweg = EnumField(Kontaktart, missing=None)
+    kontaktweg = fields.List(EnumField(Kontaktart), missing=None)
     umsatzsteuer_id = fields.Str(missing=None)
     glaeubiger_id = fields.Str(missing=None)
     e_mail_adresse = fields.Str(missing=None)

src/bo4e/bo/marktlokation.py

@@ -19,7 +19,7 @@
 from bo4e.enum.bilanzierungsmethode import Bilanzierungsmethode
 from bo4e.enum.verbrauchsart import Verbrauchsart
 from bo4e.enum.netzebene import Netzebene
-from bo4e.enum.gebietstyp import Gebietstyp
+from bo4e.enum.gebiettyp import Gebiettyp
 from bo4e.enum.gasqualitaet import Gasqualitaet
 
 _malo_id_pattern = re.compile(r"^[1-9][\d]{10}$")
@@ -57,7 +57,7 @@ def _validate_marktlokations_id(self, marktlokations_id_attribute, value):
     verbrauchsart: Verbrauchsart = attr.ib(default=None)
     unterbrechbar: bool = attr.ib(default=None)
     netzbetreibercodenr: str = attr.ib(default=None)
-    gebietstyp: Gebietstyp = attr.ib(default=None)
+    gebietstyp: Gebiettyp = attr.ib(default=None)
     netzgebietsnr: str = attr.ib(default=None)
     bilanzierungsgebiet: str = attr.ib(default=None)
     grundversorgercodenr: str = attr.ib(default=None)
@@ -127,7 +127,7 @@ class MarktlokationSchema(GeschaeftsobjektSchema):
     verbrauchsart = EnumField(Verbrauchsart, missing=None)
     unterbrechbar = fields.Bool(missing=None)
     netzbetreibercodenr = fields.Str(missing=None)
-    gebietstyp = EnumField(Gebietstyp, missing=None)
+    gebietstyp = EnumField(Gebiettyp, missing=None)
     netzgebietsnr = fields.Str(missing=None)
     bilanzierungsgebiet = fields.Str(missing=None)
     grundversorgercodenr = fields.Str(missing=None)

src/bo4e/enum/botyp.py

@@ -5,28 +5,32 @@
 from enum import Enum
 
 _boTyp = {
-    "MARKTLOKATION": "MARKTLOKATION",
-    "MESSLOKATION": "MESSLOKATION",
-    "GESCHAEFTSPARTNER": "GESCHAEFTSPARTNER",
-    "ZAEHLER": "ZAEHLER",
-    "ANSPRECHPARTNER": "ANSPRECHPARTNER",
     "ANGEBOT": "ANGEBOT",
-    "MARKTTEILNEHMER": "MARKTTEILNEHMER",
+    "ANSPRECHPARTNER": "ANSPRECHPARTNER",
+    "AUSSCHREIBUNG": "AUSSCHREIUNG",
     "ENERGIEMENGE": "ENERGIEMENGE",
+    # It is practical to use the BoTyp Enum as discriminator in the database.
+    # Therefore we added one additional entry for GESCHAEFTSOBJEKT
+    # This is not defined by the documentation!
+    "GESCHAEFTSOBJEKT": "GESCHAEFTSOBJEKT",
+    "GESCHAEFTSPARTNER": "GESCHAEFTSPARTNER",
     "KOSTEN": "KOSTEN",
-    "AUSSCHREIBUNG": "AUSSCHREIUNG",
+    "MARKTLOKATION": "MARKTLOKATION",
+    "MESSLOKATION": "MESSLOKATION",
+    "MARKTTEILNEHMER": "MARKTTEILNEHMER",
+    "NETZNUTZUNGSRECHNUNG": "NETZNUTZUNGSRECHNUNG",
     "PREISBLATT": "PREISBLATT",
-    "PREISBLATTNETZNUTZUNG": "PREISBLATTNETZNUTZUNG",
-    "PREISBLATTMESSUNG": "PREISBLATTMESSUNG",
     "PREISBLATTDIENSTLEISTUNG": "PREISBLATTDIENSTLEISTUNG",
-    "PREISBLATTUMLAGEN": "PREISBLATTUMLAGEN",
     "PREISBLATTKONZESSIONSABGABE": "PREISBLATTKONZESSIONSABGABE",
+    "PREISBLATTMESSUNG": "PREISBLATTMESSUNG",
+    "PREISBLATTNETZNUTZUNG": "PREISBLATTNETZNUTZUNG",
+    "PREISBLATTUMLAGEN": "PREISBLATTUMLAGEN",
+    "RECHNUNG": "RECHNUNG",
+    "REGIONALTARIF": "REGIONALTARIF",
     "TARIFINFO": "TARIFINFO",
     "TARIFKOSTEN": "TARIFKOSTEN",
-    "RECHNUNG": "RECHNUNG",
-    "NETZNUTZUNGSRECHNUNG": "NETZNUTZUNGSRECHNUNG",
     "TARIFPREISBLATT": "TARIFPREISBLATT",
-    "REGIONALTARIF": "REGIONALTARIF",
-    "ZEITREIHE": "ZEITREIHE"
+    "ZAEHLER": "ZAEHLER",
+    "ZEITREIHE": "ZEITREIHE",
 }
 BoTyp = Enum("BoTyp", _boTyp)

src/bo4e/enum/gebietstyp.py src/bo4e/enum/gebiettyp.pysrc/bo4e/enum/gebietstyp.py renamed to src/bo4e/enum/gebiettyp.py

@@ -1,9 +1,9 @@
 """
-List of possible Gebietstypen.
+List of possible Gebiettypen.
 """
 from enum import Enum
 
-_gebietstyp = {
+_gebiettyp = {
     "REGELZONE": "REGELZONE",
     "MARKTGEBIET": "MARKTGEBIET",
     "BILANZIERUNGSGEBIET": "BILANZIERUNGSGEBIET",
@@ -14,4 +14,4 @@
     "GRUNDVERSORGUNGSGEBIET": "GRUNDVERSORGUNGSGEBIET",
     "VERSORGUNGSGEBIET": "VERSORGUNGSGEBIET",
 }
-Gebietstyp = Enum("Gebietstyp", _gebietstyp)
+Gebiettyp = Enum("Gebiettyp", _gebiettyp)

src/bo4e/enum/marktrolle.py

@@ -4,14 +4,14 @@
 from enum import Enum
 
 _marktrolle = {
-    "VNB": "NB",  # Grid Operator
+    "NB": "NB",  # Grid Operator
     "LF": "LF",  # Supplier
     "MSB": "MSB",  # Messstellenbetreiber
-    "DIENSTLEISTER": "DL",  # Dienstleister
+    "DL": "DL",  # Dienstleister
     "BKV": "BKV",  # Bilanzkreisverantwortlicher,
-    "BIKO": "BKV",  # Bilanzkoordinator / Marktgebietsverantwortlicher
+    "BKO": "BKO",  # Bilanzkoordinator / Marktgebietsverantwortlicher
     "UENB": "UENB",  # Übertragungsnetzbetreiber
-    "KUNDE_NN_SELBST": "KUNDE-NN-SELBST",  # Kunden, die Netznutzungsentgelte selbst zahlen
+    "KUNDE_SELBST_NN": "KUNDE_SELBST_NN",  # Kunden, die Netznutzungsentgelte selbst zahlen
     "MGV": "MGV",  # Marktgebietsverantwortlicher
     "EIV": "EIV",  # Einsatzverantwortlicher
     "RB": "RB",  # Registerbetreiber

tests/test_externe_referenz.py

@@ -28,7 +28,7 @@ def test_list_of_externe_referenz(self):
             name1="Duck",
             name2="Donald",
             gewerbekennzeichnung=False,
-            geschaeftspartnerrolle=Geschaeftspartnerrolle.KUNDE,
+            geschaeftspartnerrolle=[Geschaeftspartnerrolle.KUNDE],
             partneradresse=Adresse(
                 strasse="Am Geldspeicher",
                 hausnummer="17",
@@ -51,7 +51,7 @@ def test_geschaeftspartner_with_no_externe_referenz(self):
             name1="Duck",
             name2="Donald",
             gewerbekennzeichnung=False,
-            geschaeftspartnerrolle=Geschaeftspartnerrolle.KUNDE,
+            geschaeftspartnerrolle=[Geschaeftspartnerrolle.KUNDE],
             partneradresse=Adresse(
                 strasse="Am Geldspeicher",
                 hausnummer="17",
@@ -65,4 +65,5 @@ def test_geschaeftspartner_with_no_externe_referenz(self):
         gp_json = schema.dumps(gp, ensure_ascii=False)
 
         deserialized_gp: Geschaeftspartner = schema.loads(gp_json)
-        assert deserialized_gp.externe_referenzen is None
+
+        assert deserialized_gp.externe_referenzen == []

tests/test_geschaeftsobjekt.py

@@ -11,7 +11,7 @@ class TestGeschaeftsobjet:
         [
             (
                 BoTyp.ENERGIEMENGE,
-                2,
+                "2",
                 [
                     ExterneReferenz(
                         ex_ref_name="HOCHFREQUENZ_HFSAP_100", ex_ref_wert="12345"
@@ -23,14 +23,14 @@ class TestGeschaeftsobjet:
             ),
             (
                 BoTyp.ENERGIEMENGE,
-                2,
+                "2",
                 [
                     ExterneReferenz(
                         ex_ref_name="HOCHFREQUENZ_HFSAP_100", ex_ref_wert="12345"
                     )
                 ],
             ),
-            (BoTyp.ENERGIEMENGE, 2, None),
+            (BoTyp.ENERGIEMENGE, "2", []),
         ],
     )
     def test_serialisation(
@@ -58,8 +58,8 @@ def test_serialisation(
     def test_initialization_with_minimal_attributs(self):
         go = Geschaeftsobjekt(bo_typ=BoTyp.ANSPRECHPARTNER)
 
-        assert go.externe_referenzen is None
-        assert go.versionstruktur == 2
+        assert go.externe_referenzen == []
+        assert go.versionstruktur == "2"
 
     def test_no_list_in_externen_referenzen(self):
         with pytest.raises(TypeError) as excinfo:
@@ -69,4 +69,4 @@ def test_no_list_in_externen_referenzen(self):
                     ex_ref_name="Schufa-ID", ex_ref_wert="aksdlakoeuhn"
                 ),
             )
-        assert "must be (<class 'NoneType'>, typing.List)" in str(excinfo.value)
+        assert "must be typing.List" in str(excinfo.value)

tests/test_geschaeftspartner.py

@@ -28,12 +28,12 @@ def test_serializable(self, datafiles):
             gewerbekennzeichnung=True,
             hrnummer="HRB 254466",
             amtsgericht="Amtsgericht München",
-            kontaktweg=Kontaktart.E_MAIL,
+            kontaktweg=[Kontaktart.E_MAIL],
             umsatzsteuer_id="DE267311963",
             glaeubiger_id="DE98ZZZ09999999999",
             e_mail_adresse="test@bo4e.de",
             website="bo4e.de",
-            geschaeftspartnerrolle=Geschaeftspartnerrolle.DIENSTLEISTER,
+            geschaeftspartnerrolle=[Geschaeftspartnerrolle.DIENSTLEISTER],
             partneradresse=Adresse(
                 postleitzahl=address_test_data["postleitzahl"],
                 ort=address_test_data["ort"],