Fix Python SDK type issues with ty type checker #1122

mishushakov · 2026-02-09T13:17:52Z

Summary

Resolved 43 type diagnostics reported by ty (Astral's Python type checker)
Fixed Self type issues on class singletons
Added explicit type annotations for shadowed attributes
Replaced None with UNSET for auto-generated API parameters
Fixed method signature alignment for protocol matching
Added targeted type: ignore suppressions for pattern-based limitations

All checks pass: ty check, ruff format, ruff check.

Note

Medium Risk
Mostly type-safety and CI additions, but it touches sandbox connection/creation code paths and subtly changes accepted/returned types (e.g., optional tokens/domains and UNSET vs None), which could affect API behavior if assumptions were relied on.

Overview
Adds a new PR typechecking gate and wires up monorepo typecheck scripts. A new Typecheck GitHub Action runs pnpm run typecheck, with package-level typecheck scripts added for the JS SDK, CLI, and Python SDK.

Introduces ty for the Python SDK and fixes ty-reported typing issues. This adds ty as a dev dependency plus ty/basedpyright config and a make typecheck target, and updates Python SDK code to satisfy stricter typing (e.g., removing Self singletons, making some tokens/domains Optional, aligning overloads via @staticmethod + renamed _cls_connect_sandbox, casting generated-model fields/params, using UNSET instead of None for optional API query params, and adding targeted ty ignores in tests).

^{Written by Cursor Bugbot for commit be1f50b. This will update automatically on new commits. Configure here.}

Resolve 43 type diagnostics reported by ty (Astral's Python type checker). Changes include: - Fixed Self type on class singletons to use concrete forward references - Added explicit type annotations for instance attributes shadowing static methods - Replaced None with UNSET sentinel for optional auto-generated API parameters - Fixed protocol mismatches and method signatures to align types - Added type: ignore suppressions for class_method_variant overload patterns and protocol structural subtyping edge cases All checks pass: ty check, ruff format, ruff check. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

changeset-bot · 2026-02-09T13:17:56Z

🦋 Changeset detected

Latest commit: be1f50b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@e2b/python-sdk	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@overload

The @overload declarations mixing @staticmethod/@classmethod with regular methods are fundamentally invalid in Python's type system. Remove them and keep only the @class_method_variant implementation. The runtime behavior (calling as both instance and class method) is unchanged via the descriptor. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

- Fix DockerfileParserInterface protocol: simplify copy.src to str (matching actual usage in parse_dockerfile), remove unused CopyItem import - Fix metadata type: use cast(Dict[str, str], ...) for auto-generated Union[Unset, Any] field after isinstance narrowing - Fix mcp type: use cast(Any, mcp) to bridge SDK McpServer type with auto-generated McpType0 (different representations of same data) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…d-override The child classes' _cls_connect returns Self while the parent returns the API Sandbox model. Renaming avoids the incompatible override. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Extract Unset isinstance checks into local variables for readability. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

The downstream SandboxOpts types it as Optional[str] and checks `is not None`, so an empty string would incorrectly pass through. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

mishushakov · 2026-02-09T14:28:58Z

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

            },
            headers=headers,
-            token=token,
+            token=token or "",


this is fine

E2B/packages/python-sdk/e2b/api/client/client.py

Lines 265 to 267 in 12c8d6e

self._headers[self.auth_header_name] = (

f"{self.prefix} {self.token}" if self.prefix else self.token

)

Use self: str overloads to tell the type checker that methods like Sandbox.kill("sandbox_id") and sandbox.kill() are both valid call patterns. This avoids mixing @classmethod with instance method overloads (which ty rejects as invalid-overload). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Switch from `self: str` overloads to `@classmethod` overloads so basedpyright can resolve the class method variants. Configure ty to ignore `invalid-overload` since the pattern is intentional. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

@staticmethod

Switch from @classmethod to @staticmethod on overloads to match the original code. @staticmethod doesn't add cls parameter so the parameter count stays consistent with the implementation, avoiding basedpyright's reportInconsistentOverload. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

The class_method_variant pattern (dual instance/static dispatch) is inherently inexpressible in Python's type system, so the overload implementation can never match the static overload signature. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add a CI workflow that runs type checking on PRs, mirroring the lint workflow. Add typecheck scripts to all packages (tsc for JS/TS, ty for Python). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

.github/workflows/typecheck.yml

…in permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

@staticmethod

- Suppress no-matching-overload globally (ty bug with @staticmethod overloads) - Add per-path overrides for generated API client models and protobuf stubs - Add type annotations to test data dicts to fix union type inference - Add inline ty:ignore for pytest.skip false positives - Remove now-redundant inline suppression comments Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

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

packages/python-sdk/e2b/connection_config.py

Revert `mcp` from `is not None` check back to truthiness check so empty dicts are treated as UNSET. Remove unnecessary local alias in get_sandbox_url and use self._sandbox_url directly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

mishushakov and others added 7 commits February 9, 2026 14:22

fix: rename _cls_connect to _cls_connect_sandbox to fix invalid-metho…

b68fb31

…d-override The child classes' _cls_connect returns Self while the parent returns the API Sandbox model. Renaming avoids the incompatible override. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

refactor: clean up SandboxCreateResponse construction

0a9376e

Extract Unset isinstance checks into local variables for readability. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

refactor: use res.parsed directly instead of local alias

9579ac6

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

chore: add ty type checker as dev dependency

6e169f7

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

fix: use None instead of empty string for missing envd_access_token

5a41999

The downstream SandboxOpts types it as Optional[str] and checks `is not None`, so an empty string would incorrectly pass through. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

mishushakov commented Feb 9, 2026

View reviewed changes

mishushakov and others added 7 commits February 9, 2026 16:01

docs: restore docstrings on overloaded method variants

ccf8f2a

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

ci: add typecheck workflow and pnpm typecheck script

cadbcfc

Add a CI workflow that runs type checking on PRs, mirroring the lint workflow. Add typecheck scripts to all packages (tsc for JS/TS, ty for Python). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

chore: remove typecheck script from apps/web

bf2e5e7

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

github-advanced-security bot found potential problems Feb 9, 2026

View reviewed changes

.github/workflows/typecheck.yml Fixed Show fixed Hide fixed

mishushakov and others added 3 commits February 9, 2026 17:03

Potential fix for code scanning alert no. 14: Workflow does not conta…

4be79c5

…in permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Merge branch 'main' into mishushakov/fix-ty-type-errors

0a32a6c

mishushakov marked this pull request as ready for review February 9, 2026 18:03

mishushakov requested review from ValentaTomas and jakubno as code owners February 9, 2026 18:03

mishushakov added 2 commits February 9, 2026 19:52

added changeset

bc834ca

Merge branch 'main' into mishushakov/fix-ty-type-errors

ce1799a

cursor bot reviewed Feb 9, 2026

View reviewed changes

packages/python-sdk/e2b/sandbox_async/sandbox_api.py Outdated Show resolved Hide resolved

packages/python-sdk/e2b/connection_config.py Outdated Show resolved Hide resolved

mishushakov force-pushed the mishushakov/fix-ty-type-errors branch from 5b8435b to be1f50b Compare February 10, 2026 14:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Python SDK type issues with ty type checker #1122

Fix Python SDK type issues with ty type checker #1122

Uh oh!

mishushakov commented Feb 9, 2026 •

edited by cursor bot

Loading

Uh oh!

changeset-bot bot commented Feb 9, 2026 •

edited

Loading

Uh oh!

mishushakov Feb 9, 2026

Uh oh!

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	self._headers[self.auth_header_name] = (
	f"{self.prefix} {self.token}" if self.prefix else self.token
	)

Fix Python SDK type issues with ty type checker #1122

Are you sure you want to change the base?

Fix Python SDK type issues with ty type checker #1122

Uh oh!

Conversation

mishushakov commented Feb 9, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

changeset-bot bot commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

mishushakov Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

mishushakov commented Feb 9, 2026 •

edited by cursor bot

Loading

changeset-bot bot commented Feb 9, 2026 •

edited

Loading