remove unused and update docstrings

Author: tomvanmele

src/compas_gmsh/__init__.py

@@ -1,8 +1,4 @@
-from __future__ import print_function
-
 import os
-import compas
-
 
 __author__ = ["tom van mele"]
 __copyright__ = "Block Research Group - ETH Zurich"
@@ -18,26 +14,4 @@
 DOCS = os.path.abspath(os.path.join(HOME, "docs"))
 TEMP = os.path.abspath(os.path.join(HOME, "temp"))
 
-# Check if package is installed from git
-# If that's the case, try to append the current head's hash to __version__
-try:
-    git_head_file = compas._os.absjoin(HOME, ".git", "HEAD")
-
-    if os.path.exists(git_head_file):
-        # git head file contains one line that looks like this:
-        # ref: refs/heads/master
-        with open(git_head_file, "r") as git_head:
-            _, ref_path = git_head.read().strip().split(" ")
-            ref_path = ref_path.split("/")
-
-            git_head_refs_file = compas._os.absjoin(HOME, ".git", *ref_path)
-
-        if os.path.exists(git_head_refs_file):
-            with open(git_head_refs_file, "r") as git_head_ref:
-                git_commit = git_head_ref.read().strip()
-                __version__ += "-" + git_commit[:8]
-
-except Exception:
-    pass
-
 __all__ = ["HOME", "DATA", "DOCS", "TEMP"]

src/compas_gmsh/conversions/__init__.py

@@ -1,4 +1,6 @@
-from .model import Model  # noqa: F401
-from .shape import ShapeModel  # noqa: F401
-from .mesh import MeshModel  # noqa: F401
-from .csg import CSGModel  # noqa: F401
+# ruff: noqa: F401
+
+from .model import Model
+from .shape import ShapeModel
+from .mesh import MeshModel
+from .csg import CSGModel

src/compas_gmsh/models/__init__.py

@@ -1,6 +1,3 @@
-from typing import List
-from typing import Tuple
-
 import compas.geometry
 from compas.geometry import Box
 from compas.geometry import Cylinder
@@ -9,7 +6,7 @@
 from .model import Model
 
 
-def add_cylinder(self, cylinder: Cylinder) -> Tuple[int, int]:
+def add_cylinder(self, cylinder: Cylinder) -> tuple[int, int]:
     """Add a cylinder to the model."""
     H = cylinder.height
     R = cylinder.radius
@@ -23,15 +20,15 @@ def add_cylinder(self, cylinder: Cylinder) -> Tuple[int, int]:
     return 3, tag
 
 
-def add_sphere(self, sphere: Sphere) -> Tuple[int, int]:
+def add_sphere(self, sphere: Sphere) -> tuple[int, int]:
     """Add a sphere to the model."""
-    x, y, z = sphere.point
+    x, y, z = sphere.base
     R = sphere.radius
     tag = self.occ.addSphere(x, y, z, R)
     return 3, tag
 
 
-def add_box(self, box: Box) -> Tuple[int, int]:
+def add_box(self, box: Box) -> tuple[int, int]:
     """Add a box to the model."""
     x0, y0, z0 = box.frame.point
     x = x0 - 0.5 * box.xsize
@@ -49,17 +46,17 @@ class CSGModel(Model):
 
     Parameters
     ----------
-    tree : dict
+    tree
         The CSG tree as a dictionary mapping operations to operands.
         The operations have to be one of ``{"union", "intersection", "difference"}``.
         The operands have to be lists of shapes or lists of dicts that are CSG trees themselves.
         At every level of the tree, there can be only one operation.
-    name : str
+    name
         The name of the model.
 
     Attributes
     ----------
-    tree : dict
+    tree
         The CSG tree as a dictionary mapping operations to operands.
         The operations have to be one of ``{"union", "intersection", "difference"}``.
         The operands have to be lists of shapes or lists of dicts that are CSG trees themselves.
@@ -69,7 +66,7 @@ class CSGModel(Model):
 
     def __init__(self, tree: dict, name: str, **kwargs) -> None:
         super().__init__(name, **kwargs)
-        self._tree = None
+        self._tree = {}
         self.tree = tree
 
     @property
@@ -94,13 +91,13 @@ def check(tree: dict) -> None:
         else:
             self._tree = tree
 
-    def add(self, shape: compas.geometry.Shape) -> Tuple[int, int]:
+    def add(self, shape: compas.geometry.Shape) -> tuple[int, int]:
         """
         Add a shape to the underlying OCC model.
 
         Parameters
         ----------
-        shape : :class:`compas.geometry.Shape`
+        shape
             A geometric shape.
 
         Returns
@@ -125,7 +122,7 @@ def compute_tree(self) -> None:
 
         """
 
-        def walk(tree: dict) -> List[Tuple[int, int]]:
+        def walk(tree: dict) -> list[tuple[int, int]]:
             operation = next(iter(tree))
             operands = tree[operation]
 

src/compas_gmsh/models/csg.py

@@ -26,16 +26,16 @@ def from_mesh(
 
         Parameters
         ----------
-        mesh : :class:`Mesh`
+        mesh
             A COMPAS mesh.
-        name : str, optional
+        name
             The name of the model.
-        target_length : float, optional
+        target_length
             Target value for the length of the mesh edges.
 
         Returns
         -------
-        :class:`MeshModel`
+        MeshModel
 
         """
         model: MeshModel = cls(name)
@@ -69,7 +69,7 @@ def generate_mesh(self, dim: int = 2) -> None:
 
         Parameters
         ----------
-        dim : int, optional
+        dim
             The dimension of the mesh.
 
         Returns
@@ -93,7 +93,7 @@ def find_point_at_vertex(self, vertex: int) -> int:
 
         Parameters
         ----------
-        vertex : int
+        vertex
             A vertex of the input mesh.
 
         Returns
@@ -110,9 +110,9 @@ def mesh_targetlength_at_vertex(self, vertex: int, target: float) -> None:
 
         Parameters
         ----------
-        vertex : int
+        vertex
             The vertex identifier.
-        target : float
+        target
             The target length value.
 
         Returns

src/compas_gmsh/models/mesh.py

@@ -1,6 +1,3 @@
-from typing import List
-from typing import Tuple
-
 from compas.geometry import Box
 from compas.geometry import Cylinder
 from compas.geometry import Sphere
@@ -13,7 +10,7 @@ class ShapeModel(Model):
     Model for shape combinations.
     """
 
-    def add_cylinder(self, cylinder: Cylinder) -> Tuple[int, int]:
+    def add_cylinder(self, cylinder: Cylinder) -> tuple[int, int]:
         """Add a cylinder to the model."""
         H = cylinder.height
         R = cylinder.radius
@@ -26,14 +23,14 @@ def add_cylinder(self, cylinder: Cylinder) -> Tuple[int, int]:
         tag = self.occ.add_cylinder(x0, y0, z0, dx, dy, dz, R)
         return 3, tag
 
-    def add_sphere(self, sphere: Sphere) -> Tuple[int, int]:
+    def add_sphere(self, sphere: Sphere) -> tuple[int, int]:
         """Add a sphere to the model."""
         x, y, z = sphere.frame.point
         R = sphere.radius
         tag = self.occ.add_sphere(x, y, z, R)
         return 3, tag
 
-    def add_box(self, box: Box) -> Tuple[int, int]:
+    def add_box(self, box: Box) -> tuple[int, int]:
         """Add a box to the model."""
         x0, y0, z0 = box.frame.point
         x = x0 - 0.5 * box.xsize
@@ -44,24 +41,24 @@ def add_box(self, box: Box) -> Tuple[int, int]:
 
     def boolean_intersection(
         self,
-        A: List[Tuple[int, int]],
-        B: List[Tuple[int, int]],
+        A: list[tuple[int, int]],
+        B: list[tuple[int, int]],
         remove_objects: bool = True,
         remove_tools: bool = True,
-    ) -> List[Tuple[int, int]]:
+    ) -> list[tuple[int, int]]:
         """
         Boolean intersection of two sets of shapes.
 
         Parameters
         ----------
-        A : list of tuple
+        A
             The *dimtags* of the *object* shapes.
-        B : tuple
+        B
             The *dimtags* of the *tool* shapes.
 
         Returns
         -------
-        list of tuple
+        list[tuple[int, int]]
             The dimtags of the resulting shapes.
 
         Notes
@@ -76,11 +73,11 @@ def boolean_intersection(
 
     def boolean_union(
         self,
-        A: List[Tuple[int, int]],
-        B: List[Tuple[int, int]],
+        A: list[tuple[int, int]],
+        B: list[tuple[int, int]],
         remove_objects: bool = True,
         remove_tools: bool = True,
-    ) -> List[Tuple[int, int]]:
+    ) -> list[tuple[int, int]]:
         """
         Boolean union of two sets of shapes.
 
@@ -93,7 +90,7 @@ def boolean_union(
 
         Returns
         -------
-        list of tuple
+        list[tuple[int, int]]
             The dimtags of the resulting shapes.
 
         Notes
@@ -108,11 +105,11 @@ def boolean_union(
 
     def boolean_difference(
         self,
-        A: List[Tuple[int, int]],
-        B: List[Tuple[int, int]],
+        A: list[tuple[int, int]],
+        B: list[tuple[int, int]],
         remove_objects: bool = True,
         remove_tools: bool = True,
-    ) -> List[Tuple[int, int]]:
+    ) -> list[tuple[int, int]]:
         """
         Boolean difference of two sets of shapes.
 
@@ -125,7 +122,7 @@ def boolean_difference(
 
         Returns
         -------
-        list of tuple
+        list[tuple[int, int]]
             The dimtags of the resulting shapes.
 
         Notes
@@ -140,11 +137,11 @@ def boolean_difference(
 
     def boolean_fragment(
         self,
-        A: List[Tuple[int, int]],
-        B: List[Tuple[int, int]],
+        A: list[tuple[int, int]],
+        B: list[tuple[int, int]],
         remove_objects: bool = True,
         remove_tools: bool = True,
-    ) -> List[Tuple[int, int]]:
+    ) -> list[tuple[int, int]]:
         """
         Boolean fragment of two sets of shapes.
 
@@ -157,7 +154,7 @@ def boolean_fragment(
 
         Returns
         -------
-        list of tuple
+        list[tuple[int, int]]
             The dimtags of the resulting shapes.
 
         Notes

src/compas_gmsh/models/shape.py

@@ -129,15 +129,15 @@ def algorithm(self, algo: MeshAlgorithm) -> None:
 
     @property
     def lmin(self) -> float:
-        gmsh.option.get_number("Mesh.CharacteristicLengthMin")
+        return gmsh.option.get_number("Mesh.CharacteristicLengthMin")
 
     @lmin.setter
     def lmin(self, value: float):
         gmsh.option.set_number("Mesh.CharacteristicLengthMin", value)
 
     @property
     def lmax(self) -> float:
-        gmsh.option.get_number("Mesh.CharacteristicLengthMax")
+        return gmsh.option.get_number("Mesh.CharacteristicLengthMax")
 
     @lmax.setter
     def lmax(self, value: float):