Skip to content

[4/8] Define Python SDK public API surface#21896

Open
aibrahim-oai wants to merge 3 commits into
codex/python-sdk-cifrom
codex/python-sdk-public-root-api
Open

[4/8] Define Python SDK public API surface#21896
aibrahim-oai wants to merge 3 commits into
codex/python-sdk-cifrom
codex/python-sdk-public-root-api

Conversation

@aibrahim-oai
Copy link
Copy Markdown
Collaborator

@aibrahim-oai aibrahim-oai commented May 9, 2026

Why

The SDK package root should be the ergonomic public client API, not a dump of every generated app-server schema type. Generated models still need a supported import path, but callers should be able to tell which names are high-level SDK entrypoints and which names are protocol value models.

What

  • Define a curated root __all__ for clients, handles, input helpers, retry helpers, config, and public errors.
  • Add a types module as the supported home for generated app-server response, event, enum, and helper models.
  • Update docs and examples to import protocol/value models from the type module.
  • Add tests that lock root exports, type-module exports, star-import behavior, and example import hygiene.

Stack

  1. [1/8] Pin Python SDK runtime dependency #21891 [1/8] Pin Python SDK runtime dependency
  2. [2/8] Generate Python SDK types from pinned runtime #21893 [2/8] Generate Python SDK types from pinned runtime
  3. [3/8] Run Python SDK tests in CI #21895 [3/8] Run Python SDK tests in CI
  4. This PR [4/8] Define Python SDK public API surface
  5. [5/8] Rename Python SDK package to openai-codex #21905 [5/8] Rename Python SDK package to openai-codex
  6. [6/8] Add high-level Python SDK approval mode #21910 [6/8] Add high-level Python SDK approval mode
  7. [7/8] Add Python SDK app-server integration harness #22014 [7/8] Add Python SDK app-server integration harness
  8. [8/8] Add Python SDK Ruff formatting #22021 [8/8] Add Python SDK Ruff formatting

Verification

  • Added public API signature tests for root exports, types exports, and example imports.

Co-authored-by: Codex <noreply@openai.com>
@aibrahim-oai
Copy link
Copy Markdown
Collaborator Author

aibrahim-oai and others added 2 commits May 9, 2026 10:39
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
@aibrahim-oai aibrahim-oai changed the title [4/4] Narrow Python SDK root exports [4/4] Define Python SDK public API surface May 9, 2026
@aibrahim-oai aibrahim-oai changed the title [4/4] Define Python SDK public API surface [4/4] Define Python SDK public package surface May 9, 2026
@aibrahim-oai aibrahim-oai force-pushed the codex/python-sdk-public-root-api branch from 78c0d5c to 9306e60 Compare May 9, 2026 08:43
@aibrahim-oai aibrahim-oai changed the title [4/4] Define Python SDK public package surface [4/5] Define Python SDK public API surface May 9, 2026
@aibrahim-oai aibrahim-oai changed the title [4/5] Define Python SDK public API surface [4/6] Define Python SDK public API surface May 9, 2026
@aibrahim-oai aibrahim-oai changed the title [4/6] Define Python SDK public API surface [4/7] Define Python SDK public API surface May 10, 2026
@aibrahim-oai aibrahim-oai changed the title [4/7] Define Python SDK public API surface [4/8] Define Python SDK public API surface May 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant