fix(azure): preserve deployment routing across copy/with_options - #3593
Conversation
AzureOpenAI.copy()/with_options() reconstructs the client from base_url via the base OpenAI.copy(), which does not pass azure_endpoint or azure_deployment. As a result _azure_endpoint and _azure_deployment were reset to None on the copy, so _prepare_url() no longer bypassed the deployment path for non-deployment endpoints. A client built with azure_deployment would then route e.g. /models to /openai/deployments/<deployment>/models instead of /openai/models, producing 404s after a copy. Preserve _azure_endpoint/_azure_deployment on the copied client unless the caller overrides base_url.
ting-hong-shieh
left a comment
ting-hong-shieh
left a comment
There was a problem hiding this comment.
Validated 59face1b on its original base and in a conflict-free synthetic merge onto current main at 721cb1cd; the latter includes the HTTPX2 migration that changed both files in this PR.
Using the same sync/async copy and with_options matrix, /models resolves outside the deployment path while /chat/completions retains /deployments/deployment-client. No Azure request or credentials were used.
Checks passed on the current-main merge:
pytest tests/lib/test_azure.py -q -n 0— 63 passed- Ruff 0.14.7 lint and format checks
- Pyright 1.1.399 and Mypy 1.17.0 on
src/openai/lib/azure.py git diff --check
I found no blocking issue.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Castiron custom code✅ No new custom-code files detected. 45 mixed files remain; 0 existing customizations changed. Compared 45 existing customizations unchanged
5 more in the full report. A changed generated baseline means this report cannot reliably identify which handwritten lines changed. Inspect the custom-code diffDownload the exact patch produced by this run (requires repository access): gh run download 35023839241 --repo openai/openai-python \
--name castiron-custom-code-35023839241-1 --dir /tmp/castiron-custom-code-35023839241-1
git apply --stat /tmp/castiron-custom-code-35023839241-1/custom-code.patch
cat /tmp/castiron-custom-code-35023839241-1/custom-code.patchOr reproduce it from an SDK checkout containing the vendored reporter: git fetch --no-tags origin ccc10f595ff606cf007459aecae6ddc90d02794a 77a34c695075269e2f79bc11144d324aa2252ec9
python3 scripts/castiron/custom_code_report.py report \
--base ccc10f595ff606cf007459aecae6ddc90d02794a \
--head 77a34c695075269e2f79bc11144d324aa2252ec9 --fetch --require-head-hash --public \
--out /tmp/castiron-custom-code-77a34c695075
cat /tmp/castiron-custom-code-77a34c695075/custom-code.patchThis is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR. |
3 participants
Changes being requested
Fixes a routing regression in
AzureOpenAI/AsyncAzureOpenAIafter.copy()/.with_options().This change is in hand-maintained code —
src/openai/lib/azure.pyhas noFile generated from our OpenAPI spec by Stainlessheader, andcopy()/with_options()there is custom Azure logic, so it is not affected by codegen.Problem
AzureOpenAI.copy()(aliased aswith_options()) delegates to the baseOpenAI.copy(), which reconstructs the client frombase_urland does not passazure_endpoint/azure_deploymentback toAzureOpenAI.__init__. Because_azure_endpointand_azure_deploymentare only set from those constructor arguments, they get reset toNoneon the copied client._prepare_url()uses those attributes to bypass the deployment path for non-deployment endpoints:Once they are
None, that bypass no longer runs, so a client configured withazure_deploymentstarts routing non-deployment endpoints (e.g./models) under the deployment path, which 404s.Reproduction (no network / key required)
Fix
Preserve
_azure_endpoint/_azure_deploymenton the copied client, unless the caller overridesbase_urlin the copy (in which case the old endpoint context is intentionally not carried over). Applied symmetrically to the sync and async clients.Why minimal
copy()in each of the two Azure clients changes; two guarded lines each.base_url/azure_endpointconstructor contract are untouched (the fix deliberately avoids passingazure_endpointalongsidebase_url)./chat/completions) are unaffected —base_urlalready encodes the deployment and_build_requestcontinues to guard on"/deployments" in base_url.path.Tests
Added
test_copy_preserves_deployment_routingintests/lib/test_azure.py(sync + async ×copy/with_options), asserting that after a copy:/models→{endpoint}/openai/models(not nested under/deployments/<name>/), and/chat/completionsstill keeps the deployment path.Fails on
main(wrong/modelsURL), passes with this change.Validation
rye run pytest tests/lib/test_azure.py→ 63 passedrye run pytest tests/lib/→ all pass except a pre-existing, unrelated failure (test_bedrock_auth_conformance.py::test_retry_signing_fixture, which fails identically on cleanmainin this environment)ruff check/ruff formatclean on both filespyrightandmypyclean onsrc/openai/lib/azure.pyCompatibility
No public API change; behavior only changes for the previously-broken post-copy case. Copies that override
base_urlkeep their current behavior.Additional context & links
Discovered by auditing sibling copy/state-preservation logic; no existing issue or PR covers this.
.with_options()is a common pattern (per-request timeouts/headers), so Azure users combining it withazure_deploymentare likely to hit this.