chore: Type settings and vertices and beginning of show.

Author: clemens-fricke

gustaf/settings.py

@@ -3,19 +3,21 @@
 Global variables/constants that's used throughout `gustaf`.
 """
 
-TOLERANCE = 1e-10
+from typing import Literal
 
-FLOAT_DTYPE = "float64"
-INT_DTYPE = "int32"
+TOLERANCE: float = 1e-10
+
+FLOAT_DTYPE: Literal["float64"] = "float64"
+INT_DTYPE: Literal["int32"] = "int32"
 
 # OPTIONS are <"vedo" | "trimesh" | "matplotlib">
-VISUALIZATION_BACKEND = "vedo"
+VISUALIZATION_BACKEND: Literal["vedo"] = "vedo"
 
-VEDO_DEFAULT_OPTIONS = {
+VEDO_DEFAULT_OPTIONS: dict[str, dict] = {
     "vertex": {},
     "edges": {},
     "faces": {},
     "volumes": {},
 }
 
-NTHREADS = 1
+NTHREADS: int = 1

gustaf/show.py

@@ -3,7 +3,10 @@
 Everything related to show/visualization.
 """
 
+from __future__ import annotations
+
 import sys
+from typing import TYPE_CHECKING
 
 import numpy as np
 
@@ -38,6 +41,11 @@
     vedo = ModuleImportRaiser("vedo", err)
     vedoUGrid = vedo
 
+if TYPE_CHECKING:
+    from typing import Any
+
+    from gustaf._base import GustafBase
+
 
 # enable `gus.show()`
 # taken from https://stackoverflow.com/questions/1060796/callable-modules
@@ -82,7 +90,9 @@ def show(*args, **kwargs):
     return_show_list = kwargs.get("return_showable_list", False)
     axes = kwargs.get("axes", None)
 
-    def clear_vedo_plotter(plotter, num_renderers, skip_cl=skip_clear):
+    def clear_vedo_plotter(
+        plotter: vedo.Plotter, num_renderers: int, skip_cl: bool = skip_clear
+    ):
         """enough said."""
         # for whatever reason it is desired
         if skip_cl:
@@ -98,7 +108,7 @@ def clear_vedo_plotter(plotter, num_renderers, skip_cl=skip_clear):
 
         return None
 
-    def cam_tuple_to_list(dict_cam):
+    def cam_tuple_to_list(dict_cam: None | dict[str, Any]):
         """if entity is tuple, turns it into list."""
         if dict_cam is None:
             return None
@@ -235,7 +245,9 @@ def cam_tuple_to_list(dict_cam):
         return plt
 
 
-def make_showable(obj, as_dict=False, **kwargs):
+# TODO the type of obj is not really easy to define since it in reality it
+# should be gustaf.Vertice but it might also be splinepy.Spline
+def make_showable(obj: GustafBase, as_dict: bool = False, **kwargs):
     """Generates a vedo obj based on `kind` attribute from given obj, as well
     as show_options.
 
@@ -411,7 +423,9 @@ def make_showable(obj, as_dict=False, **kwargs):
 
 # possibly relocate, is this actually used?
 # could not find any usage in this repo
-def interpolate_vedo_dictcam(cameras, resolutions, spline_degree=1):
+def interpolate_vedo_dictcam(
+    cameras: list[dict[str, Any]], resolutions: int, spline_degree: int = 1
+):
     """Interpolate between vedo dict cameras.
 
     Parameters

gustaf/vertices.py

@@ -20,12 +20,15 @@
 from gustaf.helpers.options import Option as _Option
 
 if TYPE_CHECKING:
+    import sys
     from typing import Any
 
-    from gustaf.edges import EdgesShowOption as _EdgesShowOption
-    from gustaf.faces import FacesShowOption as _FacesShowOption
+    if sys.version_info >= (3, 10):
+        from typing import Self
+    else:
+        from typing_extensions import Self
+
     from gustaf.helpers.data import Unique2DFloats as _Unique2DFloats
-    from gustaf.volumes import VolumesShowOption as _VolumesShowOption
 
 
 class VerticesShowOption(_helpers.options.ShowOption):
@@ -226,9 +229,7 @@ def vertex_data(self) -> _VertexData:
         return self._vertex_data
 
     @property
-    def show_options(
-        self,
-    ) -> _EdgesShowOption | _FacesShowOption | _VolumesShowOption:
+    def show_options(self) -> _helpers.options.ShowOption:
         """
         Returns a show option manager for this object. Behaves similar to
         dict.
@@ -262,7 +263,7 @@ def whatami(self) -> str:
 
     @_helpers.data.ComputedMeshData.depends_on(["vertices"])
     def unique_vertices(
-        self, tolerance: Any | None = None, **kwargs: Any
+        self, tolerance: float | None = None, **kwargs: Any
     ) -> _Unique2DFloats:
         """Returns a namedtuple that holds unique vertices info. Unique here
         means "close-enough-within-tolerance".
@@ -343,7 +344,7 @@ def bounds_diagonal_norm(self) -> float:
 
     def update_vertices(
         self, mask: _np.ndarray, inverse: _np.ndarray | None = None
-    ) -> Any:
+    ) -> Vertices:
         """Update vertices with a mask. In other words, keeps only masked
         vertices. Adapted from `github.com/mikedh/trimesh`. Updates
         connectivity accordingly too.
@@ -394,14 +395,14 @@ def update_vertices(
         vertices = vertices[mask]
 
         def update_vertex_data(
-            obj: Any, m: _np.ndarray, vertex_data: dict
+            obj: Vertices, mask: _np.ndarray, vertex_data: dict
         ) -> Any:
             """apply mask to vertex data if there's any."""
             new_data = _helpers.data.VertexData(obj)
 
             for key, values in vertex_data.items():
                 # should work, since this is called after updating vertices
-                new_data[key] = values[m]
+                new_data[key] = values[mask]
 
             obj._vertex_data = new_data
 
@@ -434,7 +435,7 @@ def select_vertices(self, ranges: list[list[float]]) -> _np.ndarray:
         """
         return _utils.arr.select_with_ranges(self.vertices, ranges)
 
-    def remove_vertices(self, ids):
+    def remove_vertices(self, ids: _np.ndarray) -> Vertices:
         """Removes vertices with given vertex ids.
 
         Parameters
@@ -451,8 +452,8 @@ def remove_vertices(self, ids):
         return self.update_vertices(mask)
 
     def merge_vertices(
-        self, tolerance: Any | None = None, **kwargs: Any
-    ) -> Any:
+        self, tolerance: float | None = None, **kwargs: Any
+    ) -> Vertices:
         """Based on unique vertices, merge vertices if it is mergeable.
 
         Parameters
@@ -503,7 +504,7 @@ def show(self, **kwargs):
         """
         return _show.show(self, **kwargs)
 
-    def copy(self) -> Any:
+    def copy(self) -> Vertices:
         """Returns deepcopy of self.
 
         Parameters
@@ -525,7 +526,7 @@ def copy(self) -> Any:
         return copied
 
     @classmethod
-    def concat(cls, *instances: Any) -> Any:
+    def concat(cls, *instances: Vertices) -> Vertices:
         """Sequentially put them together to make one object.
 
         Parameters
@@ -590,7 +591,7 @@ def is_concatable(inst: Any) -> bool:
         else:
             return Vertices(vertices=_np.vstack(vertices))
 
-    def __add__(self, to_add):
+    def __add__(self, to_add: Self) -> Self:
         """Concat in form of +.
 
         Parameters