Add type checking with ty

Author: jason-rl

.github/workflows/ci.yml

@@ -32,6 +32,9 @@ jobs:
       - name: Run lints
         run: ./scripts/lint
 
+      - name: Run type checking
+        run: uv run ty check
+
   build:
     if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     timeout-minutes: 10

pyproject.toml

@@ -63,6 +63,7 @@ dev = [
     "pytest-xdist>=3.6.1",
     "uuid-utils>=0.11.0",
     "pytest-cov>=7.0.0",
+    "ty>=0.0.1a32",
 ]
 docs = [
     "furo>=2025.9.25",
@@ -285,3 +286,26 @@ known-first-party = ["runloop_api_client", "tests"]
 "scripts/**.py" = ["T201", "T203"]
 "tests/**.py" = ["T201", "T203"]
 "examples/**.py" = ["T201", "T203"]
+
+[tool.ty.src]
+# External libraries with known stub issues
+exclude = [
+    "tests",
+    "src/runloop_api_client/resources",
+    "src/runloop_api_client/_utils",
+]
+
+[tool.ty.rules]
+invalid-assignment = "ignore"
+call-non-callable = "ignore"
+redundant-cast = "ignore"
+invalid-argument-type = "ignore"
+unresolved-attribute = "ignore"
+not-iterable = "ignore"
+invalid-explicit-override = "ignore"
+non-subscriptable = "ignore"
+invalid-return-type = "ignore"
+unresolved-import = "ignore"
+possibly-missing-attribute = "ignore"
+invalid-parameter-default = "ignore"
+no-matching-overload = "ignore"

src/runloop_api_client/_base_client.py

@@ -257,7 +257,7 @@ def iter_pages(self: SyncPageT) -> Iterator[SyncPageT]:
         while True:
             yield page
             if page.has_next_page():
-                page = page.get_next_page()
+                page = cast(page.get_next_page())  # type: ignore
             else:
                 return
 
@@ -486,7 +486,7 @@ def _build_request(
             if json_data is None:
                 json_data = cast(Body, options.extra_json)
             elif is_mapping(json_data):
-                json_data = _merge_mappings(json_data, options.extra_json)
+                json_data = _merge_mappings(json_data, options.extra_json)  # type: ignore
             else:
                 raise RuntimeError(f"Unexpected JSON data type, {type(json_data)}, cannot merge with `extra_body`")
 
@@ -513,7 +513,7 @@ def _build_request(
                     raise TypeError(
                         f"Expected query input to be a dictionary for multipart requests but got {type(json_data)} instead."
                     )
-                kwargs["data"] = self._serialize_multipartform(json_data)
+                kwargs["data"] = self._serialize_multipartform(json_data)  # type: ignore
 
             # httpx determines whether or not to send a "multipart/form-data"
             # request based on the truthiness of the "files" argument.

src/runloop_api_client/sdk/async_.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import asyncio
-from typing import Dict, Mapping, Optional
+from typing import Dict, List, Mapping, Optional
 from pathlib import Path
 from datetime import timedelta
 from typing_extensions import Unpack
@@ -150,7 +150,7 @@ def from_id(self, devbox_id: str) -> AsyncDevbox:
     async def list(
         self,
         **params: Unpack[SDKDevboxListParams],
-    ) -> list[AsyncDevbox]:
+    ) -> List[AsyncDevbox]:
         """List devboxes accessible to the caller.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxListParams` for available parameters
@@ -186,7 +186,7 @@ def __init__(self, client: AsyncRunloop) -> None:
     async def list(
         self,
         **params: Unpack[SDKDiskSnapshotListParams],
-    ) -> list[AsyncSnapshot]:
+    ) -> List[AsyncSnapshot]:
         """List snapshots created from devboxes.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDiskSnapshotListParams` for available parameters
@@ -277,7 +277,7 @@ def from_id(self, blueprint_id: str) -> AsyncBlueprint:
     async def list(
         self,
         **params: Unpack[SDKBlueprintListParams],
-    ) -> list[AsyncBlueprint]:
+    ) -> List[AsyncBlueprint]:
         """List available blueprints.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKBlueprintListParams` for available parameters
@@ -338,7 +338,7 @@ def from_id(self, object_id: str) -> AsyncStorageObject:
     async def list(
         self,
         **params: Unpack[SDKObjectListParams],
-    ) -> list[AsyncStorageObject]:
+    ) -> List[AsyncStorageObject]:
         """List storage objects owned by the caller.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKObjectListParams` for available parameters
@@ -541,12 +541,12 @@ def from_id(self, scorer_id: str) -> AsyncScorer:
         """
         return AsyncScorer(self._client, scorer_id)
 
-    async def list(self, **params: Unpack[SDKScorerListParams]) -> list[AsyncScorer]:
+    async def list(self, **params: Unpack[SDKScorerListParams]) -> List[AsyncScorer]:
         """List all scorers, optionally filtered by parameters.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKScorerListParams` for available parameters
         :return: List of scorers
-        :rtype: list[AsyncScorer]
+        :rtype: List[AsyncScorer]
         """
         page = await self._client.scenarios.scorers.list(**params)
         return [AsyncScorer(self._client, item.id) async for item in page]
@@ -599,7 +599,7 @@ async def create_from_npm(
         package_name: str,
         npm_version: Optional[str] = None,
         registry_url: Optional[str] = None,
-        agent_setup: Optional[list[str]] = None,
+        agent_setup: Optional[List[str]] = None,
         **params: Unpack[SDKAgentCreateParams],
     ) -> AsyncAgent:
         """Create an agent from an NPM package.
@@ -641,7 +641,7 @@ async def create_from_pip(
         package_name: str,
         pip_version: Optional[str] = None,
         registry_url: Optional[str] = None,
-        agent_setup: Optional[list[str]] = None,
+        agent_setup: Optional[List[str]] = None,
         **params: Unpack[SDKAgentCreateParams],
     ) -> AsyncAgent:
         """Create an agent from a Pip package.
@@ -682,7 +682,7 @@ async def create_from_git(
         *,
         repository: str,
         ref: Optional[str] = None,
-        agent_setup: Optional[list[str]] = None,
+        agent_setup: Optional[List[str]] = None,
         **params: Unpack[SDKAgentCreateParams],
     ) -> AsyncAgent:
         """Create an agent from a Git repository.
@@ -718,7 +718,7 @@ async def create_from_object(
         self,
         *,
         object_id: str,
-        agent_setup: Optional[list[str]] = None,
+        agent_setup: Optional[List[str]] = None,
         **params: Unpack[SDKAgentCreateParams],
     ) -> AsyncAgent:
         """Create an agent from a storage object.
@@ -759,7 +759,7 @@ def from_id(self, agent_id: str) -> AsyncAgent:
     async def list(
         self,
         **params: Unpack[SDKAgentListParams],
-    ) -> list[AsyncAgent]:
+    ) -> List[AsyncAgent]:
         """List agents accessible to the caller.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKAgentListParams` for available parameters
@@ -800,7 +800,7 @@ def from_id(self, scenario_id: str) -> AsyncScenario:
         """
         return AsyncScenario(self._client, scenario_id)
 
-    async def list(self, **params: Unpack[SDKScenarioListParams]) -> list[AsyncScenario]:
+    async def list(self, **params: Unpack[SDKScenarioListParams]) -> List[AsyncScenario]:
         """List all scenarios, optionally filtered by parameters.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKScenarioListParams` for available parameters

src/runloop_api_client/sdk/sync.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, Mapping, Optional
+from typing import Dict, List, Mapping, Optional
 from pathlib import Path
 from datetime import timedelta
 from typing_extensions import Unpack
@@ -149,7 +149,7 @@ def from_id(self, devbox_id: str) -> Devbox:
     def list(
         self,
         **params: Unpack[SDKDevboxListParams],
-    ) -> list[Devbox]:
+    ) -> List[Devbox]:
         """List devboxes accessible to the caller.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxListParams` for available parameters
@@ -185,7 +185,7 @@ def __init__(self, client: Runloop) -> None:
     def list(
         self,
         **params: Unpack[SDKDiskSnapshotListParams],
-    ) -> list[Snapshot]:
+    ) -> List[Snapshot]:
         """List snapshots created from devboxes.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDiskSnapshotListParams` for available parameters
@@ -275,7 +275,7 @@ def from_id(self, blueprint_id: str) -> Blueprint:
     def list(
         self,
         **params: Unpack[SDKBlueprintListParams],
-    ) -> list[Blueprint]:
+    ) -> List[Blueprint]:
         """List available blueprints.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKBlueprintListParams` for available parameters
@@ -336,7 +336,7 @@ def from_id(self, object_id: str) -> StorageObject:
     def list(
         self,
         **params: Unpack[SDKObjectListParams],
-    ) -> list[StorageObject]:
+    ) -> List[StorageObject]:
         """List storage objects owned by the caller.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKObjectListParams` for available parameters
@@ -536,7 +536,7 @@ def from_id(self, scorer_id: str) -> Scorer:
         """
         return Scorer(self._client, scorer_id)
 
-    def list(self, **params: Unpack[SDKScorerListParams]) -> list[Scorer]:
+    def list(self, **params: Unpack[SDKScorerListParams]) -> List[Scorer]:
         """List all scorers, optionally filtered by parameters.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKScorerListParams` for available parameters
@@ -594,7 +594,7 @@ def create_from_npm(
         package_name: str,
         npm_version: Optional[str] = None,
         registry_url: Optional[str] = None,
-        agent_setup: Optional[list[str]] = None,
+        agent_setup: Optional[List[str]] = None,
         **params: Unpack[SDKAgentCreateParams],
     ) -> Agent:
         """Create an agent from an NPM package.
@@ -641,7 +641,7 @@ def create_from_pip(
         package_name: str,
         pip_version: Optional[str] = None,
         registry_url: Optional[str] = None,
-        agent_setup: Optional[list[str]] = None,
+        agent_setup: Optional[List[str]] = None,
         **params: Unpack[SDKAgentCreateParams],
     ) -> Agent:
         """Create an agent from a Pip package.
@@ -687,7 +687,7 @@ def create_from_git(
         *,
         repository: str,
         ref: Optional[str] = None,
-        agent_setup: Optional[list[str]] = None,
+        agent_setup: Optional[List[str]] = None,
         **params: Unpack[SDKAgentCreateParams],
     ) -> Agent:
         """Create an agent from a Git repository.
@@ -731,7 +731,7 @@ def create_from_object(
         self,
         *,
         object_id: str,
-        agent_setup: Optional[list[str]] = None,
+        agent_setup: Optional[List[str]] = None,
         **params: Unpack[SDKAgentCreateParams],
     ) -> Agent:
         """Create an agent from a storage object.
@@ -780,7 +780,7 @@ def from_id(self, agent_id: str) -> Agent:
     def list(
         self,
         **params: Unpack[SDKAgentListParams],
-    ) -> list[Agent]:
+    ) -> List[Agent]:
         """List agents accessible to the caller.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKAgentListParams` for available parameters
@@ -821,7 +821,7 @@ def from_id(self, scenario_id: str) -> Scenario:
         """
         return Scenario(self._client, scenario_id)
 
-    def list(self, **params: Unpack[SDKScenarioListParams]) -> list[Scenario]:
+    def list(self, **params: Unpack[SDKScenarioListParams]) -> List[Scenario]:
         """List all scenarios, optionally filtered by parameters.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKScenarioListParams` for available parameters