Skip to content

Commit 441850a

Browse files
committed
type mesh_protocols and test_viewer_protocols
1 parent aaf37ee commit 441850a

File tree

2 files changed

+43
-24
lines changed

2 files changed

+43
-24
lines changed

src/opengeodeweb_viewer/rpc/mesh/mesh_protocols.py

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Standard library imports
22
import os
3+
from typing import Any, Dict, List
34

45
# Third party imports
56
import vtk
@@ -17,11 +18,11 @@ class VtkMeshView(VtkObjectView):
1718
os.path.join(os.path.dirname(__file__), "schemas")
1819
)
1920

20-
def __init__(self):
21+
def __init__(self) -> None:
2122
super().__init__()
2223

2324
@exportRpc(mesh_prefix + mesh_schemas_dict["register"]["rpc"])
24-
def registerMesh(self, params):
25+
def registerMesh(self, params: Dict[str, Any]) -> None:
2526
validate_schema(params, self.mesh_schemas_dict["register"], self.mesh_prefix)
2627
data_id = params["id"]
2728
try:
@@ -78,25 +79,25 @@ def registerMesh(self, params):
7879
raise
7980

8081
@exportRpc(mesh_prefix + mesh_schemas_dict["deregister"]["rpc"])
81-
def deregisterMesh(self, params):
82+
def deregisterMesh(self, params: Dict[str, Any]) -> None:
8283
validate_schema(params, self.mesh_schemas_dict["deregister"], self.mesh_prefix)
8384
data_id = params["id"]
8485
self.deregisterObject(data_id)
8586

8687
@exportRpc(mesh_prefix + mesh_schemas_dict["visibility"]["rpc"])
87-
def SetMeshVisibility(self, params):
88+
def SetMeshVisibility(self, params: Dict[str, Any]) -> None:
8889
validate_schema(params, self.mesh_schemas_dict["visibility"], self.mesh_prefix)
8990
data_id, visibility = params["id"], params["visibility"]
9091
self.SetVisibility(data_id, visibility)
9192

9293
@exportRpc(mesh_prefix + mesh_schemas_dict["opacity"]["rpc"])
93-
def setMeshOpacity(self, params):
94+
def setMeshOpacity(self, params: Dict[str, Any]) -> None:
9495
validate_schema(params, self.mesh_schemas_dict["opacity"], self.mesh_prefix)
9596
data_id, opacity = params["id"], params["opacity"]
9697
self.SetOpacity(data_id, opacity)
9798

9899
@exportRpc(mesh_prefix + mesh_schemas_dict["color"]["rpc"])
99-
def setMeshColor(self, params):
100+
def setMeshColor(self, params: Dict[str, Any]) -> None:
100101
validate_schema(params, self.mesh_schemas_dict["color"], self.mesh_prefix)
101102
data_id, red, green, blue = (
102103
params["id"],
@@ -107,14 +108,14 @@ def setMeshColor(self, params):
107108
self.SetColor(data_id, red, green, blue)
108109

109110
@exportRpc(mesh_prefix + mesh_schemas_dict["apply_textures"]["rpc"])
110-
def meshApplyTextures(self, params):
111+
def meshApplyTextures(self, params: Dict[str, Any]) -> None:
111112
validate_schema(
112113
params, self.mesh_schemas_dict["apply_textures"], self.mesh_prefix
113114
)
114115
data_id, textures_info = params["id"], params["textures"]
115116
self.applyTextures(data_id, textures_info)
116117

117-
def applyTextures(self, mesh_id: str, textures_info: list):
118+
def applyTextures(self, mesh_id: str, textures_info: List[Dict[str, Any]]) -> None:
118119
for tex_info in textures_info:
119120
texture_id = tex_info["id"]
120121
texture_name = tex_info["texture_name"]
@@ -140,7 +141,7 @@ def applyTextures(self, mesh_id: str, textures_info: list):
140141
actor.SetTexture(texture)
141142
self.render()
142143

143-
def displayAttributeOnVertices(self, data_id: str, name: str):
144+
def displayAttributeOnVertices(self, data_id: str, name: str) -> None:
144145
reader = self.get_object(data_id)["reader"]
145146
points = reader.GetOutput().GetPointData()
146147
points.SetActiveScalars(name)
@@ -150,7 +151,7 @@ def displayAttributeOnVertices(self, data_id: str, name: str):
150151
mapper.SetScalarRange(points.GetScalars().GetRange())
151152
self.render()
152153

153-
def displayAttributeOnCells(self, data_id, name):
154+
def displayAttributeOnCells(self, data_id: str, name: str) -> None:
154155
reader = self.get_object(data_id)["reader"]
155156
cells = reader.GetOutput().GetCellData()
156157
cells.SetActiveScalars(name)

src/tests/test_viewer_protocols.py

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11
# Standard library imports
22
import os
3+
from typing import Callable
34

45
# Third party imports
5-
import pytest
66

77
# Local application imports
88
from opengeodeweb_viewer.rpc.viewer.viewer_protocols import VtkViewerView
99
from opengeodeweb_viewer.rpc.mesh.mesh_protocols import VtkMeshView
1010

11-
1211
# Local application imports
1312
from .mesh.test_mesh_protocols import test_register_mesh
13+
from .conftest import ServerMonitor
1414

1515

16-
def test_reset_visualization(server):
16+
def test_reset_visualization(server: ServerMonitor) -> None:
1717
server.call(
1818
VtkViewerView.viewer_prefix
1919
+ VtkViewerView.viewer_schemas_dict["reset_visualization"]["rpc"]
2020
)
2121
assert server.compare_image(3, "viewer/reset_visualization.jpeg") == True
2222

2323

24-
def test_reset_camera(server):
24+
def test_reset_camera(server: ServerMonitor) -> None:
2525
server.call(
2626
VtkViewerView.viewer_prefix
2727
+ VtkViewerView.viewer_schemas_dict["reset_camera"]["rpc"]
2828
)
2929
assert server.compare_image(3, "viewer/reset_camera.jpeg") == True
3030

3131

32-
def test_set_viewer_background_color(server):
32+
def test_set_viewer_background_color(server: ServerMonitor) -> None:
3333
server.call(
3434
VtkViewerView.viewer_prefix
3535
+ VtkViewerView.viewer_schemas_dict["set_background_color"]["rpc"],
@@ -38,7 +38,9 @@ def test_set_viewer_background_color(server):
3838
assert server.compare_image(3, "viewer/set_background_color.jpeg") == True
3939

4040

41-
def test_get_point_position(server, dataset_factory):
41+
def test_get_point_position(
42+
server: ServerMonitor, dataset_factory: Callable[..., str]
43+
) -> None:
4244
test_register_mesh(server, dataset_factory)
4345

4446
server.call(
@@ -65,7 +67,9 @@ def test_get_point_position(server, dataset_factory):
6567
assert type(z) is float
6668

6769

68-
def test_take_screenshot(server, dataset_factory):
70+
def test_take_screenshot(
71+
server: ServerMonitor, dataset_factory: Callable[..., str]
72+
) -> None:
6973
test_register_mesh(server, dataset_factory)
7074

7175
# Take a screenshot with background jpg
@@ -154,7 +158,9 @@ def test_take_screenshot(server, dataset_factory):
154158
assert server.images_diff(first_image_path, second_image_path) == 0.0
155159

156160

157-
def test_picked_ids(server, dataset_factory):
161+
def test_picked_ids(
162+
server: ServerMonitor, dataset_factory: Callable[..., str]
163+
) -> None:
158164

159165
test_register_mesh(server, dataset_factory)
160166

@@ -182,7 +188,9 @@ def test_picked_ids(server, dataset_factory):
182188
assert isinstance(array_ids, list)
183189

184190

185-
def test_grid_scale(server, dataset_factory):
191+
def test_grid_scale(
192+
server: ServerMonitor, dataset_factory: Callable[..., str]
193+
) -> None:
186194
data_id = "123456789"
187195
dataset_factory(id=data_id, viewable_file_name="hat.vtp")
188196
server.call(
@@ -204,7 +212,9 @@ def test_grid_scale(server, dataset_factory):
204212
assert server.compare_image(3, "viewer/grid_scale_on.jpeg") == True
205213

206214

207-
def test_axes(server, dataset_factory):
215+
def test_axes(
216+
server: ServerMonitor, dataset_factory: Callable[..., str]
217+
) -> None:
208218

209219
test_reset_visualization(server)
210220

@@ -216,7 +226,9 @@ def test_axes(server, dataset_factory):
216226
assert server.compare_image(3, "viewer/axes_off.jpeg") == True
217227

218228

219-
def test_update_camera(server, dataset_factory):
229+
def test_update_camera(
230+
server: ServerMonitor, dataset_factory: Callable[..., str]
231+
) -> None:
220232
test_register_mesh(server, dataset_factory)
221233

222234
camera_options = {
@@ -239,7 +251,9 @@ def test_update_camera(server, dataset_factory):
239251
assert server.compare_image(3, "viewer/update_camera.jpeg") == True
240252

241253

242-
def test_render_now(server, dataset_factory):
254+
def test_render_now(
255+
server: ServerMonitor, dataset_factory: Callable[..., str]
256+
) -> None:
243257
test_register_mesh(server, dataset_factory)
244258

245259
camera_options = {
@@ -269,7 +283,9 @@ def test_render_now(server, dataset_factory):
269283
assert server.compare_image(3, "viewer/render_now.jpeg") == True
270284

271285

272-
def test_set_z_scaling(server, dataset_factory):
286+
def test_set_z_scaling(
287+
server: ServerMonitor, dataset_factory: Callable[..., str]
288+
) -> None:
273289
dataset_factory(id="123456789", viewable_file_name="polygon_attribute.vtp")
274290

275291
server.call(
@@ -312,7 +328,9 @@ def test_set_z_scaling(server, dataset_factory):
312328
assert server.compare_image(3, "viewer/set_z_scaling.jpeg") == True
313329

314330

315-
def test_combined_scaling_and_grid(server, dataset_factory):
331+
def test_combined_scaling_and_grid(
332+
server: ServerMonitor, dataset_factory: Callable[..., str]
333+
) -> None:
316334
server.call(
317335
VtkViewerView.viewer_prefix
318336
+ VtkViewerView.viewer_schemas_dict["reset_visualization"]["rpc"],

0 commit comments

Comments
 (0)