Thanks to visit codestin.com
Credit goes to github.com

Skip to content

🐛 Recurse into dataclass when encoding#4454

Closed
ConorStevenson wants to merge 3 commits into
fastapi:masterfrom
ConorStevenson:fix-dataclass-encoding
Closed

🐛 Recurse into dataclass when encoding#4454
ConorStevenson wants to merge 3 commits into
fastapi:masterfrom
ConorStevenson:fix-dataclass-encoding

Conversation

@ConorStevenson

@ConorStevenson ConorStevenson commented Jan 20, 2022 •
edited
Loading

Copy link
Copy Markdown

Context:
PR #3576 added support for dataclasses as response objects.

Problem:
json_encoder doesn't recurse into dataclasses as it does for pydantic models, dictionaries, and other collections. Custom encoders aren't applied to attributes on dataclasses.

Solution:
Recurse into dataclasses when encoding. Also change dataclass tests to use dataclasses rather than pydantic models.

Example:

from datetime import datetime
from fastapi import FastAPI
import dataclasses
import pydantic

app = FastAPI()

@pydantic.dataclasses.dataclass
class PydanticDataclass:
    timestamp: datetime = datetime.now()

@dataclasses.dataclass
class ClassicDataclass:
    timestamp: datetime = datetime.now()

@app.get("/pydantic", response_model=PydanticDataclass)
async def pydantic_dataclass():
    return PydanticDataclass()


@app.get("/classic", response_model=ClassicDataclass)
async def classic_dataclass():
    return ClassicDataclass()


$ curl localhost:8000/pydantic
-> {"timestamp":"2022-01-24T20:51:42.316967"}
$ curl localhost:8000/classic
-> TypeError: Object of type datetime is not JSON serializable

@himbeles

himbeles commented Jan 27, 2022

Copy link
Copy Markdown
Contributor

See also my existing (nearly identical) PR #3607 and issue #3608 from last year. No response until now unfortunately.

don4of4
don4of4 approved these changes Jan 31, 2022
View reviewed changes

@don4of4 don4of4 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good -- encountered this issue in our projects as well.

@himbeles

himbeles commented Jan 31, 2022

Copy link
Copy Markdown
Contributor

Shouldn’t the keyword arguments of jsonable_encoder also be passed on into the recursion? See also #3607.

@ConorStevenson

ConorStevenson commented Jan 31, 2022

Copy link
Copy Markdown
Author

Shouldn’t the keyword arguments of jsonable_encoder also be passed on into the recursion? See also #3607.

Yep, updated it now. Sorry to have duplicated your existing PR!

@himbeles

himbeles commented Feb 1, 2022

Copy link
Copy Markdown
Contributor

No problem, just hope it gets merged :)

explicitly recurse
46bab02 
This makes the behaviour of include/exclude easier to see
@himbeles

himbeles commented Feb 11, 2022

Copy link
Copy Markdown
Contributor

@don4of4 Thanks for the review. Do you see any chances, that this PR will be merged in the near future?

@himbeles

himbeles commented Aug 27, 2022

Copy link
Copy Markdown
Contributor

My PR #3607 got merged. I think you can close this one now! 🚀

@tiangolo

tiangolo commented Sep 4, 2022

Copy link
Copy Markdown
Member

Thanks for the effort @ConorStevenson! ☕

It seems this was solved by #3607, right? Given that, I'll close this one.

But if you feel there's something else that needs to be done, feel free to create a new PR.

Thanks! 😄

@tiangolo tiangolo closed this Sep 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@don4of4 don4of4 don4of4 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ConorStevenson @himbeles @tiangolo @don4of4