8000 Encoding subclass of a model with json_encoders by henrybetts · Pull Request #1769 · fastapi/fastapi · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Encoding subclass of a model with json_encoders #1769

Merged
merged 2 commits into from
Aug 3, 2020
Merged

Encoding subclass of a model with json_encoders #1769

merged 2 commits into from
Aug 3, 2020

Conversation

henrybetts
Copy link
Contributor

Currently when encoding a model, the json_encoders property is ignored if it is defined in a superclass of the model. For example;

from pydantic import BaseModel
from datetime import datetime, timezone
from fastapi.encoders import jsonable_encoder


class ModelWithCustomEncoder(BaseModel):
    class Config:
        json_encoders = {
            datetime: lambda dt: dt.replace(
                microsecond=0, tzinfo=timezone.utc
            ).isoformat()
        }


class ModelWithCustomEncoderSubclass(ModelWithCustomEncoder):
    dt_field: datetime

    class Config:
        pass


model = ModelWithCustomEncoderSubclass(dt_field=datetime(2019, 1, 1, 8))

print(model.json())
# {"dt_field": "2019-01-01T08:00:00+00:00"}

print(jsonable_encoder(model))
# {'dt_field': '2019-01-01T08:00:00'}

To fix this, I modified jsonable_encoder to get the config using the .__config__ property.

@codecov
Copy link
codecov bot commented Jul 22, 2020

Codecov Report

Merging #1769 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree grap 8000 h

@@            Coverage Diff            @@
##            master     #1769   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          235       235           
  Lines         6989      6995    +6     
=========================================
+ Hits          6989      6995    +6
Impacted Files Coverage Δ
fastapi/encoders.py 100.00% <100.00%> (ø)
tests/test_jsonable_encoder.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a63b1ef...53e1185. Read the comment docs.

@github-actions
Copy link
Contributor

📝 Docs preview for commit 53e1185 at: https://5f183a82083ba939380c4c42--fastapi.netlify.app

@tiangolo tiangolo merged commit 7fbe373 into fastapi:master Aug 3, 2020
@tiangolo
Copy link
Member
tiangolo commented Aug 3, 2020

Excellent, thank you! 🚀 🎉

@henrybetts henrybetts deleted the json-encoders-model-subclass branch August 3, 2020 15:37
@philipbjorge philipbjorge mentioned this pull request May 6, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@henrybetts @tiangolo
0