🐛 Improve jsonable_encoder for other types of iterables
#13803
+33
−4
Conversation
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
jsonable_encoder for other types of iterables
dolfinus
reviewed
Jun 28, 2025
fastapi/encoders.py
Outdated
| from pydantic.networks import AnyUrl, NameEmail | ||
| from pydantic.types import SecretBytes, SecretStr | ||
| from pydantic_extra_types.color import Color |
There was a problem hiding this comment.
This package supports pydantic 2.x only
|
Hi @Lob26, I’m new to open source but would love to help with this.
I’ll try to write a test case and debug the CI failures. Thanks! |
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.
What was changed
Updated the jsonable_encoder function to correctly handle any iterable type.
Reordered conditionals to ensure the iterable check occurs later, allowing appropriate handling to other type-specific branches (which previously caused failures).
Why this change is necessary
The previous implementation did not correctly serialize objects like
sqlalchemy.engine.Row, which inherit fromcollections.abc.Sequencebut behave differently than standard lists or tuples. This led to unexpected failures or incorrect encoding.Testing
Manually tested the updated function against a wide variety of data structures
Behavior appears consistent and correct across all tested inputs.
Notes
While the function now gracefully handles many iterables, I'm still wary there may be edge cases I haven't considered. Further review and test cases are welcome.