use basedpyright instead of mypy for typechecking

Author: Ruudjhuu

.github/workflows/linting.yml

@@ -15,14 +15,17 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v7
       - name: Set up Python
-        run: uv python install
+        run: uv python install && uv venv
       - name: Ruff lint
         run: |
           uvx ruff check
       - name: Vulture
         if: success() || failure()
         run: |
           uvx vulture ./src --min-confidence 61
+      - name: basedpyright
+        if: success() || failure()
+        run: uvx basedpyright --warnings
       - name: Ruff format
         if: success() || failure()
         run: |

docs/assets/image_gen.py

@@ -8,7 +8,7 @@
 from unittest.mock import MagicMock
 
 import build123d
-from build123d import Box, Part
+from build123d import Box, Compound, Part
 
 from gridfinity_build123d import (
     Base,
@@ -50,17 +50,16 @@ class CameraPosition(Enum):
 
     @staticmethod
     def pos_to_str(pos: CameraPosition) -> str:
-        if pos == CameraPosition.CAMERA_TOP:
-            return "0,0,0,55,0,25,0"
-        if pos == CameraPosition.CAMERA_BOT:
-            return "0,0,0,125,0,25,0"
-        msg = "Unknown camera position"
-        raise ValueError(msg)
+        match pos:
+            case CameraPosition.CAMERA_TOP:
+                return "0,0,0,55,0,25,0"
+            case CameraPosition.CAMERA_BOT:
+                return "0,0,0,125,0,25,0"
 
 
 class Convert:
     @staticmethod
-    def part_to_png(part: Part, file_name: str, camera_pos: CameraPosition) -> None:
+    def part_to_png(part: Compound, file_name: str, camera_pos: CameraPosition) -> None:
         with TemporaryDirectory() as tmp_dir:
             Convert._part_to_png(part, Path(tmp_dir), file_name, camera_pos)
 
@@ -78,7 +77,7 @@ def parts_to_gif(
                     str(Path(tmp_dir).joinpath(f"{idx}".zfill(3))),
                     camera_pos,
                 )
-            check_call(
+            _ = check_call(
                 [
                     "/usr/bin/convert",
                     "-delay",
@@ -94,18 +93,18 @@ def parts_to_gif(
 
     @staticmethod
     def _part_to_png(
-        part: Part,
+        part: Compound,
         work_dir: Path,
         file_name: str,
         camera_pos: CameraPosition,
     ) -> None:
         tmp_stl = work_dir.joinpath("tmp.stl")
         tmp_scad = work_dir.joinpath("tmp.scad")
-        build123d.export_stl(part, str(tmp_stl))
+        _ = build123d.export_stl(part, str(tmp_stl))  # pyright: ignore[reportUnknownMemberType]
         with tmp_scad.open("w") as file:
-            file.write(f'import("{tmp_stl}");\n')
+            _ = file.write(f'import("{tmp_stl}");\n')
 
-        check_call(
+        _ = check_call(
             [
                 "/usr/bin/openscad",
                 "--autocenter",

pyproject.toml

@@ -10,7 +10,6 @@ requires-python = ">=3.10"
 
 [dependency-groups]
 dev = [
-  "mypy",
   "coverage",
   "vulture",
   "ocp_vscode",
@@ -21,6 +20,7 @@ dev = [
   "sphinx-rtd-theme",
   "sphinx_design",
   "debugpy>=1.8.20",
+  "basedpyright>=1.38.2",
 ]
 
 [build-system]
@@ -63,3 +63,6 @@ ignore-decorators = ['inherit_docstring']
 
 [tool.ruff.lint.pycodestyle]
 max-line-length = 101
+
+[tool.basedpyright]
+ignore = ["tests"]

src/gridfinity_build123d/base.py

@@ -15,7 +15,7 @@
     Mode,
     Rectangle,
     RotationLike,
-    add,
+    add,  # pyright: ignore[reportUnknownVariableType]
     extrude,
 )
 
@@ -60,7 +60,7 @@ def __init__(
 
         with BuildPart() as base:
             base_block = BaseBlock(features=features, mode=Mode.PRIVATE)
-            Utils.place_by_grid(
+            _ = Utils.place_by_grid(
                 base_block,
                 grid,
                 width=gridfinity_standard.grid.size,
@@ -71,7 +71,7 @@ def __init__(
             z_top = top_face_1.bounding_box().min.Z
 
             with Locations((0, 0, z_top)):
-                Utils.create_bin_platform(
+                _ = Utils.create_bin_platform(
                     grid,
                     align=(
                         Align.CENTER,
@@ -80,6 +80,10 @@ def __init__(
                     ),
                 )
 
+        if not base.part:
+            msg = "Base is empty"
+            raise RuntimeError(msg)
+
         super().__init__(base.part, rotation, align, mode)
 
 
@@ -107,7 +111,7 @@ def __init__(
                 object. Defaults to None.
             mode (Mode, optional): Combination mode. Defaults to Mode.ADD.
         """
-        grid = []
+        grid: list[list[bool]] = []
         for _ in range(grid_y):
             grid += [[True] * grid_x]
         super().__init__(grid, features, rotation, align, mode)
@@ -142,14 +146,18 @@ def __init__(
         features = features if isinstance(features, Iterable) else [features]
 
         with BuildPart() as baseblock:
-            Utils.create_profile_block(
+            _ = Utils.create_profile_block(
                 StackProfile.ProfileType.BIN,
                 gridfinity_standard.stacking_lip.offset,
             )
 
             for feature in features:
                 feature.apply(baseblock)
 
+        if not baseblock.part:
+            msg = "Part is empty"
+            raise RuntimeError(msg)
+
         super().__init__(baseblock.part, rotation, align, mode)
 
 
@@ -186,16 +194,20 @@ def __init__(
         base_block = BaseBlock(features=[], rotation=rotation, mode=Mode.ADD)
 
         with BuildPart() as baseblock_platform:
-            add(base_block)
+            _ = add(base_block)
 
             with BuildSketch(baseblock_platform.faces().sort_by(Axis.Z)[-1]) as rect2:
-                Rectangle(gridfinity_standard.grid.size, gridfinity_standard.grid.size)
-            extrude(
+                _ = Rectangle(gridfinity_standard.grid.size, gridfinity_standard.grid.size)
+            _ = extrude(
                 to_extrude=rect2.sketch,
                 amount=gridfinity_standard.bottom.platform_height,
             )
 
             for feature in features:
                 feature.apply(baseblock_platform)
 
+        if not baseblock_platform.part:
+            msg = "Part is empty"
+            raise RuntimeError(msg)
+
         super().__init__(baseblock_platform.part, rotation, align, mode)

src/gridfinity_build123d/baseplate.py

@@ -5,9 +5,10 @@
 
 from __future__ import annotations
 
+from abc import ABC
 from collections.abc import Iterable
 from math import isclose
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, override
 
 from build123d import (
     Align,
@@ -17,11 +18,13 @@
     BuildLine,
     BuildPart,
     BuildSketch,
+    Edge,
     Line,
     Mode,
     Plane,
     RotationLike,
-    add,
+    Shape,
+    add,  # pyright: ignore[reportUnknownVariableType]
     extrude,
     fillet,
     make_face,
@@ -34,7 +37,7 @@
     from gridfinity_build123d.features import Feature
 
 
-class BasePlateBlock(ObjectCreate):
+class BasePlateBlock(ObjectCreate, ABC):
     """Single base plate block used to construct a bigger baseplate."""
 
     def __init__(
@@ -50,7 +53,7 @@ def __init__(
         if not features:
             features = []
 
-        self.features = features if isinstance(features, Iterable) else [features]
+        self.features: list[Feature] = features if isinstance(features, Iterable) else [features]
 
 
 class BasePlateBlockFrame(BasePlateBlock):
@@ -61,6 +64,7 @@ class BasePlateBlockFrame(BasePlateBlock):
             features. Defaults to None.
     """
 
+    @override
     def create_obj(
         self,
         rotation: RotationLike = (0, 0, 0),
@@ -69,20 +73,28 @@ def create_obj(
     ) -> BasePartObject:
         """Overwrites BasePlateBlock.create_obj."""
         with BuildPart() as block:
-            Utils.create_profile_block(StackProfile.ProfileType.PLATE)
+            _ = Utils.create_profile_block(StackProfile.ProfileType.PLATE)
+
+        if not block.part:
+            msg = "block is empty"
+            raise RuntimeError(msg)
 
         with BuildPart() as part:
-            Box(
+            _ = Box(
                 42,
                 42,
                 block.part.bounding_box().size.Z,
                 align=(Align.CENTER, Align.CENTER, Align.MIN),
             )
-            add(block.part, mode=Mode.SUBTRACT)
+            _ = add(block.part, mode=Mode.SUBTRACT)
 
             for feature in self.features:
                 feature.apply(part)
 
+        if not part.part:
+            msg = "Part is empty"
+            raise RuntimeError(msg)
+
         return BasePartObject(part.part, rotation, align, mode)
 
 
@@ -102,9 +114,10 @@ def __init__(
                 features. Defaults to None.
         """
         super().__init__(features)
-        self.bottom_height = bottom_height
+        self.bottom_height: float = bottom_height
 
-    def create_obj(  # noqa: D102
+    @override
+    def create_obj(
         self,
         rotation: RotationLike = (0, 0, 0),
         align: Align | tuple[Align, Align, Align] | None = None,
@@ -114,21 +127,26 @@ def create_obj(  # noqa: D102
             frame = BasePlateBlockFrame().create_obj(mode=Mode.PRIVATE)
             with BuildSketch():
                 bot_face = frame.faces().sort_by(Axis.Z)[0]
-                make_face(bot_face.outer_wire())
-            extrude(amount=self.bottom_height, dir=(0, 0, -1))
+                _ = make_face(bot_face.outer_wire().edges())
+            _ = extrude(amount=self.bottom_height, dir=(0, 0, -1))
 
             for feature in self.features:
                 feature.apply(part)
 
-            add(frame)
+            _ = add(frame)
+
+        if not part.part:
+            msg = "Part is empty"
+            raise RuntimeError(msg)
 
         return BasePartObject(part.part, rotation, align, mode)
 
 
 class BasePlateBlockSkeleton(BasePlateBlockFull):
     """Placeholder for future skeletonized baseplate."""
 
-    def create_obj(  # noqa: D102
+    @override
+    def create_obj(
         self,
         rotation: RotationLike = (0, 0, 0),
         align: Align | tuple[Align, Align, Align] | None = None,
@@ -141,20 +159,25 @@ def create_obj(  # noqa: D102
         length_l = length / 2
 
         with BuildPart() as part:
-            super().create_obj()
+            _ = super().create_obj()
             with BuildSketch():
                 with BuildLine() as line:
                     ln1 = Line((0, length_l), (length_s, length_l))
                     ln2 = Line(ln1 @ 1, (length_s, length_s))
                     ln3 = Line(ln2 @ 1, (length_l, length_s))
-                    Line(ln3 @ 1, (length_l, 0))
-                    vertex = line.vertices().sort_by_distance((length / 4, length / 4))[0]
-                    fillet(vertex, radius)
-                    mirror(about=Plane.XZ)
-                    mirror(about=Plane.YZ)
-
-                make_face()
-            extrude(amount=-self.bottom_height, mode=Mode.SUBTRACT)
+                    _ = Line(ln3 @ 1, (length_l, 0))
+                    vertex = line.vertices().sort_by_distance((length / 4, length / 4))[0]  # pyright: ignore[reportUnknownMemberType]
+                    _ = fillet(vertex, radius)
+                    _ = mirror(about=Plane.XZ)
+                    _ = mirror(about=Plane.YZ)
+
+                _ = make_face()
+            _ = extrude(amount=-self.bottom_height, mode=Mode.SUBTRACT)
+
+        if not part.part:
+            msg = "Part is empty"
+            raise RuntimeError(msg)
+
         return BasePartObject(part.part, rotation, align, mode)
 
 
@@ -190,19 +213,27 @@ def __init__(
         if not features:
             features = []
 
-        self.features = features if isinstance(features, Iterable) else [features]
+        self.features: list[Feature] = features if isinstance(features, Iterable) else [features]
 
         with BuildPart() as part:
-            Utils.place_by_grid(baseplate_block.create_obj(mode=Mode.PRIVATE), grid)
+            _ = Utils.place_by_grid(baseplate_block.create_obj(mode=Mode.PRIVATE), grid)
+
+            if not part.part:
+                msg = "Part is empty"
+                raise RuntimeError(msg)
 
             z_height = part.part.bounding_box().size.Z
 
-            wires = (
-                part.edges()
-                .filter_by(Axis.Z)
-                .filter_by(lambda edge: isclose(edge.length, z_height))
-            )
-            fillet(wires, 4)
+            def edge_filter(shape: Shape[Edge]) -> bool:
+                inner_edge = shape.edge()
+                if not inner_edge:
+                    msg = "Edge is empty"
+                    raise RuntimeError(msg)
+
+                return isclose(inner_edge.length, z_height)
+
+            wires = part.edges().filter_by(Axis.Z).filter_by(edge_filter)
+            _ = fillet(wires, 4)
 
             for feature in self.features:
                 feature.apply(part)