fix: normalize API error codes to strings#3532
Open
Sanjays2402 wants to merge 1 commit into
Open
Conversation
Numeric API error codes currently contradict the public string annotation. Normalize non-null values and cover the runtime behavior with a regression test.
There was a problem hiding this comment.
Pull request overview
Normalizes APIError.code to always be a string (when present) so runtime behavior matches the public str | None type annotation and avoids downstream type surprises when servers return numeric error codes.
Changes:
- Coerce non-
Noneerror.codevalues tostrduringAPIErrorconstruction. - Add a regression test covering integer error codes.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/openai/_exceptions.py |
Ensures APIError.code is normalized to str when present. |
tests/test_client.py |
Adds a regression test asserting integer error codes become strings. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes being requested
Normalize non-null API error codes to strings so runtime behavior matches the public
str | Noneannotation. A regression test covers numeric error payloads.Additional context & links
Closes #3531