Skip to content

fix(api): prioritize routing fields in parse helpers - #4016

Merged
jbeckwith-oai merged 1 commit into
mainfrom
codex/fix-parse-request-routing-order
Oct 2, 2026
Merged

jbeckwith-oai merged 1 commit into
mainfrom
codex/fix-parse-request-routing-order

Conversation

@jbeckwith-oai

Copy link
Copy Markdown
Contributor

Summary

Ensure structured-output request helpers place model, stream, and service_tier before potentially large input or messages fields.

Changes

  • Apply routing-field priority to sync and async Responses.parse requests.
  • Apply the same priority to sync and async chat.completions.parse requests.
  • Preserve signatures, values, remaining field order, and omitted-field behavior.

Test plan

  • uv run --frozen --all-extras pytest tests/test_request_body_routing_order.py -q
  • uv run --frozen --all-extras ruff check src/openai/resources/responses/responses.py src/openai/resources/chat/completions/completions.py tests/test_request_body_routing_order.py
  • uv run --frozen --all-extras ruff format --check src/openai/resources/responses/responses.py src/openai/resources/chat/completions/completions.py tests/test_request_body_routing_order.py
  • git diff --check

@jbeckwith-oai
jbeckwith-oai requested a review from a team as a code owner October 2, 2026 04:35
@openai-sdks

openai-sdks Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 10.256s for Python SDK PR #4016.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 133ms
tests/chat-completions-create.test.ts ✅ Passed 298ms
tests/chat-completions-stream.test.ts ✅ Passed 222ms
tests/files-content-binary.test.ts ✅ Passed 174ms
tests/files-create-multipart.test.ts ✅ Passed 226ms
tests/files-list-pagination.test.ts ✅ Passed 124ms
tests/initialize-config.test.ts ✅ Passed 131ms
tests/instance-isolation.test.ts ✅ Passed 163ms
tests/models-list.test.ts ✅ Passed 230ms
tests/responses-background-lifecycle.test.ts ✅ Passed 180ms
tests/responses-body-method-errors.test.ts ✅ Passed 392ms
tests/responses-cancel-timeout.test.ts ✅ Passed 218ms
tests/responses-cancel.test.ts ✅ Passed 210ms
tests/responses-compact-retries.test.ts ✅ Passed 285ms
tests/responses-compact.test.ts ✅ Passed 269ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 165ms
tests/responses-create-advanced.test.ts ✅ Passed 233ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.108s
tests/responses-create-errors.test.ts ✅ Passed 195ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 414ms
tests/responses-create-retries.test.ts ✅ Passed 199ms
tests/responses-create-stream-failures.test.ts ✅ Passed 250ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 205ms
tests/responses-create-stream-wire.test.ts ✅ Passed 3.087s
tests/responses-create-stream.test.ts ✅ Passed 111ms
tests/responses-create-terminal-states.test.ts ✅ Passed 232ms
tests/responses-create-timeout.test.ts ✅ Passed 225ms
tests/responses-create.test.ts ✅ Passed 287ms
tests/responses-delete.test.ts ✅ Passed 159ms
tests/responses-input-items-errors.test.ts ✅ Passed 363ms
tests/responses-input-items-list.test.ts ✅ Passed 342ms
tests/responses-input-items-options.test.ts ✅ Passed 289ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 343ms
tests/responses-input-tokens-count.test.ts ✅ Passed 172ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.184s
tests/responses-not-found-errors.test.ts ✅ Passed 283ms
tests/responses-parse.test.ts ✅ Passed 208ms
tests/responses-retrieve-retries.test.ts ✅ Passed 204ms
tests/responses-retrieve.test.ts ✅ Passed 178ms
tests/responses-stored-method-errors.test.ts ✅ Passed 564ms
tests/retry-behavior.test.ts ✅ Passed 3.068s
tests/sdk-error-shape.test.ts ✅ Passed 313ms

View OkTest run #36965250532

SDK merge (d0df96698faf) · head (37bd842f06a4) · base (ffcc4c47279d) · OkTest (92ff272954a1)

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 2, 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-02T04:38:14.976975Z 37bd842 PR opened
🔒 Security Review ✅ Completed 2026-10-02T04:38:01.292171Z 37bd842 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.

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Castiron custom code

Evaluated main: ffcc4c47279debd9daff6103da57dcde2efd38bd.

✅ No new custom-code files detected.

49 mixed files remain; 2 existing customizations changed.

Compared ffcc4c47279d → 37bd842f06a4. Generated baselines verified.

File Result Current custom patch
src/openai/resources/chat/completions/completions.py Existing customization changed +603 / −1
src/openai/resources/responses/responses.py Existing customization changed +1026 / −137
47 existing customizations unchanged
  • api.md
  • scripts/castiron/README.md
  • scripts/castiron/custom_code_report.py
  • scripts/castiron/test_custom_code_report.py
  • 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/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/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/beta/agent_session_message.py
  • src/openai/types/chat/init.py
  • src/openai/types/chat/chat_completion_message_tool_call.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/init.py
  • src/openai/types/responses/response.py
  • src/openai/types/responses/response_function_web_search.py
  • src/openai/types/responses/response_function_web_search_param.py
  • src/openai/types/responses/responses_client_event.py
  • src/openai/types/responses/responses_client_event_param.py

7 more in the full report.

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 36965280849 --repo openai/openai-python \
  --name castiron-custom-code-36965280849-1 --dir /tmp/castiron-custom-code-36965280849-1
git apply --stat /tmp/castiron-custom-code-36965280849-1/custom-code.patch
cat /tmp/castiron-custom-code-36965280849-1/custom-code.patch

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

git fetch --no-tags origin ffcc4c47279debd9daff6103da57dcde2efd38bd 37bd842f06a40f0f2df63513d1de31f6bd12effa
python3 scripts/castiron/custom_code_report.py report \
  --base ffcc4c47279debd9daff6103da57dcde2efd38bd \
  --head 37bd842f06a40f0f2df63513d1de31f6bd12effa --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-37bd842f06a4
cat /tmp/castiron-custom-code-37bd842f06a4/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

@markstuart-oai markstuart-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 all three changed files at 37bd842. No actionable findings. The four parse request dictionaries now prioritize model, stream and service_tier while preserving values, signatures, omission behavior and the relative order of other fields. The existing transform and JSON serialization paths preserve that order through the HTTP body. The new sync/async tests check the actual wire bytes for both explicit and omitted routing fields.

Source-only review; I did not execute repository tests locally. Hosted lint, build, Python 3.10/3.14, HTTPX2, baseline-consistency and custom-code budget checks passed on this head.

@jbeckwith-oai
jbeckwith-oai added this pull request to the merge queue Oct 2, 2026
Merged via the queue into main with commit ba53a10 Oct 2, 2026
26 checks passed
@jbeckwith-oai
jbeckwith-oai deleted the codex/fix-parse-request-routing-order branch October 2, 2026 04:53
@openai-sdks openai-sdks Bot mentioned this pull request Oct 2, 2026
gh-actions-shared Bot pushed a commit to xf-qubit/openai-python that referenced this pull request Oct 2, 2026
Automated Release PR
---


##
[3.24.0](openai/openai-python@v3.23.0...v3.24.0)
(2026-10-02)


### Features

* **api:** add custom voice creation and agent session events
([openai#4013](openai#4013))
([e5de2e5](openai@e5de2e5))


### Bug Fixes

* **api:** prioritize Python request routing fields
([openai#4014](openai#4014))
([ffcc4c4](openai@ffcc4c4))
* **api:** prioritize routing fields in parse helpers
([openai#4016](openai#4016))
([ba53a10](openai@ba53a10))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: openai-sdks[bot] <284451331+openai-sdks[bot]@users.noreply.github.com>
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.

2 participants