fix: type APIStatusError.code as int | str | None (gh-3531) - #3652
Open
Siraj637909 wants to merge 1 commit into
Open
fix: type APIStatusError.code as int | str | None (gh-3531)#3652Siraj637909 wants to merge 1 commit into
Siraj637909 wants to merge 1 commit into
Conversation
Fixes openai#3531: APIStatusError.code was typed Optional[str] but at runtime can hold an int (e.g., {'error': {'code': 404}}). Downstream code that trusts the annotation and calls exc.code.strip() crashes with AttributeError. This change makes the annotation match actual behavior.
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
1 participant
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.
Hi! I've opened a fix for this issue in PR #3652.
The problem:
APIStatusError.codeis typedOptional[str]but at runtime can hold anint(e.g.{"error": {"code": 404}}). Theconstruct_typecall returns the value unchanged when it doesn't match the target type, andcast(Any, ...)suppresses the type checker, so the annotation is misleading. Downstream code that trusts it and callsexc.code.strip()crashes withAttributeError.The fix: Changed the annotation to
int | str | Noneinsrc/openai/_exceptions.py:61to match actual runtime behavior.PR: #3652