chore: add python type checking

Author: dobrac

packages/python-sdk/Makefile

@@ -25,6 +25,7 @@ init:
 
 lint:
 	ruff check .
+	pyright
 
 format:
 	ruff format .

packages/python-sdk/e2b/__init__.py

@@ -31,41 +31,39 @@
 )
 from .connection_config import (
     ConnectionConfig,
-    ProxyTypes,
 )
 from .exceptions import (
-    SandboxException,
-    TimeoutException,
-    NotFoundException,
     AuthenticationException,
+    BuildException,
+    FileUploadException,
     InvalidArgumentException,
     NotEnoughSpaceException,
+    NotFoundException,
+    SandboxException,
     TemplateException,
-    BuildException,
-    FileUploadException,
+    TimeoutException,
 )
 from .sandbox.commands.command_handle import (
-    CommandResult,
-    Stderr,
-    Stdout,
     CommandExitException,
+    CommandResult,
     PtyOutput,
     PtySize,
+    Stderr,
+    Stdout,
 )
 from .sandbox.commands.main import ProcessInfo
-from .sandbox.filesystem.filesystem import EntryInfo, WriteInfo, FileType
+from .sandbox.filesystem.filesystem import EntryInfo, FileType, WriteInfo
 from .sandbox.filesystem.watch_handle import (
     FilesystemEvent,
     FilesystemEventType,
 )
 from .sandbox.sandbox_api import (
-    SandboxInfo,
-    SandboxQuery,
-    SandboxState,
-    SandboxMetrics,
-    McpServer,
     GitHubMcpServer,
     GitHubMcpServerConfig,
+    McpServer,
+    SandboxInfo,
+    SandboxMetrics,
+    SandboxQuery,
 )
 from .sandbox_async.commands.command_handle import AsyncCommandHandle
 from .sandbox_async.filesystem.watch_handle import AsyncWatchHandle
@@ -78,21 +76,21 @@
 from .sandbox_sync.paginator import SandboxPaginator
 from .template.logger import (
     LogEntry,
+    LogEntryEnd,
     LogEntryLevel,
     LogEntryStart,
-    LogEntryEnd,
     default_build_logger,
 )
 from .template.main import TemplateBase, TemplateClass
 from .template.readycmd import (
     ReadyCmd,
     wait_for_file,
-    wait_for_url,
     wait_for_port,
     wait_for_process,
     wait_for_timeout,
+    wait_for_url,
 )
-from .template.types import CopyItem, BuildInfo
+from .template.types import BuildInfo, CopyItem
 from .template_async.main import AsyncTemplate
 from .template_sync.main import Template
 
@@ -102,7 +100,6 @@
     "client",
     # Connection config
     "ConnectionConfig",
-    "ProxyTypes",
     # Exceptions
     "SandboxException",
     "TimeoutException",
@@ -118,7 +115,6 @@
     "SandboxMetrics",
     "ProcessInfo",
     "SandboxQuery",
-    "SandboxState",
     "SandboxMetrics",
     # Command handle
     "CommandResult",

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

@@ -1,20 +1,21 @@
-import os
-from types import TracebackType
 import json
 import logging
-from typing import Optional, Union
-from httpx import Limits, BaseTransport, AsyncBaseTransport
+import os
 from dataclasses import dataclass
+from types import TracebackType
+from typing import Any, Optional, Union
+
+from httpx import AsyncBaseTransport, BaseTransport, Limits
 
 from e2b.api.client.client import AuthenticatedClient
-from e2b.connection_config import ConnectionConfig
+from e2b.api.client.types import Response
 from e2b.api.metadata import default_headers
+from e2b.connection_config import ConnectionConfig
 from e2b.exceptions import (
     AuthenticationException,
-    SandboxException,
     RateLimitException,
+    SandboxException,
 )
-from e2b.api.client.types import Response
 
 logger = logging.getLogger(__name__)
 
@@ -34,7 +35,7 @@ class SandboxCreateResponse:
 
 
 def handle_api_exception(
-    e: Response,
+    e: Response[Any],
     default_exception_class: type[Exception] = SandboxException,
     stack_trace: Optional[TracebackType] = None,
 ):
@@ -106,6 +107,11 @@ def __init__(
                 )
             token = config.access_token
 
+        if token is None:
+            raise AuthenticationException(
+                "Authentication token is required but not provided.",
+            )
+
         auth_header_name = "X-API-KEY" if require_api_key else "Authorization"
         prefix = "" if require_api_key else "Bearer"
 
@@ -115,7 +121,7 @@ def __init__(
         }
 
         # Prevent passing these parameters twice
-        more_headers: Optional[dict] = kwargs.pop("headers", None)
+        more_headers: Optional[dict[str, str]] = kwargs.pop("headers", None)
         if more_headers:
             headers.update(more_headers)
         kwargs.pop("token", None)
@@ -143,7 +149,7 @@ def __init__(
     def _log_request(self, request):
         logger.info(f"Request {request.method} {request.url}")
 
-    def _log_response(self, response: Response):
+    def _log_response(self, response: Response[Any]):
         if response.status_code >= 400:
             logger.error(f"Response {response.status_code}")
         else:
@@ -155,7 +161,7 @@ class AsyncApiClient(ApiClient):
     async def _log_request(self, request):
         logger.info(f"Request {request.method} {request.url}")
 
-    async def _log_response(self, response: Response):
+    async def _log_response(self, response: Response[Any]):
         if response.status_code >= 400:
             logger.error(f"Response {response.status_code}")
         else:

packages/python-sdk/e2b/connection_config.py

@@ -1,6 +1,5 @@
 import os
-
-from typing import Optional, Dict, TypedDict
+from typing import Any, Dict, Optional, TypedDict
 
 from httpx._types import ProxyTypes
 from typing_extensions import Unpack
@@ -117,7 +116,7 @@ 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 = sandbox_url or ConnectionConfig._sandbox_url()
 
     @staticmethod
     def _get_request_timeout(
@@ -135,8 +134,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
+        url = self._sandbox_url()
+        if url is not None:
+            return url
 
         return f"{'http' if self.debug else 'https'}://{self.get_host(sandbox_id, sandbox_domain, self.envd_port)}"
 
@@ -159,7 +159,7 @@ def get_host(self, sandbox_id: str, sandbox_domain: str, port: int) -> str:
     def get_api_params(
         self,
         **opts: Unpack[ApiParams],
-    ) -> dict:
+    ) -> dict[str, Any]:
         """
         Get the parameters for the API call.
 

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

@@ -1,20 +1,19 @@
 import urllib.parse
-from packaging.version import Version
-
 from typing import Optional, TypedDict
 
-from e2b.sandbox.signature import get_signature
+from packaging.version import Version
+
 from e2b.connection_config import ConnectionConfig, default_username
 from e2b.envd.api import ENVD_API_FILES_ROUTE
 from e2b.envd.versions import ENVD_DEFAULT_USER
+from e2b.sandbox.signature import get_signature
 
 
 class SandboxOpts(TypedDict):
     sandbox_id: str
     sandbox_domain: Optional[str]
     envd_version: Version
     envd_access_token: Optional[str]
-    sandbox_url: Optional[str]
     connection_config: ConnectionConfig
 
 
@@ -66,7 +65,7 @@ def _envd_version(self) -> Version:
         return self.__envd_version
 
     @property
-    def sandbox_domain(self) -> Optional[str]:
+    def sandbox_domain(self) -> str:
         return self.__sandbox_domain
 
     @property

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

@@ -1,20 +1,22 @@
 from typing import Dict, List, Literal, Optional, Union, overload
 
-import e2b_connect
 import httpcore
 from packaging.version import Version
+
+import e2b_connect
 from e2b.connection_config import (
-    ConnectionConfig,
-    Username,
     KEEPALIVE_PING_HEADER,
     KEEPALIVE_PING_INTERVAL_SEC,
+    ConnectionConfig,
+    Username,
+    default_username,
 )
 from e2b.envd.process import process_connect, process_pb2
 from e2b.envd.rpc import authentication_header, handle_rpc_exception
-from e2b.envd.versions import ENVD_COMMANDS_STDIN
+from e2b.envd.versions import ENVD_COMMANDS_STDIN, ENVD_DEFAULT_USER
 from e2b.exceptions import SandboxException
-from e2b.sandbox.commands.main import ProcessInfo
 from e2b.sandbox.commands.command_handle import CommandResult
+from e2b.sandbox.commands.main import ProcessInfo
 from e2b.sandbox_async.commands.command_handle import AsyncCommandHandle, Stderr, Stdout
 from e2b.sandbox_async.utils import OutputHandler
 
@@ -220,10 +222,14 @@ async def run(
         # Default to `False`
         stdin = stdin or False
 
+        username = user
+        if username is None and self._envd_version < ENVD_DEFAULT_USER:
+            username = default_username
+
         proc = await self._start(
             cmd,
             envs,
-            user,
+            username,
             cwd,
             timeout,
             request_timeout,
@@ -238,7 +244,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

@@ -1,27 +1,26 @@
 import datetime
+import json
 import logging
-import httpx
 import uuid
-import json
-
-from typing import Dict, Optional, overload, List
+from typing import Dict, List, Optional, overload
 
+import httpx
 from packaging.version import Version
-from typing_extensions import Unpack, Self
+from typing_extensions import Self, Unpack
 
 from e2b.api.client.types import Unset
-from e2b.connection_config import ConnectionConfig, ApiParams
+from e2b.api.client_async import get_transport
+from e2b.connection_config import ApiParams, ConnectionConfig
 from e2b.envd.api import ENVD_API_HEALTH_ROUTE, ahandle_envd_api_exception
 from e2b.envd.versions import ENVD_DEBUG_FALLBACK
-from e2b.exceptions import format_request_timeout_error, SandboxException
+from e2b.exceptions import SandboxException, format_request_timeout_error
 from e2b.sandbox.main import SandboxOpts
-from e2b.sandbox.sandbox_api import SandboxMetrics, McpServer
+from e2b.sandbox.sandbox_api import McpServer, SandboxMetrics
 from e2b.sandbox.utils import class_method_variant
-from e2b.sandbox_async.filesystem.filesystem import Filesystem
 from e2b.sandbox_async.commands.command import Commands
 from e2b.sandbox_async.commands.pty import Pty
+from e2b.sandbox_async.filesystem.filesystem import Filesystem
 from e2b.sandbox_async.sandbox_api import SandboxApi, SandboxInfo
-from e2b.api.client_async import get_transport
 
 logger = logging.getLogger(__name__)
 
@@ -659,9 +658,13 @@ async def _cls_connect(
 
         return cls(
             sandbox_id=sandbox.sandbox_id,
-            sandbox_domain=sandbox.domain,
+            sandbox_domain=sandbox.domain
+            if not isinstance(sandbox.domain, Unset)
+            else None,
             envd_version=Version(sandbox.envd_version),
-            envd_access_token=envd_access_token,
+            envd_access_token=envd_access_token
+            if not isinstance(envd_access_token, Unset)
+            else None,
             connection_config=connection_config,
         )