Skip to content

feat(types): prepare native synchronous WebSocket option type - #4118

Merged
markstuart-oai merged 2 commits into
mainfrom
fix/python-ws-native-sync-option-types
Oct 19, 2026
Merged

markstuart-oai merged 2 commits into
mainfrom
fix/python-ws-native-sync-option-types

Conversation

@markstuart-oai

Copy link
Copy Markdown
Contributor

The synchronous WebSocket client never supports write_limit; its max_queue option requires websockets 14 or newer. The SDK currently describes both sync and async connections with one options type.

Add SyncWebSocketConnectionOptions to the SDK-owned options module with the five sync fields and the version note. Keep the existing WebSocketConnectionOptions and legacy WebsocketConnectionOptions alias fully compatible for async callers. This prepares the owned type for a separate generated-code update: current generated sync method annotations and the top-level export are unchanged in this PR.

Validation: the new type contract failed before the change and passes afterward. Full Pyright, Mypy (2,036 files), Ruff and formatting passed. After rebasing onto the latest recovery fix, 132 focused options, recovery, Live and Translation checks pass; targeted Pyright remains clean. The trusted budget check passes at the current PR head.

@markstuart-oai
markstuart-oai requested a review from a team as a code owner October 19, 2026 22:11
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-19T22:13:16.678103Z a575a38 PR opened
🔒 Security Review ✅ Completed 2026-10-19T22:13:37.569243Z a575a38 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@openai-sdks

openai-sdks Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 9.372s for Python SDK PR #4118.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 222ms
tests/chat-completions-create.test.ts ✅ Passed 268ms
tests/chat-completions-stream.test.ts ✅ Passed 305ms
tests/files-content-binary.test.ts ✅ Passed 212ms
tests/files-create-multipart.test.ts ✅ Passed 229ms
tests/files-list-pagination.test.ts ✅ Passed 236ms
tests/initialize-config.test.ts ✅ Passed 166ms
tests/instance-isolation.test.ts ✅ Passed 193ms
tests/models-list.test.ts ✅ Passed 238ms
tests/responses-background-lifecycle.test.ts ✅ Passed 175ms
tests/responses-body-method-errors.test.ts ✅ Passed 306ms
tests/responses-cancel-timeout.test.ts ✅ Passed 226ms
tests/responses-cancel.test.ts ✅ Passed 187ms
tests/responses-compact-retries.test.ts ✅ Passed 325ms
tests/responses-compact.test.ts ✅ Passed 210ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 154ms
tests/responses-create-advanced.test.ts ✅ Passed 232ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.305s
tests/responses-create-errors.test.ts ✅ Passed 207ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 510ms
tests/responses-create-retries.test.ts ✅ Passed 232ms
tests/responses-create-stream-failures.test.ts ✅ Passed 211ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 238ms
tests/responses-create-stream-wire.test.ts ✅ Passed 2.095s
tests/responses-create-stream.test.ts ✅ Passed 384ms
tests/responses-create-terminal-states.test.ts ✅ Passed 222ms
tests/responses-create-timeout.test.ts ✅ Passed 234ms
tests/responses-create.test.ts ✅ Passed 397ms
tests/responses-delete.test.ts ✅ Passed 347ms
tests/responses-input-items-errors.test.ts ✅ Passed 560ms
tests/responses-input-items-list.test.ts ✅ Passed 333ms
tests/responses-input-items-options.test.ts ✅ Passed 350ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 282ms
tests/responses-input-tokens-count.test.ts ✅ Passed 196ms
tests/responses-malformed-inputs.test.ts ✅ Passed 1.089s
tests/responses-not-found-errors.test.ts ✅ Passed 252ms
tests/responses-parse.test.ts ✅ Passed 293ms
tests/responses-retrieve-retries.test.ts ✅ Passed 226ms
tests/responses-retrieve.test.ts ✅ Passed 208ms
tests/responses-stored-method-errors.test.ts ✅ Passed 448ms
tests/retry-behavior.test.ts ✅ Passed 3.065s
tests/sdk-error-shape.test.ts ✅ Passed 287ms

View OkTest run #39333812392

SDK merge (32fbbfa3d582) · head (07bcd9a18ddd) · base (163a2966140b) · OkTest (72fd4dca457e)

@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Castiron custom code

Evaluated main: 163a2966140bc0399af7d81e03580d9d907a51df.

Trusted main policy: 163a2966140bc0399af7d81e03580d9d907a51df.

✅ No new custom-code files detected.

39 mixed files remain; 0 existing customizations changed.

Compared 163a2966140b → 07bcd9a18ddd. Generated baselines verified.

39 existing customizations unchanged
  • api.md
  • src/openai/init.py
  • src/openai/_client.py
  • src/openai/resources/audio/transcriptions.py
  • src/openai/resources/audio/translations.py
  • src/openai/resources/beta/agents/environments/files.py
  • src/openai/resources/beta/agents/sessions/artifacts.py
  • src/openai/resources/beta/agents/sessions/sessions.py
  • src/openai/resources/beta/beta.py
  • src/openai/resources/beta/responses/responses.py
  • src/openai/resources/beta/threads/runs/runs.py
  • src/openai/resources/beta/threads/threads.py
  • src/openai/resources/chat/completions/completions.py
  • src/openai/resources/embeddings.py
  • src/openai/resources/files.py
  • src/openai/resources/live/forks.py
  • src/openai/resources/live/live.py
  • src/openai/resources/live/sideband.py
  • src/openai/resources/realtime/api.md
  • src/openai/resources/realtime/realtime.py
  • src/openai/resources/realtime/translations/translations.py
  • src/openai/resources/responses/responses.py
  • src/openai/resources/uploads/uploads.py
  • src/openai/resources/vector_stores/file_batches.py
  • src/openai/resources/vector_stores/files.py
  • src/openai/resources/videos.py
  • src/openai/resources/webhooks/init.py
  • src/openai/resources/webhooks/webhooks.py
  • src/openai/types/decision_input_image_param.py
  • src/openai/types/decision_input_text_param.py
  • src/openai/types/fine_tuning/fine_tuning_job_integration.py
  • src/openai/types/realtime/conversation_item_input_audio_transcription_delta_event.py
  • src/openai/types/realtime/realtime_error_event.py
  • src/openai/types/responses/tool.py
  • src/openai/types/responses/tool_param.py
  • src/openai/types/webhooks/init.py
  • src/openai/types/webhooks/live_call_incoming_webhook_event.py
  • src/openai/types/webhooks/unwrap_webhook_event.py
  • tests/api_resources/test_videos.py

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 39333875920 --repo openai/openai-python \
  --name castiron-custom-code-39333875920-1 --dir /tmp/castiron-custom-code-39333875920-1
git apply --stat /tmp/castiron-custom-code-39333875920-1/custom-code.patch
cat /tmp/castiron-custom-code-39333875920-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin 163a2966140bc0399af7d81e03580d9d907a51df 07bcd9a18dddea892ccd9bd209d4964d1f38b35c
python3 scripts/castiron/custom_code_report.py report \
  --base 163a2966140bc0399af7d81e03580d9d907a51df \
  --head 07bcd9a18dddea892ccd9bd209d4964d1f38b35c --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-07bcd9a18ddd
cat /tmp/castiron-custom-code-07bcd9a18ddd/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

Comment thread tests/test_websocket_connection_options.py Fixed
@markstuart-oai
markstuart-oai added this pull request to the merge queue Oct 19, 2026

@jbeckwith-oai jbeckwith-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed both changed files at 07bcd9a with an independent static review. No actionable findings. The new sync TypedDict excludes write_limit while the existing async fields and compatibility alias remain intact. The corrected type contract preserves the negative assignment check without unused variables. Generated annotation adoption is intentionally a follow-up. Hosted CI passed/skipped and exact-head OkTest reports 236/236 passing. No candidate code or tests executed locally.

Merged via the queue into main with commit 90c0bac Oct 19, 2026
31 checks passed
@markstuart-oai
markstuart-oai deleted the fix/python-ws-native-sync-option-types branch October 19, 2026 22:32
@openai-sdks openai-sdks Bot mentioned this pull request Oct 19, 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.

3 participants