Fix Python SDK type issues with ty type checker

.github/workflows/typecheck.yml

@@ -0,0 +1,60 @@
+name: Typecheck
+
+on:
+  pull_request:
+
+jobs:
+  typecheck:
+    name: Typecheck
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Parse .tool-versions
+        uses: wistia/parse-tool-versions@v2.1.1
+        with:
+          filename: '.tool-versions'
+          uppercase: 'true'
+          prefix: 'tool_version_'
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: '${{ env.TOOL_VERSION_PNPM }}'
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '${{ env.TOOL_VERSION_NODEJS }}'
+          cache: pnpm
+
+      - name: Configure pnpm
+        run: |
+          pnpm config set auto-install-peers true
+          pnpm config set exclude-links-from-lockfile true
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '${{ env.TOOL_VERSION_PYTHON }}'
+
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: '${{ env.TOOL_VERSION_POETRY }}'
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+
+      - name: Install Python dependencies
+        working-directory: packages/python-sdk
+        run: |
+          poetry install --with dev
+
+      - name: Run typecheck
+        run: |
+          pnpm run typecheck

package.json

@@ -12,6 +12,7 @@
     "pnpm-install-hack": "cd packages/js-sdk && sed -i '' 's/\"version\": \".*\"/\"version\": \"9.9.9\"/g' package.json && cd ../.. && pnpm i && git checkout -- packages/js-sdk/package.json",
     "generate-sdk-reference": "pnpm --if-present --recursive run generate-sdk-reference",
     "lint": "pnpm --if-present --recursive run lint",
+    "typecheck": "pnpm --if-present --recursive run typecheck",
     "format": "pnpm --if-present --recursive run format",
     "changeset": "pnpx @changesets/cli"
   },

packages/cli/package.json

@@ -38,6 +38,7 @@
     "prepublishOnly": "pnpm build",
     "build": "tsc --noEmit --skipLibCheck && tsup --minify",
     "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit --skipLibCheck",
     "lint": "eslint src",
     "format": "prettier --write src",
     "test:interactive": "pnpm build && ./dist/index.js",

packages/js-sdk/package.json

@@ -41,6 +41,7 @@
     "test:bun": "bun test tests/runtimes/bun --env-file=.env",
     "test:deno": "deno test tests/runtimes/deno/ --allow-net --allow-read --allow-env --unstable-sloppy-imports --trace-leaks",
     "test:integration": "E2B_INTEGRATION_TEST=1 vitest run tests/integration/**",
+    "typecheck": "tsc --noEmit",
     "lint": "eslint src/ tests/",
     "format": "prettier --write src/ tests/ example.mts"
   },

packages/python-sdk/Makefile

@@ -23,6 +23,9 @@ generate: generate-api generate-envd generate-mcp
 init:
 	pip install openapi-python-client datamodel-code-generator
 
+typecheck:
+	ty check
+
 lint:
 	ruff check .
 	ruff format --check .

packages/python-sdk/e2b/api/__init__.py

@@ -31,7 +31,7 @@ class SandboxCreateResponse:
     sandbox_id: str
     sandbox_domain: Optional[str]
     envd_version: str
-    envd_access_token: str
+    envd_access_token: Optional[str]
     traffic_access_token: Optional[str]
 
 
@@ -135,7 +135,7 @@ def __init__(
                 "transport": transport,
             },
             headers=headers,
-            token=token,
+            token=token or "",
             auth_header_name=auth_header_name,
             prefix=prefix,
             *args,

packages/python-sdk/e2b/api/client_async/__init__.py

@@ -3,8 +3,6 @@
 
 from typing import Optional
 
-from typing_extensions import Self
-
 from e2b.connection_config import ConnectionConfig
 from e2b.api import limits, AsyncApiClient
 
@@ -21,7 +19,7 @@ def get_api_client(config: ConnectionConfig, **kwargs) -> AsyncApiClient:
 
 
 class AsyncTransportWithLogger(httpx.AsyncHTTPTransport):
-    singleton: Optional[Self] = None
+    singleton: Optional["AsyncTransportWithLogger"] = None
 
     async def handle_async_request(self, request):
         url = f"{request.url.scheme}://{request.url.host}{request.url.path}"

packages/python-sdk/e2b/api/client_sync/__init__.py

@@ -3,8 +3,6 @@
 import httpx
 import logging
 
-from typing_extensions import Self
-
 from e2b.api import ApiClient, limits
 from e2b.connection_config import ConnectionConfig
 
@@ -20,7 +18,7 @@ def get_api_client(config: ConnectionConfig, **kwargs) -> ApiClient:
 
 
 class TransportWithLogger(httpx.HTTPTransport):
-    singleton: Optional[Self] = None
+    singleton: Optional["TransportWithLogger"] = None
 
     def handle_request(self, request):
         url = f"{request.url.scheme}://{request.url.host}{request.url.path}"

packages/python-sdk/e2b/connection_config.py

@@ -117,7 +117,9 @@ def __init__(
             or ("http://localhost:3000" if self.debug else f"https://api.{self.domain}")
         )
 
-        self._sandbox_url = sandbox_url or ConnectionConfig._sandbox_url()
+        self._sandbox_url: Optional[str] = (
+            sandbox_url or ConnectionConfig._sandbox_url()
+        )
 
     @staticmethod
     def _get_request_timeout(
@@ -135,8 +137,9 @@ def get_request_timeout(self, request_timeout: Optional[float] = None):
         return self._get_request_timeout(self.request_timeout, request_timeout)
 
     def get_sandbox_url(self, sandbox_id: str, sandbox_domain: str) -> str:
-        if self._sandbox_url:
-            return self._sandbox_url
+        sandbox_url: Optional[str] = self._sandbox_url  # type: ignore[assignment]
+        if sandbox_url:
+            return sandbox_url
 
         return f"{'http' if self.debug else 'https'}://{self.get_host(sandbox_id, sandbox_domain, self.envd_port)}"
 

packages/python-sdk/e2b/sandbox/main.py

@@ -73,7 +73,7 @@ def traffic_access_token(self) -> Optional[str]:
         return self.__traffic_access_token
 
     @property
-    def sandbox_domain(self) -> Optional[str]:
+    def sandbox_domain(self) -> str:
         return self.__sandbox_domain
 
     @property

packages/python-sdk/e2b/sandbox/sandbox_api.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from datetime import datetime
-from typing import Any, Dict, List, Optional, TypedDict, Union
+from typing import Any, Dict, List, Optional, TypedDict, Union, cast
 
 from typing_extensions import NotRequired, Unpack
 
@@ -117,7 +117,10 @@ def _from_sandbox_data(
             sandbox_id=sandbox.sandbox_id,
             template_id=sandbox.template_id,
             name=(sandbox.alias if isinstance(sandbox.alias, str) else None),
-            metadata=(sandbox.metadata if isinstance(sandbox.metadata, dict) else {}),
+            metadata=cast(
+                Dict[str, str],
+                sandbox.metadata if isinstance(sandbox.metadata, dict) else {},
+            ),
             started_at=sandbox.started_at,
             end_at=sandbox.end_at,
             state=sandbox.state,

packages/python-sdk/e2b/sandbox_async/commands/command.py

@@ -238,7 +238,7 @@ async def _start(
         self,
         cmd: str,
         envs: Optional[Dict[str, str]],
-        user: Username,
+        user: Optional[Username],
         cwd: Optional[str],
         timeout: Optional[float],
         request_timeout: Optional[float],

packages/python-sdk/e2b/sandbox_async/main.py

@@ -242,13 +242,12 @@ async def connect(
         ...
 
     @overload
-    @classmethod
+    @staticmethod
     async def connect(
-        cls,
         sandbox_id: str,
         timeout: Optional[int] = None,
         **opts: Unpack[ApiParams],
-    ) -> Self:
+    ) -> "AsyncSandbox":
         """
         Connect to a sandbox. If the sandbox is paused, it will be automatically resumed.
         Sandbox must be either running or be paused.
@@ -271,7 +270,7 @@ async def connect(
         """
         ...
 
-    @class_method_variant("_cls_connect")
+    @class_method_variant("_cls_connect_sandbox")
     async def connect(
         self,
         timeout: Optional[int] = None,
@@ -308,7 +307,7 @@ async def __aenter__(self):
         return self
 
     async def __aexit__(self, exc_type, exc_value, traceback):
-        await self.kill()
+        await self.kill()  # ty: ignore[no-matching-overload]
 
     @overload
     async def kill(
@@ -643,7 +642,7 @@ async def get_mcp_token(self) -> Optional[str]:
         return self._mcp_token
 
     @classmethod
-    async def _cls_connect(
+    async def _cls_connect_sandbox(
         cls,
         sandbox_id: str,
         timeout: Optional[int] = None,

packages/python-sdk/e2b/sandbox_async/sandbox_api.py

@@ -1,5 +1,5 @@
 import datetime
-from typing import Dict, List, Optional
+from typing import Any, Dict, List, Optional, cast
 
 from packaging.version import Version
 from typing_extensions import Unpack
@@ -171,7 +171,7 @@ async def _create_sandbox(
                 metadata=metadata or {},
                 timeout=timeout,
                 env_vars=env_vars or {},
-                mcp=mcp or UNSET,
+                mcp=cast(Any, mcp) if mcp is not None else UNSET,
                 secure=secure,
                 allow_internet_access=allow_internet_access,
                 network=SandboxNetworkConfig(**network) if network else UNSET,
@@ -195,12 +195,24 @@ async def _create_sandbox(
                 "You can do this by running `e2b template build` in the directory with the template."
             )
 
+        domain = res.parsed.domain if isinstance(res.parsed.domain, str) else None
+        envd_token = (
+            res.parsed.envd_access_token
+            if isinstance(res.parsed.envd_access_token, str)
+            else None
+        )
+        traffic_token = (
+            res.parsed.traffic_access_token
+            if isinstance(res.parsed.traffic_access_token, str)
+            else None
+        )
+
         return SandboxCreateResponse(
             sandbox_id=res.parsed.sandbox_id,
-            sandbox_domain=res.parsed.domain,
+            sandbox_domain=domain,
             envd_version=res.parsed.envd_version,
-            envd_access_token=res.parsed.envd_access_token,
-            traffic_access_token=res.parsed.traffic_access_token,
+            envd_access_token=envd_token,
+            traffic_access_token=traffic_token,
         )
 
     @classmethod
@@ -322,4 +334,7 @@ async def _cls_connect(
         if isinstance(res.parsed, Error):
             raise SandboxException(f"{res.parsed.message}: Request failed")
 
+        if res.parsed is None:
+            raise SandboxException("Body of the request is None")
+
         return res.parsed

packages/python-sdk/e2b/sandbox_sync/commands/command.py

@@ -240,7 +240,7 @@ def _start(
         self,
         cmd: str,
         envs: Optional[Dict[str, str]],
-        user: Username,
+        user: Optional[Username],
         cwd: Optional[str],
         stdin: bool,
         timeout: Optional[float],

packages/python-sdk/e2b/sandbox_sync/main.py

@@ -241,13 +241,12 @@ def connect(
         ...
 
     @overload
-    @classmethod
+    @staticmethod
     def connect(
-        cls,
         sandbox_id: str,
         timeout: Optional[int] = None,
         **opts: Unpack[ApiParams],
-    ) -> Self:
+    ) -> "Sandbox":
         """
         Connect to a sandbox. If the sandbox is paused, it will be automatically resumed.
         Sandbox must be either running or be paused.
@@ -270,7 +269,7 @@ def connect(
         """
         ...
 
-    @class_method_variant("_cls_connect")
+    @class_method_variant("_cls_connect_sandbox")
     def connect(
         self,
         timeout: Optional[int] = None,
@@ -307,7 +306,7 @@ def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
-        self.kill()
+        self.kill()  # ty: ignore[no-matching-overload]
 
     @overload
     def kill(
@@ -595,9 +594,8 @@ def beta_pause(
         ...
 
     @overload
-    @classmethod
+    @staticmethod
     def beta_pause(
-        cls,
         sandbox_id: str,
         **opts: Unpack[ApiParams],
     ) -> None:
@@ -639,7 +637,7 @@ def get_mcp_token(self) -> Optional[str]:
         return self._mcp_token
 
     @classmethod
-    def _cls_connect(
+    def _cls_connect_sandbox(
         cls,
         sandbox_id: str,
         timeout: Optional[int] = None,