Fix: Handle empty/invalid JSON in client.chat.parse() #288
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.
Fixes #282
I ran into this issue while following the structured output documentation. When the API returns empty or invalid JSON content,
client.chat.parse()crashes with a JSONDecodeError instead of handling it gracefully.The problem is in
struct_chat.pyline 27 - it tries to parse the content string withjson.loads()without checking if it's actually valid JSON first.I've added validation to check if the content is non-empty and catch any JSON parsing errors. When parsing fails, it now sets
parsedtoNoneinstead of crashing, which is consistent with how the code already handlesNonecontent.I also added some tests to cover the edge cases:
All the existing tests still pass, and the new behavior is backward compatible - valid JSON inputs work exactly the same as before. The only difference is that edge cases that used to crash now return
parsed=None, which users can check to see if parsing succeeded.Let me know if you'd like me to change anything!