Repository navigation
fix(http-client-python): raise azure-core error types for customized errors covering standard status codes - #11250
Conversation
…errors covering standard status codes Always populate the operation error_map with the standard azure-core error types (401 -> ClientAuthenticationError, 404 -> ResourceNotFoundError, 409 -> ResourceExistsError, 304 -> ResourceNotModifiedError), even when a customized error model covers those status codes via a ranged or default error response. map_error then raises the dedicated error type instead of falling back to a generic HttpResponseError. The customized error body continues to be deserialized and attached to the HttpResponseError raised for other (non-standard) status codes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
commit: |
|
All changed packages have been documented.
Show changes
|
|
You can try these changes here
|
|
Diff is Azure/azure-sdk-for-python#48056 |
Yuchao Yan (msyyc)
left a comment
There was a problem hiding this comment.
We ever discussed about it in teams channel and the breaking of spector case could be accepted.
|
FYI: the CI failure of Python Integration / Mock API Tests (pull_request) is caused by the breaking for test case packages/http-client-python/tests/mock_api/shared/test_response_status_code_range.py which is also in typespec-azure. To fix the failure, we will have to create a PR in typespec-azure to skip the test case; then rerun pipeline. After this PR merged, release a new version of http-client-python. Then bump the new version in typespec-azure and reopen the skipped test case. NOTE: it is very annoying for such kind of ci failure and the root cause is that we put source code in microsoft repo but put ci check in typespec-azure repo. I made a proposal in e-mail |
|
holding off on this pr until the typeddict fixes get in |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Resolve the error map conflict by preserving dedicated azure-core mappings for standard status codes covered by customized errors.\n\nCo-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the @typespec/http-client-python emitter so that operations always raise the dedicated azure-core exception types for standard status codes (401/404/409/304) via map_error and the per-operation error_map, even when custom error models (single, ranged, or default) also cover those codes.
Changes:
- Always populate the generated operation
error_mapwith the standard azure-core exception mappings somap_errorraises the dedicated types consistently. - Remove generator-side “raise built-in error type” branching in custom-error handling and rely on
map_errorfor standard codes. - Update the sync/async
response-status-code-rangemock-api tests and add a Chronusfixentry.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/http-client-python/generator/pygen/codegen/serializers/builder_serializer.py | Always emits standard-code azure-core mappings in error_map; adjusts custom-error deserialization logic to assume map_error handles standard codes. |
| packages/http-client-python/tests/mock_api/shared/test_response_status_code_range.py | Updates 404 test expectations to reflect ResourceNotFoundError raised by map_error. |
| packages/http-client-python/tests/mock_api/shared/asynctests/test_response_status_code_range_async.py | Async equivalent of the 404 test update. |
| .chronus/changes/python-custom-error-status-mapping-2026-6-16-9-52-50.md | Adds a changelog entry documenting the behavior change. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Python emitter diffBaseline Diff summary: 4 file(s), +16 / -8 Rendered diff: inline on the run summary, or the emitter-diff-html artifact. Informational check (eng/emitter-diff); does not block the PR. |
Problem
When a TypeSpec operation declares a customized error model that covers one of the standard azure-core status codes (401, 404, 409, 304), the Python emitter did not consistently raise the dedicated azure-core error type:
4XX) covering a standard code → fell through to a genericHttpResponseError.HttpResponseErrorfor the standard codes.Only a custom error targeting a standard code specifically raised the dedicated type, so behavior was inconsistent across the single / ranged / default cases.
Fix
Standard status codes now always map to their dedicated azure-core error type via the operation
error_map, regardless of whether a customized error model (single, ranged, or default) also covers them:401 → ClientAuthenticationError404 → ResourceNotFoundError409 → ResourceExistsError304 → ResourceNotModifiedErrorBecause
map_error(status_code=..., response=..., error_map=error_map)runs first in the generated handler, these codes raise their dedicated type there. The customized error body continues to be deserialized and attached (model=error) to the genericHttpResponseErrorthat is raised for any other (non-standard) status codes covered by the customized error.Behavior change note
For a custom error that targets a standard code specifically (e.g. a
404model), the dedicated error is still raised, but the deserialized custom body is no longer attached to it —map_errorraises before deserialization, soexc.modelisNonefor those codes. The body remains available onHttpResponseErrorfor non-standard codes. Theresponse-status-code-rangemock-api tests were updated to reflect this.Example generated output (ranged custom error + default custom error)
with the shared error map:
Validation
response-status-code-rangemock-api tests pass (sync + async, 4/4), exercising both an in-range code and the single 404 →ResourceNotFoundError.fixchangelog entry for@typespec/http-client-python.