Merge pull request #21 from Geode-solutions/fix/data-literal

fix(Data): using Literals

Author: BotellaA

src/opengeodeweb_microservice/database/data.py

@@ -2,6 +2,7 @@
 from sqlalchemy.orm import Mapped, mapped_column
 from .connection import get_session
 from .base import Base
+from .data_types import GeodeObjectType, ViewerType, ViewerElementsType
 import uuid
 
 
@@ -11,18 +12,20 @@ class Data(Base):
     id: Mapped[str] = mapped_column(
         String, primary_key=True, default=lambda: str(uuid.uuid4()).replace("-", "")
     )
-    geode_object: Mapped[str] = mapped_column(String, nullable=False)
-    viewer_object: Mapped[str] = mapped_column(String, nullable=False)
-    viewer_elements_type: Mapped[str] = mapped_column(String, nullable=False)
+    geode_object: Mapped[GeodeObjectType] = mapped_column(String, nullable=False)
+    viewer_object: Mapped[ViewerType] = mapped_column(String, nullable=False)
+    viewer_elements_type: Mapped[ViewerElementsType] = mapped_column(
+        String, nullable=False
+    )
     native_file: Mapped[str | None] = mapped_column(String, nullable=True)
     viewable_file: Mapped[str | None] = mapped_column(String, nullable=True)
     light_viewable_file: Mapped[str | None] = mapped_column(String, nullable=True)
 
     @staticmethod
     def create(
-        geode_object: str,
-        viewer_object: str,
-        viewer_elements_type: str,
+        geode_object: GeodeObjectType,
+        viewer_object: ViewerType,
+        viewer_elements_type: ViewerElementsType,
     ) -> "Data":
         data_entry = Data(
             geode_object=geode_object,

src/opengeodeweb_microservice/database/data_types.py

@@ -0,0 +1,72 @@
+from typing import Literal, get_args, cast
+
+GeodePointMeshType = Literal[
+    "PointSet2D",
+    "PointSet3D",
+]
+GeodeEdgeMeshType = Literal[
+    "EdgedCurve2D",
+    "EdgedCurve3D",
+]
+GeodePolygonMeshType = Literal[
+    "RasterImage2D",
+    "PolygonalSurface2D",
+    "PolygonalSurface3D",
+    "TriangulatedSurface2D",
+    "TriangulatedSurface3D",
+    "RegularGrid2D",
+    "LightRegularGrid2D",
+]
+GeodePolyhedronMeshType = Literal[
+    "RasterImage3D",
+    "PolyhedralSolid3D",
+    "TetrahedralSolid3D",
+    "HybridSolid3D",
+    "RegularGrid3D",
+    "LightRegularGrid3D",
+]
+GeodeMeshType = (
+    Literal[
+        "VertexSet",
+        "Graph",
+    ]
+    | GeodePointMeshType
+    | GeodeEdgeMeshType
+    | GeodePolygonMeshType
+    | GeodePolyhedronMeshType
+)
+GeodeModelType = Literal[
+    "BRep",
+    "Section",
+    "StructuralModel",
+    "CrossSection",
+    "ImplicitStructuralModel",
+    "ImplicitCrossSection",
+]
+GeodeObjectType = GeodeMeshType | GeodeModelType
+
+
+def _flatten_literal_args(literal: object) -> tuple[str, ...]:
+    flattened: list[str] = []
+    for arg in get_args(literal):
+        if isinstance(arg, str):
+            flattened.append(arg)
+        else:
+            flattened.extend(_flatten_literal_args(arg))
+    return tuple(flattened)
+
+
+GeodeObjectType_values = _flatten_literal_args(GeodeObjectType)
+
+
+def geode_object_type(value: str) -> GeodeObjectType:
+    if value not in GeodeObjectType_values:
+        raise ValueError(
+            f"Invalid GeodeObjectType: {value!r}. Must be one of {GeodeObjectType_values}"
+        )
+    return cast(GeodeObjectType, value)
+
+
+ViewerType = Literal["mesh", "model"]
+
+ViewerElementsType = Literal["points", "edges", "polygons", "polyhedra", "default"]