Merge pull request #20 from Hochfrequenz/develop

Fix Landescode and typo in Markteilnehmer class

Author: hf-krechan

docs/api/bo4e.com.rst

@@ -20,6 +20,14 @@ bo4e.com.com module
    :undoc-members:
    :show-inheritance:
 
+bo4e.com.externereferenz module
+-------------------------------
+
+.. automodule:: bo4e.com.externereferenz
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 bo4e.com.geokoordinaten module
 ------------------------------
 

requirements/base.txt

@@ -5,5 +5,6 @@
 #    pip-compile requirements/base.in
 #
 attrs==20.3.0             # via -r requirements/base.in
+iso3166==1.0.1            # via -r requirements/base.in
 jsons==1.3.0              # via -r requirements/base.in
 typish==1.9.1             # via jsons

requirements/dev.txt

@@ -21,6 +21,7 @@ flake8==3.8.4             # via -r requirements/dev.in, -r requirements\tests.in
 idna==2.10                # via requests
 imagesize==1.2.0          # via sphinx
 iniconfig==1.1.1          # via pytest
+iso3166==1.0.1            # via -r requirements\base.in
 jinja2==2.11.2            # via sphinx
 jsons==1.3.0              # via -r requirements\base.in
 markupsafe==1.1.1         # via jinja2

requirements/docs.txt

@@ -13,6 +13,7 @@ colorama==0.4.4           # via sphinx
 docutils==0.16            # via sphinx
 idna==2.10                # via requests
 imagesize==1.2.0          # via sphinx
+iso3166==1.0.1            # via -r requirements\base.in
 jinja2==2.11.2            # via sphinx
 jsons==1.3.0              # via -r requirements\base.in
 markupsafe==1.1.1         # via jinja2

requirements/tests.txt

@@ -9,6 +9,7 @@ attrs==20.2.0             # via -r requirements\base.in, pytest
 colorama==0.4.4           # via pytest
 flake8==3.8.4             # via -r requirements/tests.in
 iniconfig==1.1.1          # via pytest
+iso3166==1.0.1            # via -r requirements\base.in
 jsons==1.3.0              # via -r requirements\base.in
 mccabe==0.6.1             # via flake8
 packaging==20.4           # via pytest

setup.cfg

@@ -8,7 +8,7 @@ project-urls =
 license = mit
 author = Kevin Krechan
 author-email = kevin.krechan@hochfrequenz.de
-description = Python Library that Implements the BO4E Standard.
+description = Python Library that implements the BO4E Standard.
 long-description = file: README.rst
 long-description-content-type = text/x-rst; charset=UTF-8
 platforms = any

src/bo4e/bo/geschaeftsobjekt.py

@@ -1,13 +1,20 @@
+from typing import List, Optional
+
 import attr
+import jsons
 
+from bo4e.com.externereferenz import ExterneReferenz
 from bo4e.enum.botyp import BoTyp
 
 
 @attr.s(auto_attribs=True, kw_only=True)
-class Geschaeftsobjekt:
+class Geschaeftsobjekt(jsons.JsonSerializable):
     """
     base class for all business objects
     """
 
-    bo_typ: BoTyp
     versionstruktur: int = attr.ib(default=2)
+    bo_typ: BoTyp
+    externe_referenzen: Optional[List[ExterneReferenz]] = attr.ib(
+        default=None, validator=attr.validators.instance_of((type(None), List))
+    )

src/bo4e/bo/geschaeftspartner.py

@@ -9,7 +9,7 @@
 from bo4e.enum.botyp import BoTyp
 
 
-@attr.s(auto_attribs=True, kw_only=True, frozen=True)
+@attr.s(auto_attribs=True, kw_only=True)
 class Geschaeftspartner(Geschaeftsobjekt, jsons.JsonSerializable):
     """
     Objekt zur Aufnahme der Information zu einem Geschaeftspartner

src/bo4e/bo/marktlokation.py

@@ -20,7 +20,7 @@
 _malo_id_pattern = re.compile(r"^[1-9][\d]{10}$")
 
 
-@attr.s(auto_attribs=True, kw_only=True, frozen=True)
+@attr.s(auto_attribs=True, kw_only=True)
 class Marktlokation(Geschaeftsobjekt, jsons.JsonSerializable):
     """
     Objekt zur Aufnahme der Informationen zu einer Marktlokation
@@ -30,12 +30,15 @@ def _validate_marktlokations_id(self, marklokations_id_attribute, value):
         if not value:
             raise ValueError("The marktlokations_id must not be empty.")
         if not _malo_id_pattern.match(value):
-            raise ValueError(f"The marktlokations_id '{value}' does not match {_malo_id_pattern.pattern}")
+            raise ValueError(
+                f"The marktlokations_id '{value}' does not match {_malo_id_pattern.pattern}"
+            )
         expected_checksum = Marktlokation._get_checksum(value)
         actual_checksum = value[10:11]
         if expected_checksum != actual_checksum:
             raise ValueError(
-                f"The marktlokations_id '{value}' has checksum '{actual_checksum}' but '{expected_checksum}' was expected.")
+                f"The marktlokations_id '{value}' has checksum '{actual_checksum}' but '{expected_checksum}' was expected."
+            )
 
     marktlokations_id: str = attr.ib(validator=_validate_marktlokations_id)
     sparte: Sparte
@@ -92,7 +95,7 @@ def _get_checksum(malo_id: str) -> str:
         # start counting at 1 to be consistent with the above description
         # of "even" and "odd" but stop at tenth digit.
         for i in range(1, 11):
-            s = malo_id[i - 1:i]
+            s = malo_id[i - 1 : i]
             if i % 2 == 0:
                 even_checksum += 2 * int(s)
             else:

src/bo4e/bo/marktteilnehmer.py

@@ -8,8 +8,8 @@
 from bo4e.enum.rollencodetyp import Rollencodetyp
 
 
-@attr.s(auto_attribs=True, kw_only=True, frozen=True)
-class Marktteilehmer(Geschaeftspartner, jsons.JsonSerializable):
+@attr.s(auto_attribs=True, kw_only=True)
+class Marktteilnehmer(Geschaeftspartner, jsons.JsonSerializable):
     """
     Objekt zur Aufnahme der Information zu einem Marktteilnehmer
     """