Encoding subclass of a model with json_encoders#1769

Merged

tiangolo merged 2 commits intofastapi:masterfrom

henrybetts:json-encoders-model-subclass

Aug 3, 2020

Merged

Encoding subclass of a model with json_encoders#1769
tiangolo merged 2 commits intofastapi:masterfrom
henrybetts:json-encoders-model-subclass

Conversation

Copy link

Contributor

henrybetts commentedJul 22, 2020

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

frompydanticimportBaseModelfromdatetimeimportdatetime,timezonefromfastapi.encodersimportjsonable_encoderclassModelWithCustomEncoder(BaseModel):classConfig:json_encoders= {datetime:lambdadt:dt.replace(microsecond=0,tzinfo=timezone.utc            ).isoformat()        }classModelWithCustomEncoderSubclass(ModelWithCustomEncoder):dt_field:datetimeclassConfig:passmodel=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 modifiedjsonable_encoder to get the config using the.__config__ property.

henrybetts added2 commits

July 22, 2020 13:37

Test encoding subclass of a model with json_encoders

ebaf78c

Fix encoding subclass of a model with json_encoders

53e1185

Copy link

codecovbot commentedJul 22, 2020

Codecov Report

Merging#1769 intomaster willnot change coverage.
The diff coverage is100.00%.

@@            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 byCodecov. Last updatea63b1ef...53e1185. Read thecomment docs.