CAP-ADD: add type checker mypy + refactoring for precommit check pass

Author: 9and3

doc/contribute.md

@@ -1,13 +1,17 @@
 (contrib_guide)=
 # Contribute
 
-We value all contributions to diffCheck, whether they are bug reports, feature requests, or pull requests. We have a few guidelines to ensure that the process is as smooth as possible.
+We welcome pull requests from everyone. Please have a look at the [issue](https://github.com/diffCheckOrg/diffCheck/issues) list to see if there is something you can help with. If you have a new feature in mind, please open an issue to discuss it first.
 
-## How to contribute
+## Code quality
 
-We welcome pull requests from everyone. Please have a look at the [issue](https://github.com/diffCheckOrg/diffCheck/issues) list to see if there is something you can help with. If you have a new feature in mind, please open an issue to discuss it first.
+We run [mypy](https://mypy.readthedocs.io/en/stable/index.html) and [] on pre-commit hooks to ensure code quality. Please make sure to run the following commands before submitting a pull request:
 
-To contribute, you will need to install your developer's environment to build the project. You can find the instructions in the [development installation guide](dev_documentation).
+```console
+pre-commit run --all-files
+```
+
+## How to contribute
 
 Next, fall the following steps:
 
@@ -24,4 +28,10 @@ Next, fall the following steps:
 
     ```console
     git checkout -b my-feature
-    ``` 
+    ```
+
+4. Add the diffCheck repository as a remote for convinience:
+
+    ```console
+    git remote add upstream https://github.com/diffCheckOrg/diffCheck
+    ```

environment.yml

@@ -28,7 +28,7 @@ def main(
         if manifest_crt_version is not None:
             if version <= manifest_crt_version:
                 print(f"Version {version} is equal or smaller than the current version {manifest_crt_version}. Please provide a version number bigger than the current one.")
-                return
+                return False
         else:
             print("Could not find the current version in the manifest file.")
             sys.exit(1)

invokes/versionize.py

@@ -0,0 +1,27 @@
+[tool.mypy]
+warn_return_any = true
+warn_unused_configs = true
+exclude = [
+    "deps",
+    "src/gh/components/*",
+    "src/gh/diffCheck/setup.py",
+    "temp",
+    "doc"
+]
+
+[[tool.mypy.overrides]]
+module = [
+    "Rhino.*",
+    "rhinoscriptsyntax.*",
+    "scriptcontext.*",
+    "Grasshopper.*",
+    "System.*",
+    "GH_IO.*",
+    "clr.*",
+    "diffcheck_bindings"
+]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "pefile"
+ignore_missing_imports = true

pyproject.toml

@@ -9,9 +9,12 @@
 import scriptcontext as sc
 import numpy as np
 
-from diffCheck import diffcheck_bindings
+import typing
+from typing import List, Dict, Any
 
-def test_bindings() -> bool:
+from diffCheck import diffcheck_bindings  # type: ignore
+
+def test_bindings() -> Any:
     """
         Test the bindings import.
 

src/gh/diffCheck/diffCheck/df_cvt_bindings.py

@@ -4,7 +4,7 @@
 """
 
 import numpy as np
-from diffCheck import diffcheck_bindings
+from diffCheck import diffcheck_bindings  # type: ignore
 import Rhino.Geometry as rg
 
 

src/gh/diffCheck/diffCheck/df_error_estimation.py

@@ -1,7 +1,11 @@
 import os
 from datetime import datetime
 from dataclasses import dataclass
+
 import typing
+from typing import Optional
+from typing import List, Dict, Any
+
 import uuid
 
 import Rhino
@@ -69,7 +73,7 @@ class DFFace:
 
     # just as breps a first outer loop and then inner loops of DFVertices
     all_loops: typing.List[typing.List[DFVertex]]
-    joint_id: int = None
+    joint_id: Optional[int] = None
 
     def __post_init__(self):
         if len(self.all_loops[0]) < 3:
@@ -106,7 +110,9 @@ def __eq__(self, other):
         return False
 
     @classmethod
-    def from_brep_face(cls, brep_face: rg.BrepFace, joint_id: int = None):
+    def from_brep_face(cls,
+        brep_face: rg.BrepFace,
+        joint_id: Optional[int] = None):
         """
         Create a DFFace from a Rhino Brep face
 
@@ -115,6 +121,7 @@ def from_brep_face(cls, brep_face: rg.BrepFace, joint_id: int = None):
         :return face: The DFFace object
         """
         all_loops = []
+        df_face: DFFace = cls([], joint_id)
 
         if brep_face.IsCylinder():
             cls.is_cylinder = True

src/gh/diffCheck/diffCheck/df_geometries.py

@@ -63,7 +63,7 @@ def _get_lowest_brep_vertex(brep) -> Rhino.Geometry.Point3d:
 
     # find the longest edge of the brep
     edges = brep.Edges
-    longest_edge = None
+    longest_edge: Rhino.Geometry.Curve = None
     longest_edge_length = 0
     for edge in edges:
         if edge.GetLength() > longest_edge_length:
@@ -73,7 +73,7 @@ def _get_lowest_brep_vertex(brep) -> Rhino.Geometry.Point3d:
     # find biggest face
     face_indices = longest_edge.AdjacentFaces()
     faces = [brep.Faces[face_index] for face_index in face_indices]
-    biggest_face = None
+    biggest_face: Rhino.Geometry.BrepFace = None
     biggest_face_area = 0
     for face in faces:
         if rg.AreaMassProperties.Compute(face).Area > biggest_face_area:

src/gh/diffCheck/diffCheck/df_transformations.py

@@ -109,7 +109,7 @@ def compute_ordered_vertices(brep_face) -> typing.List[Rhino.Geometry.Point3d]:
     edges = brep_face.DuplicateEdgeCurves()
     edges = list(set(edges))
 
-    edges_sorted = []
+    edges_sorted: list[Rhino.Geometry.Curve] = []
     while len(edges) > 0:
         if len(edges_sorted) == 0:
             edges_sorted.append(edges[0])