🚨 Add and check static type hints using mypy

.github/workflows/linting.yml

@@ -8,6 +8,7 @@ jobs:
       matrix:
         python-version: [ 3.8 ]
         os: [ ubuntu-latest ]
+        linter-env: ["linting", "type_check"]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
@@ -18,6 +19,6 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install tox
-      - name: Linting bo4e
+      - name: Run ${{ matrix.linter-env }}
         run: |
-          tox -e linting
+          tox -e ${{ matrix.linter-env }}

pyproject.toml

@@ -15,4 +15,4 @@ markers = ["datafiles: load datafiles"]
 max-line-length = 120
 
 [tool.isort]
-line_length = 120
+line_length = 120

src/bo4e/bo/ansprechpartner.py

@@ -4,16 +4,18 @@
 """
 import attr
 from marshmallow import fields
-from marshmallow_enum import EnumField
-from bo4e.com.rufnummer import Rufnummer, RufnummerSchema
-from bo4e.com.adresse import Adresse, AdresseSchema
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.bo.geschaeftsobjekt import Geschaeftsobjekt, GeschaeftsobjektSchema
 from bo4e.bo.geschaeftspartner import Geschaeftspartner, GeschaeftspartnerSchema
+from bo4e.com.adresse import Adresse, AdresseSchema
+from bo4e.com.rufnummer import Rufnummer, RufnummerSchema
 from bo4e.com.zustaendigkeit import Zustaendigkeit, ZustaendigkeitSchema
 from bo4e.enum.anrede import Anrede
 from bo4e.enum.botyp import BoTyp
 from bo4e.enum.titel import Titel
 
+
 # pylint: disable=too-many-instance-attributes, too-few-public-methods
 @attr.s(auto_attribs=True, kw_only=True)
 class Ansprechpartner(Geschaeftsobjekt):

src/bo4e/bo/geschaeftsobjekt.py

@@ -3,16 +3,26 @@
 and corresponding marshmallow schema for de-/serialization
 """
 # pylint: disable=unused-argument, too-few-public-methods
-from typing import List, Optional
+from typing import List, Optional, Type
 
 import attr
 from marshmallow import fields, post_load
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.com.externereferenz import ExterneReferenz, ExterneReferenzSchema
 from bo4e.enum.botyp import BoTyp
 from bo4e.schemata.caseconverterschema import CaseConverterSchema
 
 
+def _create_empty_referenzen_list() -> List[ExterneReferenz]:
+    """
+    A method with a type hint to please mypy
+    https://stackoverflow.com/a/61281305/10009545
+    :return:
+    """
+    return []
+
+
 @attr.s(auto_attribs=True, kw_only=True)
 class Geschaeftsobjekt:
     """
@@ -25,7 +35,7 @@ class Geschaeftsobjekt:
 
     # optional attributes
     externe_referenzen: Optional[List[ExterneReferenz]] = attr.ib(
-        default=[], validator=attr.validators.instance_of(List)
+        default=_create_empty_referenzen_list(), validator=attr.validators.instance_of(List)  # type:ignore
     )
 
 
@@ -36,7 +46,7 @@ class GeschaeftsobjektSchema(CaseConverterSchema):
     """
 
     # class_name is needed to use the correct schema for deserialization.
-    class_name = Geschaeftsobjekt
+    class_name: Type[Geschaeftsobjekt] = Geschaeftsobjekt
 
     # required attributes
     versionstruktur = fields.String()

src/bo4e/bo/geschaeftspartner.py

@@ -3,11 +3,12 @@
 and corresponding marshmallow schema for de-/serialization
 """
 # pylint: disable=too-many-instance-attributes, too-few-public-methods
-from typing import List
+from typing import List, Optional, Type
 
 import attr
 from marshmallow import fields
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.bo.geschaeftsobjekt import Geschaeftsobjekt, GeschaeftsobjektSchema
 from bo4e.com.adresse import Adresse, AdresseSchema
 from bo4e.enum.anrede import Anrede
@@ -30,15 +31,15 @@ class Geschaeftspartner(Geschaeftsobjekt):
 
     # optional attributes
     anrede: Anrede = attr.ib(default=None)
-    name2: str = attr.ib(default=None)
-    name3: str = attr.ib(default=None)
-    hrnummer: str = attr.ib(default=None)
-    amtsgericht: str = attr.ib(default=None)
+    name2: Optional[str] = attr.ib(default=None)
+    name3: Optional[str] = attr.ib(default=None)
+    hrnummer: Optional[str] = attr.ib(default=None)
+    amtsgericht: Optional[str] = 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)
-    website: str = attr.ib(default=None)
+    umsatzsteuer_id: Optional[str] = attr.ib(default=None)
+    glaeubiger_id: Optional[str] = attr.ib(default=None)
+    e_mail_adresse: Optional[str] = attr.ib(default=None)
+    website: Optional[str] = attr.ib(default=None)
     partneradresse: Adresse = attr.ib(default=None)
 
 
@@ -49,7 +50,7 @@ class GeschaeftspartnerSchema(GeschaeftsobjektSchema):
 
     # class_name is needed to use the correct schema for deserialisation.
     # see function `deserialize` in geschaeftsobjekt.py
-    class_name = Geschaeftspartner
+    class_name: Type[Geschaeftspartner] = Geschaeftspartner
 
     # required attributes
     name1 = fields.Str()

src/bo4e/bo/marktlokation.py

@@ -6,7 +6,8 @@
 
 import attr
 from marshmallow import fields
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.bo.geschaeftsobjekt import Geschaeftsobjekt, GeschaeftsobjektSchema
 from bo4e.bo.geschaeftspartner import Geschaeftspartner, GeschaeftspartnerSchema
 from bo4e.com.adresse import Adresse, AdresseSchema
@@ -22,7 +23,6 @@
 from bo4e.enum.sparte import Sparte
 from bo4e.enum.verbrauchsart import Verbrauchsart
 
-
 _malo_id_pattern = re.compile(r"^[1-9][\d]{10}$")
 
 

src/bo4e/bo/marktteilnehmer.py

@@ -3,9 +3,10 @@
 and corresponding marshmallow schema for de-/serialization
 """
 import attr
-from marshmallow import fields
-from marshmallow_enum import EnumField
 from attr.validators import matches_re
+from marshmallow import fields
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.bo.geschaeftspartner import Geschaeftspartner, GeschaeftspartnerSchema
 from bo4e.enum.botyp import BoTyp
 from bo4e.enum.marktrolle import Marktrolle

src/bo4e/bo/messlokation.py

@@ -6,9 +6,9 @@
 from typing import List, Optional
 
 import attr
-from iso3166 import countries
+from iso3166 import countries  # type:ignore
 from marshmallow import fields
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
 
 from bo4e.bo.geschaeftsobjekt import Geschaeftsobjekt, GeschaeftsobjektSchema
 from bo4e.bo.zaehler import Zaehler, ZaehlerSchema

src/bo4e/bo/vertrag.py

@@ -4,19 +4,21 @@
 """
 from datetime import datetime
 from typing import List, Optional
+
 import attr
 from marshmallow import fields
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
 
 from bo4e.bo.geschaeftsobjekt import Geschaeftsobjekt, GeschaeftsobjektSchema
 from bo4e.bo.geschaeftspartner import Geschaeftspartner, GeschaeftspartnerSchema
-from bo4e.com.vertragsteil import Vertragsteil, VertragsteilSchema
-from bo4e.com.vertragskonditionen import Vertragskonditionen, VertragskonditionenSchema
 from bo4e.com.unterschrift import Unterschrift, UnterschriftSchema
+from bo4e.com.vertragskonditionen import Vertragskonditionen, VertragskonditionenSchema
+from bo4e.com.vertragsteil import Vertragsteil, VertragsteilSchema
 from bo4e.enum.botyp import BoTyp
+from bo4e.enum.sparte import Sparte
 from bo4e.enum.vertragsart import Vertragsart
 from bo4e.enum.vertragsstatus import Vertragsstatus
-from bo4e.enum.sparte import Sparte
+
 
 # pylint: disable=unused-argument
 def at_least_one_vertragsteil(instance, attribute, value):

src/bo4e/bo/zaehler.py

@@ -8,7 +8,7 @@
 
 import attr
 from marshmallow import fields
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
 
 from bo4e.bo.geschaeftsobjekt import Geschaeftsobjekt, GeschaeftsobjektSchema
 from bo4e.bo.geschaeftspartner import Geschaeftspartner, GeschaeftspartnerSchema
@@ -19,6 +19,7 @@
 from bo4e.enum.zaehlerauspraegung import Zaehlerauspraegung
 from bo4e.enum.zaehlertyp import Zaehlertyp
 
+
 # pylint: disable=unused-argument
 def at_least_one_zaehlwerk(instance, attribute, value):
     """

src/bo4e/com/adresse.py

@@ -5,7 +5,8 @@
 
 import attr
 from marshmallow import fields, post_load
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.com.com import COM, COMSchema
 from bo4e.enum.landescode import Landescode
 
@@ -42,7 +43,7 @@ class Adresse(COM):
     postfach: str = attr.ib(default=None, validator=strasse_xor_postfach)
     adresszusatz: str = attr.ib(default=None)
     co_ergaenzung: str = attr.ib(default=None)
-    landescode: Landescode = attr.ib(default=Landescode.DE)
+    landescode: Landescode = attr.ib(default=Landescode.DE)  # type:ignore
 
 
 class AdresseSchema(COMSchema):

src/bo4e/com/com.py

@@ -2,8 +2,10 @@
 Contains base class for all components
 """
 import attr
+
 from bo4e.schemata.caseconverterschema import CaseConverterSchema
 
+
 # pylint: disable=too-few-public-methods
 @attr.s(auto_attribs=True, kw_only=True)
 class COM:

src/bo4e/com/dienstleistung.py

@@ -5,10 +5,12 @@
 
 import attr
 from marshmallow import fields, post_load
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.com.com import COM, COMSchema
 from bo4e.enum.dienstleistungstyp import Dienstleistungstyp
 
+
 # pylint: disable=too-few-public-methods
 @attr.s(auto_attribs=True, kw_only=True)
 class Dienstleistung(COM):

src/bo4e/com/externereferenz.py

@@ -4,6 +4,7 @@
 """
 import attr
 from marshmallow import fields, post_load
+
 from bo4e.com.com import COM, COMSchema
 
 

src/bo4e/com/hardware.py

@@ -5,10 +5,12 @@
 
 import attr
 from marshmallow import fields, post_load
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.com.com import COM, COMSchema
 from bo4e.enum.geraetetyp import Geraetetyp
 
+
 # pylint: disable=too-few-public-methods
 @attr.s(auto_attribs=True, kw_only=True)
 class Hardware(COM):

src/bo4e/com/katasteradresse.py

@@ -4,6 +4,7 @@
 """
 import attr
 from marshmallow import fields, post_load
+
 from bo4e.com.com import COM, COMSchema
 
 

src/bo4e/com/menge.py

@@ -7,11 +7,12 @@
 
 import attr
 from marshmallow import fields, post_load
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
 
 from bo4e.com.com import COM, COMSchema
 from bo4e.enum.mengeneinheit import Mengeneinheit
 
+
 # pylint: disable=too-few-public-methods
 @attr.s(auto_attribs=True, kw_only=True)
 class Menge(COM):

src/bo4e/com/messlokationszuordnung.py

@@ -6,7 +6,8 @@
 
 import attr
 from marshmallow import fields, post_load
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.com.com import COM, COMSchema
 from bo4e.enum.arithmetische_operation import ArithmetischeOperation
 

src/bo4e/com/rufnummer.py

@@ -5,10 +5,12 @@
 
 import attr
 from marshmallow import fields, post_load
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
+
 from bo4e.com.com import COM, COMSchema
 from bo4e.enum.rufnummernart import Rufnummernart
 
+
 # pylint: disable=too-few-public-methods
 @attr.s(auto_attribs=True, kw_only=True)
 class Rufnummer(COM):

src/bo4e/com/unterschrift.py

@@ -3,10 +3,13 @@
 and corresponding marshmallow schema for de-/serialization
 """
 from datetime import datetime
+
 import attr
 from marshmallow import fields, post_load
+
 from bo4e.com.com import COM, COMSchema
 
+
 # pylint: disable=too-few-public-methods
 @attr.s(auto_attribs=True, kw_only=True)
 class Unterschrift(COM):

src/bo4e/com/vertragskonditionen.py

@@ -3,11 +3,14 @@
 and corresponding marshmallow schema for de-/serialization
 """
 from decimal import Decimal
+
 import attr
 from marshmallow import fields, post_load
+
 from bo4e.com.com import COM, COMSchema
 from bo4e.com.zeitraum import Zeitraum, ZeitraumSchema
 
+
 # pylint: disable=too-few-public-methods
 @attr.s(auto_attribs=True, kw_only=True)
 class Vertragskonditionen(COM):

src/bo4e/com/vertragsteil.py

@@ -2,13 +2,16 @@
 Contains Vertragsteil class
 and corresponding marshmallow schema for de-/serialization
 """
-from typing import Optional
 from datetime import datetime
+from typing import Optional
+
 import attr
 from marshmallow import fields, post_load
+
 from bo4e.com.com import COM, COMSchema
 from bo4e.com.menge import Menge, MengeSchema
 
+
 # pylint: disable=too-few-public-methods
 @attr.s(auto_attribs=True, kw_only=True)
 class Vertragsteil(COM):

src/bo4e/com/zaehlwerk.py

@@ -7,7 +7,7 @@
 import attr
 from attr.validators import matches_re
 from marshmallow import fields, post_load
-from marshmallow_enum import EnumField
+from marshmallow_enum import EnumField  # type:ignore
 
 from bo4e.com.com import COM, COMSchema
 from bo4e.enum.energierichtung import Energierichtung