init datamodel

.pre-commit-config.yaml

@@ -1,18 +1,18 @@
 # to update all repo revisions just run: pre-commit autoupdate
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 24.2.0
     hooks:
       - id: black
         language_version: python3
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         name: isort (python)

dev_requirements/requirements-formatting.txt

@@ -16,9 +16,9 @@ packaging==23.0
     # via black
 pathspec==0.11.0
     # via black
-platformdirs==3.1.0
+platformdirs==4.2.0
     # via black
 tomli==2.0.1
     # via black
-typing-extensions==4.9.0
+typing-extensions==4.10.0
     # via black

dev_requirements/requirements-linting.txt

@@ -12,13 +12,13 @@ isort==5.13.2
     # via pylint
 mccabe==0.7.0
     # via pylint
-platformdirs==3.1.0
+platformdirs==4.2.0
     # via pylint
 pylint==3.1.0
     # via -r dev_requirements/requirements-linting.in
 tomli==2.0.1
     # via pylint
 tomlkit==0.11.6
     # via pylint
-typing-extensions==4.9.0
+typing-extensions==4.10.0
     # via astroid

dev_requirements/requirements-type_check.txt

@@ -10,5 +10,5 @@ mypy-extensions==1.0.0
     # via mypy
 tomli==2.0.1
     # via mypy
-typing-extensions==4.9.0
+typing-extensions==4.10.0
     # via mypy

domain-specific-terms.txt

@@ -1 +1,2 @@
 # contains 1 lower case word per line which are ignored in the spell_check
+segmente

pyproject.toml

@@ -16,7 +16,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-dependencies = [] # add all the dependencies here
+dependencies = ["pydantic"] # add all the dependencies here
 dynamic = ["readme", "version"]
 
 [project.urls]

requirements.txt

@@ -1,6 +1,24 @@
 #
-# This file is autogenerated by pip-compile with Python 3.11
+# This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
 #    pip-compile pyproject.toml
 #
+annotated-types==0.6.0
+    # via pydantic
+distlib==0.3.8
+    # via virtualenv
+filelock==3.13.1
+    # via virtualenv
+platformdirs==4.2.0
+    # via virtualenv
+pydantic==2.6.2
+    # via migmose (pyproject.toml)
+pydantic-core==2.16.3
+    # via pydantic
+typing-extensions==4.10.0
+    # via
+    #   pydantic
+    #   pydantic-core
+virtualenv==20.25.1
+    # via migmose (pyproject.toml)

src/migmose/mig/baumdiagramm.py

@@ -0,0 +1,12 @@
+"""
+contains class for trees consisting of segments of mig tables
+"""
+
+from migmose.mig.nachrichtenstrukturzeile import NachrichtenstrukturZeile
+
+
+class BaumSegmentGruppe(NachrichtenstrukturZeile):
+    """will contain the tree structure of nachrichtenstruktur tables"""
+
+    segmente: list[NachrichtenstrukturZeile]
+    segmentgruppe: list["BaumSegmentGruppe"]

src/migmose/mig/nachrichtenstruktur.py

@@ -0,0 +1,15 @@
+"""
+contains class mig tables
+"""
+
+from pydantic import BaseModel
+
+from migmose.mig.nachrichtenstrukturzeile import NachrichtenstrukturZeile
+
+
+class NachrichtenstrukturTabelle(BaseModel):
+    """
+    class for mig tables
+    """
+
+    lines: list[NachrichtenstrukturZeile]

src/migmose/mig/nachrichtenstrukturzeile.py

@@ -0,0 +1,21 @@
+"""
+contains class for lines in mig tables
+"""
+
+from pydantic import BaseModel
+
+
+class NachrichtenstrukturZeile(BaseModel):
+    """
+    class for lines in mig tables
+    """
+
+    zaehler: str
+    nr: str
+    bezeichnung: str
+    standard_status: str
+    bdew_status: str
+    standard_maximale_wiederholungen: int
+    bdew_maximale_wiederholungen: int
+    ebene: int
+    inhalt: str

src/migmose/mig/segmentgruppe.py

@@ -0,0 +1,14 @@
+"""
+contains class for structured segmentgroups in mig tables. Builds table recursively.
+"""
+
+from migmose.mig.nachrichtenstrukturzeile import NachrichtenstrukturZeile
+
+
+class SegmentGruppe(NachrichtenstrukturZeile):
+    """
+    class for structured segmentgroups in mig tables. builds table recursively. inherits from NachrichtenstrukturZeile
+    """
+
+    segmente: list[NachrichtenstrukturZeile]
+    segmentgruppe: list["SegmentGruppe"]

tox.ini

@@ -4,6 +4,7 @@ envlist =
     linting
     coverage
     type_check
+    spell_check
 skip_missing_interpreters = True
 skipsdist = True