➖ Remove bo4e from dependencies 🎉 (#180)

Author: hf-kklein

dev_requirements/requirements-tests.in

@@ -1,2 +1,5 @@
 pytest
 pytest-asyncio
+bo4e==0.6.1
+# we're using this pinned version of bo4e because there's no version which contains this fix:
+# https://github.com/bo4e/BO4E-python/commit/3fd45539edd7d5bfdca990775244bf31007a5ca7

dev_requirements/requirements-tests.txt

@@ -1,18 +1,36 @@
 #
-# This file is autogenerated by pip-compile with Python 3.12
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    pip-compile requirements-tests.in
 #
+annotated-types==0.6.0
+    # via pydantic
+bo4e==0.6.1
+    # via -r requirements-tests.in
+colorama==0.4.6
+    # via pytest
 iniconfig==2.0.0
     # via pytest
+iso3166==2.1.1
+    # via bo4e
 packaging==23.2
     # via pytest
 pluggy==1.3.0
     # via pytest
+pydantic==2.6.2
+    # via bo4e
+pydantic-core==2.16.3
+    # via pydantic
+pyhumps==3.8.0
+    # via bo4e
 pytest==8.0.1
     # via
-    #   -r dev_requirements/requirements-tests.in
+    #   -r requirements-tests.in
     #   pytest-asyncio
 pytest-asyncio==0.23.5
-    # via -r dev_requirements/requirements-tests.in
+    # via -r requirements-tests.in
+typing-extensions==4.9.0
+    # via
+    #   pydantic
+    #   pydantic-core

requirements.in

@@ -1,4 +1,3 @@
-bo4e>=0.5.0
 pydantic>=2.0.0
 typeguard
 frozendict

requirements.txt

@@ -1,25 +1,21 @@
 #
-# This file is autogenerated by pip-compile with Python 3.12
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    pip-compile requirements.in
 #
-annotated-types==0.5.0
+annotated-types==0.6.0
     # via pydantic
 bidict==0.23.1
     # via
     #   -r requirements.in
     #   pvframework
-bo4e==0.6.1
-    # via -r requirements.in
 frozendict==2.4.0
     # via
     #   -r requirements.in
     #   pvframework
 injector==0.21.0
     # via -r requirements.in
-iso3166==2.1.1
-    # via bo4e
 networkx==3.2.1
     # via
     #   -r requirements.in
@@ -29,11 +25,8 @@ pvframework==0.0.8
 pydantic==2.6.2
     # via
     #   -r requirements.in
-    #   bo4e
 pydantic-core==2.16.3
     # via pydantic
-pyhumps==3.8.0
-    # via bo4e
 python-generics==0.0.4
     # via -r requirements.in
 typeguard==4.1.5
@@ -44,3 +37,4 @@ typing-extensions==4.9.0
     # via
     #   pydantic
     #   pydantic-core
+    #   typeguard

setup.cfg

@@ -32,7 +32,6 @@ zip_safe = False
 include_package_data = True
 python_requires = >=3.10
 install_requires =
-    bo4e
     pydantic>=2.0.0
     typeguard>=4.0.1
     frozendict

src/bomf/loader/entityloader.py

@@ -10,7 +10,7 @@
 from typing import Awaitable, Callable, Generic, Optional, TypeVar
 
 from generics import get_filled_type
-from pydantic import BaseModel, TypeAdapter, ConfigDict, ValidationError  # pylint:disable=no-name-in-module
+from pydantic import BaseModel, ConfigDict, TypeAdapter, ValidationError  # pylint:disable=no-name-in-module
 
 _TargetEntity = TypeVar("_TargetEntity")
 

src/bomf/model/__init__.py

@@ -2,60 +2,11 @@
 general data models for migrations
 """
 
-import enum
 import uuid
 from abc import ABC
-from typing import TypeVar, Union
 
-from bo4e.bo.geschaeftsobjekt import Geschaeftsobjekt
-from bo4e.com.com import COM
 from pydantic import BaseModel, Field  # pylint: disable=no-name-in-module
 
-_SpecificBusinessObject = TypeVar("_SpecificBusinessObject", bound=Geschaeftsobjekt)
-"""
-an arbitrary but fixed business object type
-"""
-
-_SpecificCom = TypeVar("_SpecificCom", bound=COM)
-"""
-an arbitrary but fixed COM type
-"""
-
-Bo4eTyp = Union[_SpecificBusinessObject, _SpecificCom]  # pylint: disable=invalid-name
-
-
-# pylint:disable=too-few-public-methods
-class BusinessObjectRelation(BaseModel):
-    """
-    A business object relation describes the relation between two business object.
-    E.g. a relation could have the type "has_melo" where relation_part_a is a bo4e.bo.Vertrag
-    and relation_part_b is a bo4e.bo.Messlokation. Some relations are already defined in BO4E itself (e.g MaLo/MeLo)
-    or MeLo/Address.
-    The idea is to not enforce too much of a structure to the downstream code but still push coders to think about
-    necessary relation information.
-    """
-
-    relation_type: enum.Enum
-    """
-    The relation type describes how two business objects relate to each other.
-    This is not (only) about cardinality. It's about being able to model different relations between objects.
-    Think about e.g. a business partner and an address: The relation could be:
-    - the address is the residential address of the business partner
-    - the address is the invoice address of the business partner
-    - the address is the place where the business partner was born
-    All these relation types are 1:1 relations between business partners and adresses, yet they all carry different
-    meaning which we'd like to distinguish in our data.
-    """
-    relation_part_a: Bo4eTyp
-    """
-    one Business Object or COM
-    """
-
-    relation_part_b: Bo4eTyp
-    """
-    another Business Object or COM
-    """
-
 
 class Bo4eDataSet(BaseModel, ABC):
     """

unittests/models.py

@@ -0,0 +1,55 @@
+"""
+models used for testing
+"""
+
+import enum
+from typing import TypeVar, Union
+
+from bo4e.bo.geschaeftsobjekt import Geschaeftsobjekt
+from bo4e.com.com import COM
+from pydantic import BaseModel
+
+_SpecificBusinessObject = TypeVar("_SpecificBusinessObject", bound=Geschaeftsobjekt)
+"""
+an arbitrary but fixed business object type
+"""
+
+_SpecificCom = TypeVar("_SpecificCom", bound=COM)
+"""
+an arbitrary but fixed COM type
+"""
+
+Bo4eTyp = Union[_SpecificBusinessObject, _SpecificCom]  # pylint: disable=invalid-name
+
+
+# pylint:disable=too-few-public-methods
+class BusinessObjectRelation(BaseModel):
+    """
+    A business object relation describes the relation between two business object.
+    E.g. a relation could have the type "has_melo" where relation_part_a is a bo4e.bo.Vertrag
+    and relation_part_b is a bo4e.bo.Messlokation. Some relations are already defined in BO4E itself (e.g MaLo/MeLo)
+    or MeLo/Address.
+    The idea is to not enforce too much of a structure to the downstream code but still push coders to think about
+    necessary relation information.
+    """
+
+    relation_type: enum.Enum
+    """
+    The relation type describes how two business objects relate to each other.
+    This is not (only) about cardinality. It's about being able to model different relations between objects.
+    Think about e.g. a business partner and an address: The relation could be:
+    - the address is the residential address of the business partner
+    - the address is the invoice address of the business partner
+    - the address is the place where the business partner was born
+    All these relation types are 1:1 relations between business partners and adresses, yet they all carry different
+    meaning which we'd like to distinguish in our data.
+    """
+    relation_part_a: Bo4eTyp
+    """
+    one Business Object or COM
+    """
+
+    relation_part_b: Bo4eTyp
+    """
+    another Business Object or COM
+    """

unittests/test_bo4e_data_set.py

@@ -5,7 +5,9 @@
 from bo4e.bo.geschaeftspartner import Geschaeftspartner
 from bo4e.com.adresse import Adresse
 
-from bomf.model import Bo4eDataSet, Bo4eTyp, BusinessObjectRelation
+from bomf.model import Bo4eDataSet
+
+from .models import Bo4eTyp, BusinessObjectRelation
 
 
 class _GeschaeftspartnerAdresseRelation(enum.Enum):

unittests/test_mapper.py

@@ -1,12 +1,13 @@
 from typing import Optional, Type
 
-from pydantic import BaseModel
 import pytest  # type:ignore[import]
 from bo4e.bo.marktlokation import Marktlokation
 from bo4e.bo.messlokation import Messlokation
+from pydantic import BaseModel
 
 from bomf.mapper import Bo4eDataSetToTargetMapper, PaginationNotSupportedException, SourceToBo4eDataSetMapper
-from bomf.model import Bo4eTyp
+
+from .models import Bo4eTyp
 
 
 class _NotImplementedBo4eDataSetMixin: