Skip to content

fix: preserve declared aliases during Pydantic v1 validation - #4119

Merged
markstuart-oai merged 1 commit into
mainfrom
fix/python-validated-alias-collision
Oct 20, 2026
Merged

markstuart-oai merged 1 commit into
mainfrom
fix/python-validated-alias-collision

Conversation

@markstuart-oai

Copy link
Copy Markdown
Contributor

With Pydantic v1, a valid Responses function call containing both "async": true and an extra "async_": "future" can replace the validated boolean with that extra value. The same problem affects nested validated SDK models with other aliased fields.

Preserve the declared wire field during Pydantic v1 validation and discard only the colliding extra. Keep unrelated extra fields, input dictionaries, and keys used as another declared wire alias intact. Pydantic v2 and loose construction keep their existing behavior.

Tests cover public synchronous and asynchronous Responses parsing, valid and future union variants, generic models, and overlapping declared aliases. On Python 3.10, the focused model tests pass on the minimum supported Pydantic 1.10.13 and on 1.10.26 (66 passed, 13 existing v2-only skips); Pydantic 2.12.5 passes all 79. Broader model and WebSocket suites pass with v1 (1,634 passed, 13 skipped) and v2 (1,647 passed). Ruff, Pyright, mypy, and the exact-commit custom-code budget pass.

The shared model base is SDK-owned and absent from the current generated-file manifest. This change does not require regeneration.

@markstuart-oai
markstuart-oai requested a review from a team as a code owner October 19, 2026 22:56
@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:59:01.413283Z 912bc69 PR opened
🔒 Security Review ✅ Completed 2026-10-19T23:00:32.158915Z 912bc69 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.582s for Python SDK PR #4119.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 201ms
tests/chat-completions-create.test.ts ✅ Passed 274ms
tests/chat-completions-stream.test.ts ✅ Passed 319ms
tests/files-content-binary.test.ts ✅ Passed 317ms
tests/files-create-multipart.test.ts ✅ Passed 236ms
tests/files-list-pagination.test.ts ✅ Passed 293ms
tests/initialize-config.test.ts ✅ Passed 187ms
tests/instance-isolation.test.ts ✅ Passed 272ms
tests/models-list.test.ts ✅ Passed 245ms
tests/responses-background-lifecycle.test.ts ✅ Passed 208ms
tests/responses-body-method-errors.test.ts ✅ Passed 372ms
tests/responses-cancel-timeout.test.ts ✅ Passed 236ms
tests/responses-cancel.test.ts ✅ Passed 247ms
tests/responses-compact-retries.test.ts ✅ Passed 330ms
tests/responses-compact.test.ts ✅ Passed 316ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 220ms
tests/responses-create-advanced.test.ts ✅ Passed 227ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.178s
tests/responses-create-errors.test.ts ✅ Passed 232ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 544ms
tests/responses-create-retries.test.ts ✅ Passed 240ms
tests/responses-create-stream-failures.test.ts ✅ Passed 229ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 240ms
tests/responses-create-stream-wire.test.ts ✅ Passed 2.114s
tests/responses-create-stream.test.ts ✅ Passed 128ms
tests/responses-create-terminal-states.test.ts ✅ Passed 309ms
tests/responses-create-timeout.test.ts ✅ Passed 234ms
tests/responses-create.test.ts ✅ Passed 305ms
tests/responses-delete.test.ts ✅ Passed 199ms
tests/responses-input-items-errors.test.ts ✅ Passed 580ms
tests/responses-input-items-list.test.ts ✅ Passed 357ms
tests/responses-input-items-options.test.ts ✅ Passed 273ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 290ms
tests/responses-input-tokens-count.test.ts ✅ Passed 217ms
tests/responses-malformed-inputs.test.ts ✅ Passed 1.109s
tests/responses-not-found-errors.test.ts ✅ Passed 272ms
tests/responses-parse.test.ts ✅ Passed 261ms
tests/responses-retrieve-retries.test.ts ✅ Passed 229ms
tests/responses-retrieve.test.ts ✅ Passed 237ms
tests/responses-stored-method-errors.test.ts ✅ Passed 555ms
tests/retry-behavior.test.ts ✅ Passed 2.99s
tests/sdk-error-shape.test.ts ✅ Passed 308ms

View OkTest run #39338414126

SDK merge (0cb647c6adf7) · head (912bc698beae) · base (90c0bacc07dd) · OkTest (72fd4dca457e)

@github-actions

Copy link
Copy Markdown
Contributor

Castiron custom code

Evaluated main: 90c0bacc07ddd5662598db52b3c3011973011973.

Trusted main policy: 90c0bacc07ddd5662598db52b3c3011973011973.

✅ No new custom-code files detected.

39 mixed files remain; 0 existing customizations changed.

Compared 90c0bacc07dd → 912bc698beae. 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 39338454215 --repo openai/openai-python \
  --name castiron-custom-code-39338454215-1 --dir /tmp/castiron-custom-code-39338454215-1
git apply --stat /tmp/castiron-custom-code-39338454215-1/custom-code.patch
cat /tmp/castiron-custom-code-39338454215-1/custom-code.patch

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

git fetch --no-tags origin 90c0bacc07ddd5662598db52b3c3011973011973 912bc698beae3126892cff0009d62804187fd237
python3 scripts/castiron/custom_code_report.py report \
  --base 90c0bacc07ddd5662598db52b3c3011973011973 \
  --head 912bc698beae3126892cff0009d62804187fd237 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-912bc698beae
cat /tmp/castiron-custom-code-912bc698beae/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

@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.

Approved at 912bc69. Two static reviews found no actionable issues across the complete three-file diff and relevant Pydantic v1 validation, nested/generic model, and Responses parsing paths. The pre-validator preserves declared wire aliases, retains keys consumed by other declared aliases, and avoids mutating caller input. Pydantic v2 and loose construction are unchanged.

Hosted checks are successful/skipped, and the exact-head OkTest report records 236/236 passed. No candidate code or tests were executed for this review.

@markstuart-oai
markstuart-oai added this pull request to the merge queue Oct 20, 2026
Merged via the queue into main with commit 8b1cac9 Oct 20, 2026
31 checks passed
@markstuart-oai
markstuart-oai deleted the fix/python-validated-alias-collision branch October 20, 2026 00:26
@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