Use literal type instead of enum type for _typ (#905)

* Use literal type instead of enum type for `_typ`

* 🔥

* 🩹mypy

* 🩹pylint

* 🩹coverage

* 🩹tests

* 🩹docs

* 🩹pylint

Author: lord-haffi

docs/compatibility/change_schemas.py

@@ -17,6 +17,7 @@ class ChangeType(StrEnum):
     FIELD_REMOVED = "field_removed"
     FIELD_DEFAULT_CHANGED = "field_default_changed"
     FIELD_DESCRIPTION_CHANGED = "field_description_changed"
+    FIELD_TITLE_CHANGED = "field_title_changed"
     # field type change types
     FIELD_CARDINALITY_CHANGED = "field_cardinality_changed"
     FIELD_REFERENCE_CHANGED = "field_reference_changed"

docs/compatibility/diff.py

@@ -3,6 +3,7 @@
 """
 
 import itertools
+import logging
 import re
 from pathlib import Path
 from typing import Iterable, Sequence
@@ -11,6 +12,8 @@
 
 from . import change_schemas, loader
 
+logger = logging.getLogger(__name__)
+
 REGEX_IGNORE_VERSION = re.compile(r"v\d+\.\d+\.\d+(-rc\d+)?")
 
 
@@ -21,11 +24,23 @@ def _diff_type_base(
     This function compares two type base schemas and yields the changes.
     """
     if schema_old.title != schema_new.title:
-        raise RuntimeError(
+        logger.warning(
             (
                 "Title should not change. Renaming is not detectable and the titles are autogenerated.\n"
-                f"{schema_old.title} -> {schema_new.title}"
-            )
+                "'%s' -> '%s'\n"
+                "%s -> %s"
+            ),
+            schema_old.title,
+            schema_new.title,
+            old_trace,
+            new_trace,
+        )
+        yield change_schemas.Change(
+            type=change_schemas.ChangeType.FIELD_TITLE_CHANGED,
+            old=schema_old.title,
+            new=schema_new.title,
+            old_trace=old_trace,
+            new_trace=new_trace,
         )
     if REGEX_IGNORE_VERSION.sub(schema_old.description, "{__gh_version__}") != REGEX_IGNORE_VERSION.sub(
         schema_new.description, "{__gh_version__}"
@@ -288,7 +303,9 @@ def _diff_root_schemas(
     yield from _diff_schema_type(schema_old, schema_new, old_trace, new_trace)
 
 
-def diff_schemas(schemas_old: Path, schemas_new: Path) -> Iterable[change_schemas.Change]:
+def diff_schemas(
+    schemas_old: Path, schemas_new: Path, old_trace: str, new_trace: str
+) -> Iterable[change_schemas.Change]:
     """
     This function compares two BO4E versions and yields the changes.
     Note: The paths to the old and the new schemas should correspond to the same root node of the tree structure.
@@ -302,23 +319,23 @@ def diff_schemas(schemas_old: Path, schemas_new: Path) -> Iterable[change_schema
             type=change_schemas.ChangeType.CLASS_REMOVED,
             old=loader.load_schema_file(schemas_old / schema_file),
             new=None,
-            old_trace=f"{'/'.join(schema_file.with_suffix('').parts)}#",
-            new_trace="#",
+            old_trace=f"{old_trace}/{'/'.join(schema_file.with_suffix('').parts)}#",
+            new_trace=f"{new_trace}/#",
         )
     for schema_file in new_schema_files - old_schema_files:
         yield change_schemas.Change(
             type=change_schemas.ChangeType.CLASS_ADDED,
             old=None,
             new=loader.load_schema_file(schemas_new / schema_file),
-            old_trace="#",
-            new_trace=f"{'/'.join(schema_file.with_suffix('').parts)}#",
+            old_trace=f"{old_trace}/#",
+            new_trace=f"{new_trace}/{'/'.join(schema_file.with_suffix('').parts)}#",
         )
     for schema_file in old_schema_files & new_schema_files:
         yield from _diff_root_schemas(
             loader.load_schema_file(schemas_old / schema_file),
             loader.load_schema_file(schemas_new / schema_file),
-            f"{'/'.join(schema_file.with_suffix('').parts)}#",
-            f"{'/'.join(schema_file.with_suffix('').parts)}#",
+            f"{old_trace}/{'/'.join(schema_file.with_suffix('').parts)}#",
+            f"{new_trace}/{'/'.join(schema_file.with_suffix('').parts)}#",
         )
 
 
@@ -333,7 +350,7 @@ def compare_bo4e_versions(
     dir_old_schemas = loader.pull_or_reuse_bo4e_version(version_old, gh_token)
     dir_new_schemas = loader.pull_or_reuse_bo4e_version(version_new, gh_token, from_local=from_local)
     print(f"Comparing {version_old} with {version_new}")
-    yield from diff_schemas(dir_old_schemas, dir_new_schemas)
+    yield from diff_schemas(dir_old_schemas, dir_new_schemas, version_old, version_new)
 
 
 def compare_bo4e_versions_iteratively(

src/bo4e/bo/angebot.py

@@ -4,7 +4,7 @@
 
 # pylint: disable=too-few-public-methods, too-many-instance-attributes
 # pylint: disable=no-name-in-module
-from typing import TYPE_CHECKING, Annotated, Optional
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
 
 import pydantic
 from pydantic import Field
@@ -38,7 +38,7 @@ class Angebot(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Optional["Typ"], Field(alias="_typ")] = Typ.ANGEBOT
+    typ: Annotated[Literal[Typ.ANGEBOT], Field(alias="_typ")] = Typ.ANGEBOT
     #: Eindeutige Nummer des Angebotes
     angebotsnummer: Optional[str] = None
     #: Erstellungsdatum des Angebots

src/bo4e/bo/ausschreibung.py

@@ -4,7 +4,7 @@
 
 # pylint: disable=too-few-public-methods, too-many-instance-attributes
 # pylint: disable=no-name-in-module
-from typing import TYPE_CHECKING, Annotated, Optional
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
 
 import pydantic
 from pydantic import Field
@@ -36,7 +36,7 @@ class Ausschreibung(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Optional["Typ"], Field(alias="_typ")] = Typ.AUSSCHREIBUNG
+    typ: Annotated[Literal[Typ.AUSSCHREIBUNG], Field(alias="_typ")] = Typ.AUSSCHREIBUNG
     #: Vom Herausgeber der Ausschreibung vergebene eindeutige Nummer
     ausschreibungsnummer: Optional[str] = None
     #: Aufzählung für die Typisierung von Ausschreibungen

src/bo4e/bo/buendelvertrag.py

@@ -4,7 +4,7 @@
 
 # pylint: disable=too-few-public-methods
 # pylint: disable=no-name-in-module
-from typing import TYPE_CHECKING, Annotated, Optional
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
 
 import pydantic
 from pydantic import Field
@@ -38,7 +38,7 @@ class Buendelvertrag(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Optional["Typ"], Field(alias="_typ")] = Typ.BUENDELVERTRAG
+    typ: Annotated[Literal[Typ.BUENDELVERTRAG], Field(alias="_typ")] = Typ.BUENDELVERTRAG
 
     # pylint: disable=duplicate-code
     #: Eine im Verwendungskontext eindeutige Nummer für den Vertrag

src/bo4e/bo/energiemenge.py

@@ -3,7 +3,7 @@
 and corresponding marshmallow schema for de-/serialization
 """
 
-from typing import TYPE_CHECKING, Annotated, Optional
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
 
 from pydantic import Field
 
@@ -34,7 +34,7 @@ class Energiemenge(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Optional["Typ"], Field(alias="_typ")] = Typ.ENERGIEMENGE
+    typ: Annotated[Literal[Typ.ENERGIEMENGE], Field(alias="_typ")] = Typ.ENERGIEMENGE
     #: Eindeutige Nummer der Marktlokation bzw. der Messlokation, zu der die Energiemenge gehört
     lokations_id: Optional[str] = None
     # todo: add validator such that only mess- or marktlokations IDs are accepted + cross check with lokationstyp

src/bo4e/bo/fremdkosten.py

@@ -2,7 +2,7 @@
 Contains Fremdkosten class and corresponding marshmallow schema for de-/serialization
 """
 
-from typing import TYPE_CHECKING, Annotated, Optional
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
 
 from pydantic import Field
 
@@ -35,7 +35,7 @@ class Fremdkosten(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Optional["Typ"], Field(alias="_typ")] = Typ.FREMDKOSTEN
+    typ: Annotated[Literal[Typ.FREMDKOSTEN], Field(alias="_typ")] = Typ.FREMDKOSTEN
     #: Für diesen Zeitraum wurden die Kosten ermittelt
     gueltigkeit: Optional["Zeitraum"] = None
     #: Die Gesamtsumme über alle Kostenblöcke und -positionen

src/bo4e/bo/geraet.py

@@ -3,7 +3,7 @@
 and corresponding marshmallow schema for de-/serialization
 """
 
-from typing import TYPE_CHECKING, Annotated, Optional
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
 
 from pydantic import Field
 
@@ -33,7 +33,7 @@ class Geraet(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Optional["Typ"], Field(alias="_typ")] = Typ.GERAET
+    typ: Annotated[Literal[Typ.GERAET], Field(alias="_typ")] = Typ.GERAET
 
     #: Die auf dem Gerät aufgedruckte Nummer, die vom MSB vergeben wird.
     geraetenummer: Optional[str] = None

src/bo4e/bo/geschaeftsobjekt.py

@@ -10,14 +10,13 @@
 from bo4e.version import __version__
 from bo4e.zusatzattribut import ZusatzAttribut
 
-from ..enum.typ import Typ
 from ..utils import postprocess_docstring
 
 # pylint: disable=too-few-public-methods
 
 
 @postprocess_docstring
-class Geschaeftsobjekt(BaseModel):
+class Geschaeftsobjekt(BaseModel):  # pragma: no cover
     """
     Das BO Geschäftsobjekt ist der Master für alle Geschäftsobjekte.
     Alle Attribute, die hier in diesem BO enthalten sind, werden an alle BOs vererbt.
@@ -35,9 +34,6 @@ class Geschaeftsobjekt(BaseModel):
     version: Annotated[Optional[str], Field(alias="_version")] = (
         __version__  #: Version der BO-Struktur aka "fachliche Versionierung"
     )
-    # src/_bo4e_python_version.py
-    typ: Annotated[Optional["Typ"], Field(alias="_typ")] = Typ.GESCHAEFTSOBJEKT  #: Der Typ des Geschäftsobjektes
-    # bo_typ is used as discriminator f.e. for databases or deserialization
 
     zusatz_attribute: Optional[list["ZusatzAttribut"]] = None
     # zusatz_attribute is a list of ZusatzAttribut objects which are used to store additional information

src/bo4e/bo/geschaeftspartner.py

@@ -4,7 +4,7 @@
 """
 
 # pylint: disable=too-many-instance-attributes, too-few-public-methods, disable=duplicate-code
-from typing import TYPE_CHECKING, Annotated, Optional
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
 
 from pydantic import Field
 
@@ -39,7 +39,7 @@ class Geschaeftspartner(Geschaeftsobjekt):
 
     """
 
-    typ: Annotated[Optional["Typ"], Field(alias="_typ")] = Typ.GESCHAEFTSPARTNER
+    typ: Annotated[Literal[Typ.GESCHAEFTSPARTNER], Field(alias="_typ")] = Typ.GESCHAEFTSPARTNER
     #: Mögliche Anrede der Person
     anrede: Optional["Anrede"] = None
     individuelle_anrede: Optional[str] = None