Run pyrefly over test cases (#2914)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: rchen152

.github/workflows/test.yml

@@ -171,6 +171,31 @@ jobs:
           version: PATH
           project: ./pyrightconfig.testcases.json
 
+  run-pyrefly:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.12']
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --no-dev --group pyrefly
+
+      - name: Add venv to path
+        run: echo "$PWD/.venv/bin" >> $GITHUB_PATH
+
+      - name: Run pyrefly on the test cases
+        run: pyrefly check tests/assert_type
+
   matrix-test:
     timeout-minutes: 10
     runs-on: ubuntu-latest

pyproject.toml

@@ -61,10 +61,14 @@ tests = [
 pyright = [
   "pyright==1.1.407",
 ]
+pyrefly = [
+  "pyrefly==0.43.0",
+]
 
 dev = [
   {include-group = "tests"},
   {include-group = "pyright"},
+  {include-group = "pyrefly"},
 ]
 
 [project.urls]

pyrefly.toml

@@ -0,0 +1,2 @@
+# Respect only `# pyrefly: ignore` (ignore `# type: ignore`)
+enabled-ignores = ["pyrefly"]

tests/assert_type/apps/test_config.py

@@ -12,15 +12,15 @@ class BarConfig(AppConfig):
     name = "foo"
 
     @property
-    def default_auto_field(self) -> str:  # type: ignore[override]
+    def default_auto_field(self) -> str:  # type: ignore[override]  # pyrefly: ignore[bad-override]
         return "django.db.models.BigAutoField"
 
 
 class BazConfig(AppConfig):
     name = "foo"
 
     @cached_property
-    def default_auto_field(self) -> str:  # type: ignore[override]
+    def default_auto_field(self) -> str:  # type: ignore[override]  # pyrefly: ignore[bad-override]
         return "django.db.models.BigAutoField"
 
 

tests/assert_type/db/models/test_constraints.py

@@ -7,13 +7,13 @@
 UniqueConstraint(Lower("name").desc(), "category", name="unique_lower_name_category")
 UniqueConstraint(fields=["name"], name="unique_name")
 # There's no overload case for passing both expression and 'fields'
-UniqueConstraint(  # type: ignore[call-overload]
+UniqueConstraint(  # type: ignore[call-overload]  # pyrefly: ignore[no-matching-overload]
     Lower("name"),
     fields=["name"],  # pyright: ignore[reportArgumentType]
     name="unique_mess",
 )
 
-CheckConstraint(  # type: ignore[deprecated]  # pyright: ignore[reportDeprecated]
+CheckConstraint(  # type: ignore[deprecated]  # pyright: ignore[reportDeprecated]  # pyrefly: ignore[deprecated]
     name="less_than_constraint",
     check=LessThan[Any](F("months"), 1),
 )

tests/assert_type/db/models/test_enums.py

@@ -227,12 +227,26 @@ class Joker(TextChoices):
 # Note: Suppress errors from pyright as the mypy plugin narrows the type of labels if non-lazy.
 assert_type(VoidChoices.names, list[str])
 assert_type(VoidChoices.labels, list[str])  # pyright: ignore[reportAssertTypeFailure]
-assert_type(VoidChoices.values, list[Any | None])  # pyright: ignore[reportAssertTypeFailure]
-assert_type(VoidChoices.choices, list[tuple[Any | None, str]])  # pyright: ignore[reportAssertTypeFailure]
+
+assert_type(VoidChoices.values, list[int | None])  # type: ignore[assert-type]  # pyright: ignore[reportAssertTypeFailure]
+assert_type(
+    VoidChoices.values,  # pyrefly: ignore[assert-type]  # pyright: ignore[reportAssertTypeFailure]
+    list[Any | None],
+)
+
+assert_type(VoidChoices.choices, list[tuple[int | None, str]])  # type: ignore[assert-type]  # pyright: ignore[reportAssertTypeFailure]
+assert_type(
+    VoidChoices.choices,  # pyrefly: ignore[assert-type]  # pyright: ignore[reportAssertTypeFailure]
+    list[tuple[Any | None, str]],
+)
+
 assert_type(VoidChoices.ABYSS, Literal[VoidChoices.ABYSS])
 assert_type(VoidChoices.ABYSS.name, Literal["ABYSS"])
 assert_type(VoidChoices.ABYSS.label, str)  # pyright: ignore[reportAssertTypeFailure]
-assert_type(VoidChoices.ABYSS.value, Any)
+
+assert_type(VoidChoices.ABYSS.value, int)  # type: ignore[assert-type]  # pyright: ignore[reportAssertTypeFailure]
+assert_type(VoidChoices.ABYSS.value, Any)  # pyrefly: ignore[assert-type]
+
 assert_type(VoidChoices.ABYSS.do_not_call_in_templates, Literal[True])
 assert_type(VoidChoices.__empty__, str)  # pyright: ignore[reportAssertTypeFailure]
 
@@ -274,7 +288,10 @@ class Joker(TextChoices):
 
 # Assertions for mixing multiple choices types with consistent base types - only `TextChoices`.
 x1 = (Medal, Gender)
-assert_type([member.label for choices in x1 for member in choices], list[_StrOrPromise])
+
+assert_type([member.label for choices in x1 for member in choices], list[str])  # type: ignore[assert-type]  # pyright: ignore[reportAssertTypeFailure]
+assert_type([member.label for choices in x1 for member in choices], list[_StrOrPromise])  # pyrefly: ignore[assert-type]
+
 assert_type([member.value for choices in x1 for member in choices], list[str])
 
 # Assertions for mixing multiple choices types with different base types - `IntegerChoices` and `TextChoices`.
@@ -284,8 +301,12 @@ class Joker(TextChoices):
 
 # Assertions for mixing multiple choices types with consistent base types - custom types.
 x3 = (Constants, Separator)
-assert_type([member.label for choices in x3 for member in choices], list[_StrOrPromise])
-assert_type([member.value for choices in x3 for member in choices], list[Any])
+
+assert_type([member.label for choices in x3 for member in choices], list[str])  # type: ignore[assert-type]  # pyright: ignore[reportAssertTypeFailure]
+assert_type([member.label for choices in x3 for member in choices], list[_StrOrPromise])  # pyrefly: ignore[assert-type]
+
+assert_type([member.value for choices in x3 for member in choices], list[bytes | float])  # type: ignore[assert-type]  # pyright: ignore[reportAssertTypeFailure]
+assert_type([member.value for choices in x3 for member in choices], list[Any])  # pyrefly: ignore[assert-type]
 
 
 # Assertions for choices objects defined and aliased in a model.

tests/assert_type/db/models/test_ordering.py

@@ -35,21 +35,21 @@
 )
 
 # failure cases
-qs.order_by(123)  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]
-qs.order_by(["username"])  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]
-qs.order_by({"username": "asc"})  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]
+qs.order_by(123)  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
+qs.order_by(["username"])  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
+qs.order_by({"username": "asc"})  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
 
-qs.extra(order_by=[123])  # type: ignore[list-item] # pyright: ignore[reportArgumentType]
-qs.extra(order_by=["username", 456])  # type: ignore[list-item] # pyright: ignore[reportArgumentType]
+qs.extra(order_by=[123])  # type: ignore[list-item] # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
+qs.extra(order_by=["username", 456])  # type: ignore[list-item] # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
 
-query.add_ordering(123)  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]
-query.add_ordering(["username"])  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]
+query.add_ordering(123)  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
+query.add_ordering(["username"])  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
 
 query.add_extra(
     select=None,
     select_params=None,
     where=None,
     params=None,
     tables=None,
-    order_by=[123, "username"],  # type: ignore[list-item] # pyright: ignore[reportArgumentType]
+    order_by=[123, "username"],  # type: ignore[list-item] # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
 )

tests/assert_type/forms/test_add_error.py

@@ -27,9 +27,9 @@
 assert_type(form.add_error("field", ValidationError(["error"])), None)
 assert_type(form.add_error(None, ValidationError({"field": "error"})), None)
 
-form.add_error("field", {"field": "error"})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]
-form.add_error("field", {"field": lazystr("error")})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]
-form.add_error("field", {"field": ValidationError("error")})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]
-form.add_error("field", {"field": ["error"]})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]
-form.add_error("field", {"field": [lazystr("error")]})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]
-form.add_error("field", {"field": [ValidationError("error")]})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]
+form.add_error("field", {"field": "error"})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]  # pyrefly: ignore[no-matching-overload]
+form.add_error("field", {"field": lazystr("error")})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]  # pyrefly: ignore[no-matching-overload]
+form.add_error("field", {"field": ValidationError("error")})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]  # pyrefly: ignore[no-matching-overload]
+form.add_error("field", {"field": ["error"]})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]  # pyrefly: ignore[no-matching-overload]
+form.add_error("field", {"field": [lazystr("error")]})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]  # pyrefly: ignore[no-matching-overload]
+form.add_error("field", {"field": [ValidationError("error")]})  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue,reportArgumentType]  # pyrefly: ignore[no-matching-overload]

tests/assert_type/http/test_request.py

@@ -27,7 +27,7 @@
 # Test MutableQueryDict
 mut_q = QueryDict(mutable=True)
 mut_q["a"] = "3"
-mut_q["a"] = ["1", "2"]  # type: ignore[assignment]  # pyright: ignore[reportArgumentType]
+mut_q["a"] = ["1", "2"]  # type: ignore[assignment]  # pyright: ignore[reportArgumentType]  # pyrefly: ignore[unsupported-operation]
 
 assert_type(mut_q.pop("a"), list[str])
 assert_type(mut_q.pop("a", 12), list[str] | int)

tests/assert_type/middleware/test_middleware.py

@@ -16,15 +16,15 @@ class CustomCommonMiddleware(CommonMiddleware):
 
 
 class BrokenCustomCommonMiddleware(CommonMiddleware):
-    response_redirect_class = FileResponse  # type:ignore[assignment]  # pyright: ignore[reportAssignmentType]
+    response_redirect_class = FileResponse  # type:ignore[assignment]  # pyright: ignore[reportAssignmentType]  # pyrefly: ignore[bad-assignment]
 
 
 class CustomLocaleMiddleware(LocaleMiddleware):
     response_redirect_class = HttpResponseRedirect
 
 
 class BrokenCustomLocaleMiddleware(CommonMiddleware):
-    response_redirect_class = FileResponse  # type:ignore[assignment]  # pyright: ignore[reportAssignmentType]
+    response_redirect_class = FileResponse  # type:ignore[assignment]  # pyright: ignore[reportAssignmentType]  # pyrefly: ignore[bad-assignment]
 
 
 class CustomRedirectFallbackMiddleware(RedirectFallbackMiddleware):
@@ -38,5 +38,5 @@ class CustomRedirectFallbackMiddleware2(RedirectFallbackMiddleware):
 
 
 class BrokenCustomRedirectFallbackMiddleware(RedirectFallbackMiddleware):
-    response_redirect_class = HttpResponse  # type:ignore[assignment]  # pyright: ignore[reportAssignmentType]
-    response_gone_class = 12  # type:ignore[assignment]  # pyright: ignore[reportAssignmentType]
+    response_redirect_class = HttpResponse  # type:ignore[assignment]  # pyright: ignore[reportAssignmentType]  # pyrefly: ignore[bad-assignment]
+    response_gone_class = 12  # type:ignore[assignment]  # pyright: ignore[reportAssignmentType]  # pyrefly: ignore[bad-assignment]