typing test_mesh_protocols and vtk_protocols

Author: MaxNumerique

src/opengeodeweb_viewer/vtk_protocol.py

@@ -1,5 +1,6 @@
 # Standard library imports
 import os
+from typing import Dict, Any, Optional
 
 # Third party imports
 import vtk
@@ -11,17 +12,17 @@
 
 
 class VtkView(vtk_protocols.vtkWebProtocol):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
         self.DATA_FOLDER_PATH = os.getenv("DATA_FOLDER_PATH")
         self.DATABASE_PATH = os.getenv("DATABASE_PATH")
         self.DataReader = vtk.vtkXMLPolyDataReader()
         self.ImageReader = vtk.vtkXMLImageDataReader()
 
-    def get_data_base(self) -> dict:
+    def get_data_base(self) -> Dict[str, Any]:
         return self.getSharedObject("db")
 
-    def get_data(self, data_id):
+    def get_data(self, data_id: str) -> Dict[str, Any]:
         if Data is None:
             raise Exception("Data model not available")
 
@@ -47,33 +48,37 @@ def get_data(self, data_id):
             print(f"Error fetching data {data_id}: {e}")
             raise
 
-    def get_data_file_path(self, data_id: str, filename=None) -> str:
+    def get_data_file_path(self, data_id: str, filename: Optional[str] = None) -> str:
         if filename is None:
             data = self.get_data(data_id)
             filename = data["viewable_file_name"]
 
-        return os.path.join(self.DATA_FOLDER_PATH, data_id, filename)
+        data_folder_path = self.DATA_FOLDER_PATH
+        if data_folder_path is None:
+            raise Exception("DATA_FOLDER_PATH environment variable not set")
+            
+        return os.path.join(data_folder_path, data_id, filename)
 
-    def get_renderer(self):
+    def get_renderer(self) -> Any:
         return self.getSharedObject("renderer")
 
-    def get_object(self, id):
+    def get_object(self, id: str) -> Any:
         return self.get_data_base()[id]
 
-    def get_protocol(self, name):
+    def get_protocol(self, name: str) -> Any:
         for p in self.coreServer.getLinkProtocols():
             if type(p).__name__ == name:
                 return p
 
-    def render(self, view=-1):
+    def render(self, view: int = -1) -> None:
         if "grid_scale" in self.get_data_base():
             renderer = self.get_renderer()
             renderer_bounds = renderer.ComputeVisiblePropBounds()
             grid_scale = self.get_object("grid_scale")["actor"]
             grid_scale.SetBounds(renderer_bounds)
         self.getSharedObject("publisher").imagePush({"view": view})
 
-    def register_object(self, id, reader, filter, actor, mapper, textures):
+    def register_object(self, id: str, reader: Any, filter: Any, actor: Any, mapper: Any, textures: Any) -> None:
         self.get_data_base()[id] = {
             "reader": reader,
             "filter": filter,
@@ -82,6 +87,6 @@ def register_object(self, id, reader, filter, actor, mapper, textures):
             "textures": textures,
         }
 
-    def deregister_object(self, id):
+    def deregister_object(self, id: str) -> None:
         if id in self.get_data_base():
             del self.get_data_base()[id]

src/tests/mesh/test_mesh_protocols.py

@@ -1,9 +1,9 @@
+from typing import Callable
 from opengeodeweb_viewer.rpc.mesh.mesh_protocols import VtkMeshView
+from ..conftest import ServerMonitor
 
-from opengeodeweb_microservice.database.data import Data
 
-
-def test_register_mesh(server, dataset_factory):
+def test_register_mesh(server: ServerMonitor, dataset_factory: Callable[..., str]) -> None:
     dataset_factory(id="123456789", viewable_file_name="hat.vtp")
 
     server.call(
@@ -13,7 +13,7 @@ def test_register_mesh(server, dataset_factory):
     assert server.compare_image(3, "mesh/register.jpeg") == True
 
 
-def test_deregister_mesh(server, dataset_factory):
+def test_deregister_mesh(server: ServerMonitor, dataset_factory: Callable[..., str]) -> None:
     test_register_mesh(server, dataset_factory)
 
     server.call(
@@ -24,7 +24,7 @@ def test_deregister_mesh(server, dataset_factory):
     assert server.compare_image(3, "mesh/deregister.jpeg") == True
 
 
-def test_opacity(server, dataset_factory):
+def test_opacity(server: ServerMonitor, dataset_factory: Callable[..., str]) -> None:
     test_register_mesh(server, dataset_factory)
 
     server.call(
@@ -34,7 +34,7 @@ def test_opacity(server, dataset_factory):
     assert server.compare_image(3, "mesh/opacity.jpeg") == True
 
 
-def test_visibility(server, dataset_factory):
+def test_visibility(server: ServerMonitor, dataset_factory: Callable[..., str]) -> None:
     test_register_mesh(server, dataset_factory)
 
     server.call(
@@ -44,7 +44,7 @@ def test_visibility(server, dataset_factory):
     assert server.compare_image(3, "mesh/visibility.jpeg") == True
 
 
-def test_color(server, dataset_factory):
+def test_color(server: ServerMonitor, dataset_factory: Callable[..., str]) -> None:
     test_register_mesh(server, dataset_factory)
 
     server.call(
@@ -54,7 +54,7 @@ def test_color(server, dataset_factory):
     assert server.compare_image(3, "mesh/color.jpeg") == True
 
 
-def test_apply_textures(server, dataset_factory):
+def test_apply_textures(server: ServerMonitor, dataset_factory: Callable[..., str]) -> None:
     test_register_mesh(server, dataset_factory)
     texture_entry = dataset_factory(
         id="987654321",