[PR #24329] Fix incorrect exception reference for json.dumps() #30584

Closed
opened 2026-02-21 20:47:50 -05:00 by yindo · 0 comments
Owner

Original Pull Request: https://github.com/langgenius/dify/pull/24329

State: closed
Merged: Yes


Fixes: #24328

This PR corrects a misleading exception reference related to Python’s json module.
json.dumps() was previously described as potentially raising json.JSONDecodeError, which is not possible.

json.dumps()

  • Purpose: serialize a Python object into a JSON string.
  • Possible error: TypeError when the object is not JSON-serializable (e.g., contains set, bytes, or unsupported custom objects).
  • It does not raise json.JSONDecodeError.

json.loads()

  • Purpose: deserialize a JSON string into a Python object.
  • Possible error: json.JSONDecodeError when the input string is not valid JSON.

Important

  1. Make sure you have read our contribution guidelines
  2. Ensure there is an associated issue and you have been assigned to it
  3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

Screenshots

Before After
... ...

Checklist

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods
**Original Pull Request:** https://github.com/langgenius/dify/pull/24329 **State:** closed **Merged:** Yes --- Fixes: #24328 This PR corrects a misleading exception reference related to Python’s json module. `json.dumps()` was previously described as potentially raising `json.JSONDecodeError`, which is not possible. **json.dumps()** - Purpose: serialize a Python object into a JSON string. - Possible error: `TypeError` when the object is not JSON-serializable (e.g., contains set, bytes, or unsupported custom objects). - It does not raise `json.JSONDecodeError`. **json.loads()** - Purpose: deserialize a JSON string into a Python object. - Possible error: `json.JSONDecodeError` when the input string is not valid JSON. > [!IMPORTANT] > > 1. Make sure you have read our [contribution guidelines](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md) > 1. Ensure there is an associated issue and you have been assigned to it > 1. Use the correct syntax to link this PR: `Fixes #<issue number>`. ## Summary <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ## Screenshots | Before | After | |--------|-------| | ... | ... | ## Checklist - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!) - [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change. - [x] I've updated the documentation accordingly. - [x] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods
yindo added the pull-request label 2026-02-21 20:47:50 -05:00
yindo closed this issue 2026-02-21 20:47:50 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#30584