Merge branch 'main' into dependabot/pip/dev_requirements/twine-6.2.0

lord-haffi · web-flow · commit 0ec4e586c7ee · 2025-11-18T14:14:25.000+01:00
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -43,7 +43,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
+        uses: github/codeql-action/init@v4
         with:
           languages: ${{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
@@ -54,7 +54,7 @@ jobs:
       # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
+        uses: github/codeql-action/autobuild@v4
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 https://git.io/JvXDl
@@ -68,4 +68,4 @@ jobs:
       #   make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
+        uses: github/codeql-action/analyze@v4
diff --git a/.github/workflows/packaging_test.yml b/.github/workflows/packaging_test.yml
@@ -6,7 +6,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12"]
         os: [ubuntu-latest]
     steps:
       - uses: actions/checkout@v5
diff --git a/.github/workflows/python-publish-scheduled.yml b/.github/workflows/python-publish-scheduled.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12"]
         os: [ubuntu-latest]
     steps:
       - uses: actions/checkout@v5
@@ -66,7 +66,7 @@ jobs:
         env:
           TARGET_VERSION: ${{ github.ref_name }}
       - name: Push schemas to BO4E-Schemas repo
-        uses: cpina/github-action-push-to-another-repository@v1.7.2
+        uses: cpina/github-action-push-to-another-repository@v1.7.3
         env:
           API_TOKEN_GITHUB: ${{ secrets.BO4E_PYTHON_GENERATE_SCHEMAS }} # this token expires on 2024-10-09
           # token with repo scope
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -80,7 +80,7 @@ jobs:
         env:
           TARGET_VERSION: ${{ github.ref_name }}
       - name: Push schemas to BO4E-Schemas repo
-        uses: cpina/github-action-push-to-another-repository@v1.7.2
+        uses: cpina/github-action-push-to-another-repository@v1.7.3
         env:
           API_TOKEN_GITHUB: ${{ secrets.BO4E_PYTHON_GENERATE_SCHEMAS }} # this token expires on 2024-10-09
           # token with repo scope
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -6,7 +6,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12"]
         os: [ubuntu-latest]
     steps:
       - uses: actions/checkout@v5
diff --git a/.gitignore b/.gitignore
@@ -166,8 +166,8 @@ Temporary Items
 # This directory rebuilds on 'tox -e docs' therefore not needed in repo
 docs/api
 docs/plantuml.jar
-docs/_static
-docs/compatibility_matrix.csv
+docs/_static/images
+docs/_static/tables
 
 # version number for bo4e-python; gets auto-generated during the command
 # python -m build
diff --git a/dev_requirements/requirements-coverage.txt b/dev_requirements/requirements-coverage.txt
@@ -4,5 +4,5 @@
 #
 #    pip-compile '.\dev_requirements\requirements-coverage.in'
 #
-coverage==7.10.4
+coverage==7.11.0
     # via -r requirements-coverage.in
diff --git a/dev_requirements/requirements-linting.txt b/dev_requirements/requirements-linting.txt
@@ -14,7 +14,7 @@ mccabe==0.7.0
     # via pylint
 platformdirs==4.3.8
     # via pylint
-pylint==3.3.8
+pylint==3.3.9
     # via -r requirements-linting.in
 tomlkit==0.13.3
     # via pylint
diff --git a/dev_requirements/requirements-type_check.txt b/dev_requirements/requirements-type_check.txt
@@ -6,7 +6,7 @@
 #
 iniconfig==2.1.0
     # via pytest
-mypy==1.17.1
+mypy==1.18.2
     # via -r requirements-type_check.in
 mypy-extensions==1.1.0
     # via mypy
@@ -24,7 +24,7 @@ pygments==2.19.2
     # via pytest
 pytest==8.4.2
     # via -r requirements-type_check.in
-types-requests==2.32.4.20250809
+types-requests==2.32.4.20250913
     # via -r requirements-type_check.in
 typing-extensions==4.14.1
     # via mypy
diff --git a/docs/_static/css/colors.css b/docs/_static/css/colors.css
@@ -0,0 +1,18 @@
+
+:root {
+  /* These colors should stay consistent with the colors used in the CLI:
+     https://github.com/bo4e/BO4E-CLI/blob/main/src/bo4e_cli/io/console/style.py#L238 */
+  --main-color: #8cc04d;
+  --sub-color: #617d8b;
+  --error-color: #e35b3a;
+}
+
+.main-color {
+  color: var(--main-color);
+}
+.sub-color {
+  color: var(--sub-color);
+}
+.error-color {
+  color: var(--error-color);
+}
diff --git a/docs/_static/css/override.css b/docs/_static/css/override.css
@@ -0,0 +1,5 @@
+
+.rst-content table .line-block:last-child {
+    /* Remove the margin-bottom from the line-blocks inside tables. Example in changelog.rst. */
+    margin-bottom: 0;
+}
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -20,29 +20,27 @@ You can also download the compatibility matrix as CSV file `here <_static/tables
 .. table:: Legend for compatibility matrix
    :widths: 10 90
 
-   +------+------------------------------------------------------+
-   | Icon | Description                                          |
-   +======+======================================================+
-   | 🟢   | Compatible                                           |
-   |      | No changes in the data model                         |
-   +------+------------------------------------------------------+
-   | 🟡   | Compatible                                           |
-   |      | Only non-critical changes in the data model          |
-   |      | e.g. added fields, changed doc strings               |
-   +------+------------------------------------------------------+
-   | 🔴   | Incompatible                                         |
-   |      | Critical changes in the data model                   |
-   |      | e.g. removed fields, changed types                   |
-   +------+------------------------------------------------------+
-   | ➕   | Compatible                                           |
-   |      | Data model was added in this version                 |
-   +------+------------------------------------------------------+
-   | ➖   | Incompatible                                         |
-   |      | Data model was removed in this version               |
-   +------+------------------------------------------------------+
-   | \-   | Data model not existent in this version              |
-   |      | was removed before or will be added in future        |
-   +------+------------------------------------------------------+
+   +------+---------------------------------------------------------------------------------------------------+
+   | Icon | Description                                                                                       |
+   +======+===================================================================================================+
+   | 🟢   | | :main-color:`Compatible`                                                                        |
+   |      | | No changes in the data model                                                                    |
+   +------+---------------------------------------------------------------------------------------------------+
+   | 🟡   | | :main-color:`Compatible`                                                                        |
+   |      | | Only non\-critical changes in the data model e.g. added fields, changed doc strings             |
+   +------+---------------------------------------------------------------------------------------------------+
+   | 🔴   | | :error-color:`Incompatible`                                                                     |
+   |      | | Critical changes in the data model e.g. removed fields, changed types                           |
+   +------+---------------------------------------------------------------------------------------------------+
+   | ➕   | | :main-color:`Compatible`                                                                        |
+   |      | | Data model was added in this version                                                            |
+   +------+---------------------------------------------------------------------------------------------------+
+   | ➖   | | :error-color:`Incompatible`                                                                     |
+   |      | | Data model was removed in this version                                                          |
+   +------+---------------------------------------------------------------------------------------------------+
+   | \-   | | Non\-existent                                                                                   |
+   |      | | Doesn't exist in this version i.e. it was removed before or will be added in future             |
+   +------+---------------------------------------------------------------------------------------------------+
 
 .. csv-table:: Compatibility matrix
    :file: _static/tables/compatibility_matrix.csv
diff --git a/docs/conf.py b/docs/conf.py
@@ -37,6 +37,8 @@
 from bo4e_cli.models.version import Version
 from bo4e_cli.utils.github_cli import get_access_token_from_cli_if_installed
 
+from bo4e import __gh_version__, __version__
+
 sys.path.insert(0, os.path.join(__location__, "../src"))
 sys.path.insert(0, os.path.join(__location__, "../docs"))
 sys.path.insert(0, os.path.join(__location__, "../docs/compatibility"))
@@ -194,6 +196,16 @@ def setup(app):
     "titles_only": False,
 }
 
+html_css_files = [
+    "css/override.css",
+    "css/colors.css",
+]
+rst_prolog = """
+.. role:: main-color
+.. role:: sub-color
+.. role:: error-color
+"""
+
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
 
@@ -204,11 +216,11 @@ def setup(app):
 if "release" not in globals():
     release = os.getenv("SPHINX_DOCS_RELEASE")
     if not release:
-        from bo4e import __gh_version__ as release
+        release = __gh_version__
 if "version" not in globals():
     version = os.getenv("SPHINX_DOCS_VERSION")
     if not version:
-        from bo4e import __version__ as version
+        version = __version__
 
 print(f"Got version = {version} from __version__")
 print(f"Got release = {release} from __gh_version__")
@@ -340,9 +352,9 @@ def setup(app):
 
 # Create UML diagrams in plantuml format. Compile these into svg files into the _static folder.
 # See docs/uml.py for more details.
-release_version = Version.from_str(release)
+release_version = Version.from_str(__gh_version__)
 if not release_version.is_dirty():
-    uml.LINK_URI_BASE = f"https://bo4e.github.io/BO4E-python/{release}"
+    uml.LINK_URI_BASE = f"https://bo4e.github.io/BO4E-python/{__gh_version__}"
 _exec_plantuml = Path(__location__) / "plantuml.jar"
 _network, _namespaces_to_parse = uml.build_network(Path(module_dir), uml.PlantUMLNetwork)
 print(_network)
@@ -360,7 +372,7 @@ def setup(app):
 compiling_from_release_workflow = not release_version.is_dirty()
 last_versions = get_last_n_tags(
     n=3,
-    ref=str(release) if compiling_from_release_workflow else "HEAD",
+    ref=str(release_version) if compiling_from_release_workflow else "HEAD",
     exclude_candidates=True,
     exclude_technical_bumps=True,
     token=gh_token,
diff --git a/src/bo4e/__init__.py b/src/bo4e/__init__.py
@@ -73,6 +73,7 @@
     "Lastprofil",
     "MarktgebietInfo",
     "Menge",
+    "Messwert",
     "PositionsAufAbschlag",
     "Preis",
     "Preisgarantie",
@@ -111,7 +112,6 @@
     "Angebotsstatus",
     "Anrede",
     "ArithmetischeOperation",
-    "ArtikelId",
     "AufAbschlagstyp",
     "AufAbschlagsziel",
     "Ausschreibungsportal",
@@ -149,7 +149,6 @@
     "Messart",
     "Messgroesse",
     "Messpreistyp",
-    "Messwerterfassung",
     "Messwertstatus",
     "Messwertstatuszusatz",
     "Netzebene",
@@ -277,6 +276,7 @@
 from .com.lastprofil import Lastprofil
 from .com.marktgebietinfo import MarktgebietInfo
 from .com.menge import Menge
+from .com.messwert import Messwert
 from .com.positionsaufabschlag import PositionsAufAbschlag
 from .com.preis import Preis
 from .com.preisgarantie import Preisgarantie
@@ -318,7 +318,6 @@
 from .enum.angebotsstatus import Angebotsstatus
 from .enum.anrede import Anrede
 from .enum.arithmetische_operation import ArithmetischeOperation
-from .enum.artikelid import ArtikelId
 from .enum.aufabschlagstyp import AufAbschlagstyp
 from .enum.aufabschlagsziel import AufAbschlagsziel
 from .enum.ausschreibungsportal import Ausschreibungsportal
@@ -357,7 +356,6 @@
 from .enum.messart import Messart
 from .enum.messgroesse import Messgroesse
 from .enum.messpreistyp import Messpreistyp
-from .enum.messwerterfassung import Messwerterfassung
 from .enum.messwertstatus import Messwertstatus
 from .enum.messwertstatuszusatz import Messwertstatuszusatz
 from .enum.netzebene import Netzebene
diff --git a/src/bo4e/bo/zaehler.py b/src/bo4e/bo/zaehler.py
@@ -19,7 +19,6 @@
     from ..bo.geraet import Geraet
     from ..com.zaehlwerk import Zaehlwerk
     from ..enum.befestigungsart import Befestigungsart
-    from ..enum.messwerterfassung import Messwerterfassung
     from ..enum.registeranzahl import Registeranzahl
     from ..enum.sparte import Sparte
     from ..enum.zaehlerauspraegung import Zaehlerauspraegung
@@ -67,8 +66,8 @@ class Zaehler(Geschaeftsobjekt):
     """Der Hersteller des Zählers"""
     ist_fernschaltbar: Optional[bool] = None
     """Fernschaltung"""
-    messwerterfassung: Optional["Messwerterfassung"] = None
-    """Messwerterfassung des Zählers"""
+    ist_fernauslesbar: Optional[bool] = None
+    """Fernauslesung"""
     zaehlertypSpezifikation: Optional["ZaehlertypSpezifikation"] = None
     """Besondere Spezifikation des Zählers"""
     befestigungsart: Optional["Befestigungsart"] = None
diff --git a/src/bo4e/com/messwert.py b/src/bo4e/com/messwert.py
@@ -0,0 +1,43 @@
+"""
+Contains Messwert class
+"""
+
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
+
+import pydantic
+from pydantic import Field
+
+from ..enum.comtyp import ComTyp
+from ..utils import postprocess_docstring
+from .com import COM
+
+if TYPE_CHECKING:
+    from ..com.menge import Menge
+    from ..enum.messwertstatus import Messwertstatus
+    from ..enum.messwertstatuszusatz import Messwertstatuszusatz
+
+
+@postprocess_docstring
+class Messwert(COM):
+    """
+    Abbildung eines Messwertes mit Stati, Zeitpunkt und Wert.
+
+    .. raw:: html
+
+        <object data="../_static/images/bo4e/com/Messwert.svg" type="image/svg+xml"></object>
+
+    .. HINT::
+        `Messwert JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/com/Messwert.json>`_
+
+    """
+
+    typ: Annotated[Literal[ComTyp.MESSWERT], Field(alias="_typ")] = ComTyp.MESSWERT
+
+    messwertstatus: Optional["Messwertstatus"] = None
+    """Gibt den Status des Messwerts an."""
+    messwertstatuszusatz: Optional["Messwertstatuszusatz"] = None
+    """Gibt den Status Zusatz des Messwerts an."""
+    zeitpunkt: Optional[pydantic.AwareDatetime] = None
+    """Gibt den Zeitpunkt des Messwerts an."""
+    wert: Optional["Menge"] = None
+    """Gibt die gemessene Menge an."""
diff --git a/src/bo4e/com/steuerbetrag.py b/src/bo4e/com/steuerbetrag.py
@@ -37,6 +37,8 @@ class Steuerbetrag(COM):
 
     steuerkennzeichen: Optional["Steuerkennzeichen"] = None
     """Kennzeichnung des Steuersatzes, bzw. Verfahrens."""
+    sondersteuersatz: Optional[Decimal] = None
+    """Angabe des Steuersatzes in %, sofern steuerkennzeichen = UST_SONDER"""
     basiswert: Optional[Decimal] = None
     """Nettobetrag für den die Steuer berechnet wurde. Z.B. 100"""
     steuerwert: Optional[Decimal] = None
diff --git a/src/bo4e/com/zaehlwerk.py b/src/bo4e/com/zaehlwerk.py
@@ -13,6 +13,7 @@
 
 if TYPE_CHECKING:
     from ..com.konzessionsabgabe import Konzessionsabgabe
+    from ..com.messwert import Messwert
     from ..com.verwendungszweckpromarktrolle import VerwendungszweckProMarktrolle
     from ..com.zaehlzeitregister import Zaehlzeitregister
     from ..enum.energierichtung import Energierichtung
@@ -82,3 +83,5 @@ class Zaehlwerk(COM):
     """Anzahl Ablesungen pro Jahr"""
     zaehlzeitregister: Optional["Zaehlzeitregister"] = None
     """Erweiterte Definition der Zählzeit in Bezug auf ein Register"""
+    messwerte: Optional[list["Messwert"]] = None
+    """Gemessene Werte des Zählwerks"""
diff --git a/src/bo4e/enum/artikelid.py b/src/bo4e/enum/artikelid.py
diff --git a/src/bo4e/enum/comtyp.py b/src/bo4e/enum/comtyp.py
diff --git a/src/bo4e/enum/messwerterfassung.py b/src/bo4e/enum/messwerterfassung.py
diff --git a/src/bo4e/enum/steuerkennzeichen.py b/src/bo4e/enum/steuerkennzeichen.py
diff --git a/tests/test_messwert.py b/tests/test_messwert.py
diff --git a/tests/test_steuerbetrag.py b/tests/test_steuerbetrag.py
diff --git a/tests/test_zaehlwerk.py b/tests/test_zaehlwerk.py
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@`
`4`	`4`	`#`
`5`	`5`	`# pip-compile '.\dev_requirements\requirements-coverage.in'`
`6`	`6`	`#`
`7`		`-coverage==7.10.4`
	`7`	`+coverage==7.11.0`
`8`	`8`	`# via -r requirements-coverage.in`