Add a --debug-build flag to build ty and pyrefly in debug mode (#214)

AlexWaygood · web-flow · commit 0ee3d6330add · 2025-09-24T12:22:45.000-07:00
diff --git a/mypy_primer/globals.py b/mypy_primer/globals.py
@@ -17,6 +17,7 @@ class _Args:
     repo: str | None
     type_checker: str
     mypyc_compile_level: int | None
+    debug_build: bool
 
     custom_typeshed_repo: str
     new_typeshed: str | None
@@ -91,6 +92,11 @@ def parse_options(argv: list[str]) -> _Args:
             "then fall back to github)"
         ),
     )
+    type_checker_group.add_argument(
+        "--debug-build",
+        action="store_true",
+        help="build the type checker in debug mode (only relevant for pyrefly/ty)",
+    )
     type_checker_group.add_argument(
         "--mypyc-compile-level",
         default=None,
@@ -222,8 +228,16 @@ def parse_options(argv: list[str]) -> _Args:
     primer_group.add_argument("--clear", action="store_true", help="delete repos and venvs")
 
     ret = _Args(**vars(parser.parse_args(argv)))
+
     if (ret.num_shards is not None) != (ret.shard_index is not None):
         parser.error("--shard-index and --num-shards must be used together")
+    if ret.type_checker != "mypy" and ret.mypyc_compile_level is not None:
+        parser.error("--mypyc-compile-level can only be used with --type-checker=mypy")
+    if ret.debug_build and ret.type_checker not in {"pyrefly", "ty"}:
+        parser.error(
+            "`--debug-build` can only be used with `--type-checker=pyrefly` or `--type-checker=ty`"
+        )
+
     return ret
 
 
diff --git a/mypy_primer/main.py b/mypy_primer/main.py
@@ -19,6 +19,7 @@
 from mypy_primer.model import Project, TypeCheckResult
 from mypy_primer.projects import get_projects
 from mypy_primer.type_checker import (
+    RustBuildMode,
     setup_mypy,
     setup_pyrefly,
     setup_pyright,
@@ -48,10 +49,17 @@ def setup_type_checker(
         kwargs = {"repo": ARGS.repo}
     elif ARGS.type_checker == "ty":
         setup_fn = setup_ty
-        kwargs = {"repo": ARGS.repo}
+        kwargs = {
+            "repo": ARGS.repo,
+            "build_mode": (RustBuildMode.DEBUG if ARGS.debug_build else RustBuildMode.RELEASE),
+        }
     elif ARGS.type_checker == "pyrefly":
         setup_fn = setup_pyrefly
-        kwargs = {"repo": ARGS.repo, "typeshed_dir": typeshed_dir}
+        kwargs = {
+            "repo": ARGS.repo,
+            "typeshed_dir": typeshed_dir,
+            "build_mode": (RustBuildMode.DEBUG if ARGS.debug_build else RustBuildMode.RELEASE),
+        }
     else:
         raise ValueError(f"Unknown type checker {ARGS.type_checker}")
 
diff --git a/mypy_primer/type_checker.py b/mypy_primer/type_checker.py
@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import enum
 import os
 import shutil
 import subprocess
@@ -116,6 +117,7 @@ async def setup_ty(
     ty_dir: Path,
     revision_like: RevisionLike,
     *,
+    build_mode: RustBuildMode,
     repo: str | None,
 ) -> Path:
     ty_dir.mkdir(parents=True, exist_ok=True)
@@ -131,7 +133,7 @@ async def setup_ty(
 
         try:
             await run(
-                ["cargo", "build", "--bin", "ty", "--release"],
+                ["cargo", "build", "--bin", "ty", *build_mode.flags()],
                 cwd=repo_dir,
                 env=env,
                 output=True,
@@ -142,7 +144,7 @@ async def setup_ty(
             print(e.stderr, file=sys.stderr)
             raise e
 
-    ty_exe = cargo_target_dir / "release" / "ty"
+    ty_exe = cargo_target_dir / build_mode.artifact_directory() / "ty"
     assert ty_exe.exists()
     return ty_exe
 
@@ -151,6 +153,7 @@ async def setup_pyrefly(
     pyrefly_dir: Path,
     revision_like: RevisionLike,
     *,
+    build_mode: RustBuildMode,
     repo: str | None,
     typeshed_dir: Path | None,
 ) -> Path:
@@ -169,7 +172,7 @@ async def setup_pyrefly(
     if not os.environ.get("MYPY_PRIMER_NO_REBUILD", False):
         try:
             await run(
-                ["cargo", "build", "--release"],
+                ["cargo", "build", *build_mode.flags()],
                 cwd=repo_dir / "pyrefly",
                 env=env,
                 output=True,
@@ -180,7 +183,7 @@ async def setup_pyrefly(
             print(e.stderr, file=sys.stderr)
             raise e
 
-    pyrefly_exe = repo_dir / "target" / "release" / "pyrefly"
+    pyrefly_exe = repo_dir / "target" / build_mode.artifact_directory() / "pyrefly"
     assert pyrefly_exe.exists()
     return pyrefly_exe
 
@@ -190,3 +193,20 @@ async def setup_typeshed(parent_dir: Path, *, repo: str, revision_like: Revision
         shutil.rmtree(parent_dir)
     parent_dir.mkdir(exist_ok=True)
     return await ensure_repo_at_revision(repo, parent_dir, revision_like)
+
+
+class RustBuildMode(enum.Enum):
+    RELEASE = "release"
+    DEBUG = "debug"
+
+    def flags(self) -> list[str]:
+        if self == RustBuildMode.RELEASE:
+            return ["--release"]
+        else:
+            return []
+
+    def artifact_directory(self) -> Path:
+        if self == RustBuildMode.RELEASE:
+            return Path("release")
+        else:
+            return Path("debug")
diff --git a/uv.lock b/uv.lock
