Switch to pyright

Author: laike9m

README.md

@@ -13,6 +13,7 @@ Happy typing!
 This project use [PDM](https://pdm.fming.dev/latest/), a modern Python package and dependency manager, to manage dependencies. After you [have installed PDM](https://pdm.fming.dev/latest/#installation), you can run this project locally based on the following steps:
 
 ```bash
+pdm plugin add pdm-autoexport
 pdm install
 pdm run devserver
 ```

docs/Contribute.md

@@ -30,6 +30,6 @@
 
    `solution.py` contains the right solution, with everything else unchanged.
 
-5. Test with [`mypy`](https://mypy.readthedocs.io/) to make sure your new challenge works as expected.
+5. Test with [`pyright`](https://microsoft.github.io/pyright/#/installation?id=command-line) to make sure your new challenge works as expected.
 
 6. Create a Pull Request.

pdm.lock

@@ -6,7 +6,6 @@ authors = [
     {name = "laike9m", email = "[email protected]"},
 ]
 dependencies = [
-    "mypy>=1.6.1",
     "flask>=3.0.0",
     "typing-extensions>=4.8.0",
     "pyright>=1.1.334",
@@ -35,7 +34,3 @@ without-hashes = true
 venvPath = "."
 venv = ".venv"
 pythonVersion = "3.12"
-
-[tool.mypy]
-check_untyped_defs = true
-warn_no_return = false

pyproject.toml

@@ -7,8 +7,6 @@ flask==3.0.0
 itsdangerous==2.1.2
 Jinja2==3.1.2
 MarkupSafe==2.1.3
-mypy==1.6.1
-mypy-extensions==1.0.0
 nodeenv==1.8.0
 pyright==1.1.334
 setuptools==68.2.2

requirements.txt

@@ -1,7 +1,7 @@
 from views.utils import ChallengeManager
 
 
-def test_run_type_check_with_mypy():
+def test_run_type_check_with_pyright():
     code = """\
 a: int = 1
 b: str = "2"  # expect-type-error
@@ -12,7 +12,7 @@ def test_run_type_check_with_mypy():
     for i in range(10)
 ]
 """
-    result = ChallengeManager._type_check_with_mypy(code)
+    result = ChallengeManager._type_check_with_pyright(code)
     assert result.passed is False
     errors = [line for line in result.stdout.splitlines() if line]
     assert len(errors) == 3

tests/test_utils.py

@@ -2,15 +2,14 @@
 import io
 import os
 import re
+import subprocess
+import tempfile
 import tokenize
 from dataclasses import dataclass, field
 from pathlib import Path
 from typing import ClassVar, TypeAlias
 
-from mypy import api
-
 ROOT_DIR = Path(__file__).parent.parent
-MYPY_CONFIG = ROOT_DIR / "pyproject.toml"
 
 
 ChallengeName: TypeAlias = str
@@ -47,12 +46,6 @@ class TypeCheckResult:
 
 
 class ChallengeManager:
-    EXPECT_ERROR_COMMENT = "expect-type-error"
-
-    # Each mypy error should look like: `<filename>:<line_number>: <error|note>: <message>`
-    # Here we only capture the error messages and line numbers
-    MYPY_MESSAGE_REGEX = r"^(?:.+?):(\d+):(\s*error:.+)$"
-
     def __init__(self):
         self.challenges = self._load_challenges()
         self.challenge_names = [
@@ -69,7 +62,7 @@ def get_challenge(self, name: str) -> Challenge:
     def run_challenge(self, name: str, user_code: str) -> TypeCheckResult:
         challenge = self.get_challenge(name)
         code = f"{user_code}\n{challenge.test_code}"
-        return self._type_check_with_mypy(code)
+        return self._type_check_with_pyright(code)
 
     @staticmethod
     def _load_challenges() -> dict[ChallengeName, Challenge]:
@@ -87,8 +80,15 @@ def _load_challenges() -> dict[ChallengeName, Challenge]:
 
         return challenges
 
+    EXPECT_ERROR_COMMENT = "expect-type-error"
+
+    # Pyright error messages look like:
+    # `<filename>:<line_no>:<col_no> - <error|warning|information>: <message>`
+    # Here we only capture the error messages and line numbers
+    PYRIGHT_MESSAGE_REGEX = r"^(?:.+?):(\d+):[\s\-\d]+(error:.+)$"
+
     @classmethod
-    def _type_check_with_mypy(cls, code: str) -> TypeCheckResult:
+    def _type_check_with_pyright(cls, code: str) -> TypeCheckResult:
         buffer = io.StringIO(code)
 
         # This produces a stream of TokenInfos, example:
@@ -104,11 +104,19 @@ def _type_check_with_mypy(cls, code: str) -> TypeCheckResult:
             if token.type == tokenize.COMMENT
             and token.string[1:].strip() == cls.EXPECT_ERROR_COMMENT
         ]
-        raw_result = api.run(["--config-file", str(MYPY_CONFIG), "-c", code])
+
+        with tempfile.NamedTemporaryFile(suffix=".py") as temp:
+            temp.write(code.encode())
+            temp.flush()
+            # TODO: switch to json output to simplify output parsing.
+            # https://microsoft.github.io/pyright/#/command-line?id=json-output
+            raw_result = subprocess.run(
+                ["pyright", temp.name], capture_output=True, text=True
+            ).stdout
         error_lines: list[str] = []
 
-        for line in raw_result[0].splitlines():
-            m = re.match(cls.MYPY_MESSAGE_REGEX, line)
+        for line in raw_result.splitlines():
+            m = re.match(cls.PYRIGHT_MESSAGE_REGEX, line)
             if m is None:
                 continue
             line_number, message = int(m.group(1)), m.group(2)
@@ -119,7 +127,7 @@ def _type_check_with_mypy(cls, code: str) -> TypeCheckResult:
                 continue
             error_lines.append(f"{line_number}:{message}")
 
-        # If there are any lines that are expected to fail but not reported by mypy,
+        # If there are any lines that are expected to fail but not reported by pyright,
         # they should be considered as errors.
         for line_number in expect_error_line_numbers:
             error_lines.append(f"{line_number}: error: Expected type error")

views/utils.py

@@ -41,13 +41,4 @@ def run_challenge(name):
 
     error_message = "<h2>❌ Challenge failed 😢\n\n</h2>"
     error_message += f"\nError:\n{result.stdout}{result.stderr}\n\n"
-
-    response = make_response(error_message)
-
-    # See https://twitter.com/Manjusaka_Lee/status/1720506781577937304
-    # Call gc after returning the response, so that it's off the critical path.
-    @response.call_on_close
-    def cleanup_mypy_objects():
-        gc.collect()
-
-    return response
+    return error_message