Model new BO Region

Author: lord-haffi

.pre-commit-config.yaml

@@ -7,12 +7,12 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/psf/black
-    rev: 24.4.2 # Replace by any tag/version: https://github.com/psf/black/tags
+    rev: 25.1.0 # Replace by any tag/version: https://github.com/psf/black/tags
     hooks:
       - id: black
         language_version: python3 # Should be a command that runs python3.6+
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 6.0.1
     hooks:
       - id: isort
         name: isort (python)

requirements.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    pip-compile requirements.in
+#    pip-compile '.\requirements.in'
 #
 annotated-types==0.7.0
     # via pydantic

src/bo4e/bo/region.py

@@ -11,7 +11,7 @@
 from .geschaeftsobjekt import Geschaeftsobjekt
 
 if TYPE_CHECKING:
-    from ..com.regionskriterium import Regionskriterium
+    from ..com.regionsoperation import Regionsoperation
 
 
 # pylint: disable=too-few-public-methods
@@ -21,7 +21,13 @@
 @postprocess_docstring
 class Region(Geschaeftsobjekt):
     """
-    Modellierung einer Region als Menge von Kriterien, die eine Region beschreiben
+    Modellierung einer Region als Liste von Regionsoperationen.
+
+    Die Reihenfolge der Regionsoperationen ist relevant,
+    wird aber nicht zwingend durch die Sortierung innerhalb der Liste definiert. Die Sortierung der Regionsoperationen
+    wird durch das Feld `prioritaet` im COM `Regionsoperation` explizit festgelegt, um technischen Problemen bei
+    spezifischen Umsetzungen vorzubeugen und Klarheit zu schaffen.
+    Bei einer Implementierung sollte darauf geachtet werden, dass sich "prioritaeten" nicht doppeln können.
 
     .. raw:: html
 
@@ -35,9 +41,11 @@ class Region(Geschaeftsobjekt):
     typ: Annotated[Literal[BoTyp.REGION], Field(alias="_typ")] = BoTyp.REGION
     bezeichnung: Optional[str] = None
     """Bezeichnung der Region"""
+    beschreibung: Optional[str] = None
+    """Beschreibung der Region"""
 
-    positiv_liste: Optional[list["Regionskriterium"]] = None
-    """Positivliste der Kriterien zur Definition der Region"""
-
-    negativ_liste: Optional[list["Regionskriterium"]] = None
-    """Negativliste der Kriterien zur Definition der Region"""
+    regionsoperationen: Optional[list[Regionsoperation]] = None
+    """
+    Eine (unsortierte) Liste von Regionsoperationen.
+    Die Sortierung wird durch das Feld `prioritaet` im COM `Regionsoperation` festgelegt.
+    """

src/bo4e/com/regionskriterium.py

@@ -0,0 +1,59 @@
+"""
+Contains Regionskriterium class
+"""
+
+from decimal import Decimal
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
+
+from pydantic import Field
+
+from ..enum.comtyp import ComTyp
+from ..utils import postprocess_docstring
+from .com import COM
+
+if TYPE_CHECKING:
+    from ..enum.operator import Operator
+    from ..enum.regionskriterium import Regionskriterium
+
+
+# pylint: disable=too-few-public-methods
+
+
+@postprocess_docstring
+class Regionsoperation(COM):
+    """
+    Komponente zur Abbildung einer Regionsoperation.
+
+    In Kombination mit anderen Regionsoperationen kann eine Region definiert werden. Eine Regionsoperation ermöglicht
+    die Definition einer Region in eingeschränkter Form. Durch den Operator können mehrere "einfache" Regionsoperationen
+    miteinander kombiniert werden, um eine komplexere Region zu definieren.
+
+    .. raw:: html
+
+        <object data="../_static/images/bo4e/com/Regionsoperation.svg" type="image/svg+xml"></object>
+
+    .. HINT::
+        `Regionsoperation JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/com/Regionsoperation.json>`_
+
+    """
+
+    typ: Annotated[Literal[ComTyp.REGIONSKRITERIUM], Field(alias="_typ")] = ComTyp.REGIONSKRITERIUM
+
+    regionsoperator: Optional[Operator] = None
+    prioritaet: Optional[int] = None
+    """
+    Priorität dieser Regionsoperation. Theoretisch sind Listen in JSON sortiert, jedoch ist eine solche Sortierung
+    eventuell implementierungsbedingt fehleranfällig. Daher nutzen wir dieses Feld. angefangen bei 1 (höchste Priorität) und aufsteigend
+    """
+    bezeichnung: Optional[str] = None
+    """(auch IDs und PLZ möglich)"""
+    bezeichnung2: Optional[str] = None
+    """(TODO: bessere Benamung! geht vor allem um Postort: PLZ & Ort als Schnittmenge)"""
+    wert_von: Optional[str] = None
+    """(inklusiv)"""
+    wert_bis: Optional[str] = None
+    """(inklusiv)"""
+    radius_in_km: Optional[Decimal] = None
+    """(inklusiv)"""
+    regionskriterium: Optional[Regionskriterium] = None
+    """(ehemals Regionskriteriumtyp)]"""

src/bo4e/com/regionsoperation.py

@@ -2,9 +2,9 @@
 from bo4e.enum.strenum import StrEnum
 
 
-class ArithmetischeOperation(StrEnum):
+class Operator(StrEnum):
     """
-    Mit dieser Aufzählung können arithmetische Operationen festgelegt werden.
+    Mit dieser Aufzählung können Operationen festgelegt werden.
     """
 
     ADDITION = "ADDITION"

src/bo4e/enum/arithmetische_operation.py src/bo4e/enum/operator.pysrc/bo4e/enum/arithmetische_operation.py renamed to src/bo4e/enum/operator.py

@@ -2,7 +2,7 @@
 from bo4e.enum.strenum import StrEnum
 
 
-class Regionskriteriumtyp(StrEnum):
+class Regionskriterium(StrEnum):
     """
     Klassifizierung der Kriterien für eine regionale Eingrenzung.
     """
@@ -67,7 +67,7 @@ class Regionskriteriumtyp(StrEnum):
     """Einwohnerzahl Gemeinde"""
     EINWOHNERZAHL_ORT = "EINWOHNERZAHL_ORT"
     """Einwohnerzahl Ort"""
-    KM_UMKREIS = "KM_UMKREIS"
+    PLZ_KM_UMKREIS = "PLZ_KM_UMKREIS"
     """km Umkreis"""
     BUNDESWEIT = "BUNDESWEIT"
     """Bundesweite Betrachtung"""