test: pyright in tests

This commit changes some of our tests to work with stricter pyright
settings. I made the checks for tests a little less strict than the real
`dbtsl` tests since our tests sometimes inject wrong types into the API
to purposefully induce errors, or mocks stuff that's really hard to
type.

Author: serramatutu

.github/workflows/code-quality.yaml

@@ -32,7 +32,7 @@ jobs:
         run: "hatch run dev:basedpyright dbtsl tests"
 
       - name: mypy
-        run: "hatch run dev:python -m mypy dbtsl tests"
+        run: "hatch run dev:python -m mypy dbtsl"
 
       - name: fetch server schema
         run: "hatch run dev:fetch-schema"

lefthook.yaml

@@ -9,7 +9,7 @@ pre-commit:
     pyright:
       run: "hatch run dev:basedpyright dbtsl tests"
     mypy:
-      run: "hatch run dev:python -m mypy dbtsl tests"
+      run: "hatch run dev:python -m mypy dbtsl"
 
 commit-msg:
   scripts:

pyproject.toml

@@ -128,11 +128,21 @@ PIP_EXTRA_INDEX_URL = "https://pypi.org/simple/"
 asyncio_mode = "auto"
 
 [tool.pyright]
-# TODO: we'd love to enable "strict" typechecking, but 
-# pyarrow not having type stubs makes that really hard
 typeCheckingMode = "strict"
 venv = ".venv/"
 
+[[tool.pyright.executionEnvironments]]
+root = "tests"
+# Tests use private methods and assign inappropriate values to some
+# properties to check our error handling capabilities etc. To avoid
+# having to ignore everything, we disable some checks
+reportPrivateUsage = false
+reportAssignmentType = false
+reportAny = false
+reportCallIssue = false
+reportArgumentType = false
+reportUnknownMemberType = false
+
 [tool.mypy]
 strict = true
 

tests/api/graphql/test_client.py

@@ -1,5 +1,6 @@
 import base64
 import io
+from typing import Any
 from unittest.mock import AsyncMock, MagicMock, call
 
 import pyarrow as pa
@@ -43,7 +44,7 @@ async def gqr_behavior(query_id: QueryId, page_num: int) -> QueryResult:
             arrow_result=base64.b64encode(byte_stream.getvalue()).decode("utf-8"),
         )
 
-    async def run_behavior(op: ProtocolOperation, query_id: QueryId, page_num: int) -> QueryResult:
+    async def run_behavior(_op: ProtocolOperation[Any, Any], query_id: QueryId, page_num: int) -> QueryResult:
         return await gqr_behavior(query_id, page_num)
 
     cq_mock = mocker.patch.object(client, "create_query", return_value=query_id, new_callable=AsyncMock)
@@ -59,7 +60,7 @@ async def run_behavior(op: ProtocolOperation, query_id: QueryId, page_num: int)
 
     kwargs = {"metrics": ["m1", "m2"], "group_by": ["gb"], "limit": 1}
     async with client.session():
-        result_table = await client.query(**kwargs)
+        result_table = await client.query(**kwargs)  # pyright: ignore[reportUnknownVariableType]
 
     cq_mock.assert_awaited_once_with(**kwargs)
 
@@ -108,7 +109,7 @@ def gqr_behavior(query_id: QueryId, page_num: int) -> QueryResult:
             arrow_result=base64.b64encode(byte_stream.getvalue()).decode("utf-8"),
         )
 
-    def run_behavior(op: ProtocolOperation, query_id: QueryId, page_num: int) -> QueryResult:
+    def run_behavior(op: ProtocolOperation[Any, Any], query_id: QueryId, page_num: int) -> QueryResult:
         return gqr_behavior(query_id, page_num)
 
     cq_mock = mocker.patch.object(client, "create_query", return_value=query_id)
@@ -125,7 +126,7 @@ def run_behavior(op: ProtocolOperation, query_id: QueryId, page_num: int) -> Que
     kwargs = {"metrics": ["m1", "m2"], "group_by": ["gb"], "limit": 1}
 
     with client.session():
-        result_table = client.query(**kwargs)
+        result_table = client.query(**kwargs)  # pyright: ignore[reportUnknownVariableType]
 
     cq_mock.assert_called_once_with(**kwargs)
 

tests/api/graphql/test_protocol.py

@@ -7,7 +7,7 @@
 from ...conftest import QueryValidator
 from ...query_test_cases import TEST_QUERIES
 
-VARIABLES = {
+VARIABLES: dict[str, list[dict[str, Any]]] = {
     "metrics": [{}],
     "dimensions": [{"metrics": ["m"]}],
     "measures": [{"metrics": ["m"]}],

tests/integration/test_sl_client.py

@@ -82,14 +82,13 @@ async def test_client_metadata(subtests: SubTests, client: BothClients) -> None:
 @pytest.mark.parametrize("query", TEST_QUERIES)
 async def test_client_query(api: str, query: QueryParameters, client: BothClients) -> None:
     client._method_map["query"] = api  # type: ignore
-    # TODO: fix typing on client.query
     table = await maybe_await(client.query(**query))  # type: ignore
-    assert len(table) > 0
+    assert len(table) > 0  # type: ignore
 
 
 @pytest.mark.parametrize("query", TEST_QUERIES)
 async def test_client_compile_sql_adhoc_query(query: QueryParameters, client: BothClients) -> None:
     # TODO: fix typing on client.compile_sql
     sql = await maybe_await(client.compile_sql(**query))  # type: ignore
-    assert len(sql) > 0
+    assert len(sql) > 0  # type: ignore
     assert "SELECT" in sql