From: DCsunset <DCsunset@users.noreply.github.com>
Date: Thu, 8 Sep 2022 14:29:23 +0000 (-0400)
Subject: ✨ Add support in `jsonable_encoder` for include and exclude with dataclasses (#4923)
X-Git-Tag: 0.83.0~10
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=3ec498af63ddc994a7c70f1a05407ea5f7095be4;p=thirdparty%2Ffastapi%2Ffastapi.git

✨ Add support in `jsonable_encoder` for include and exclude with dataclasses (#4923)

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
---

diff --git a/fastapi/encoders.py b/fastapi/encoders.py
index f64e4b86ea..93045ca27f 100644
--- a/fastapi/encoders.py
+++ b/fastapi/encoders.py
@@ -74,8 +74,12 @@ def jsonable_encoder(
         obj_dict = dataclasses.asdict(obj)
         return jsonable_encoder(
             obj_dict,
-            exclude_none=exclude_none,
+            include=include,
+            exclude=exclude,
+            by_alias=by_alias,
+            exclude_unset=exclude_unset,
             exclude_defaults=exclude_defaults,
+            exclude_none=exclude_none,
             custom_encoder=custom_encoder,
             sqlalchemy_safe=sqlalchemy_safe,
         )
diff --git a/tests/test_jsonable_encoder.py b/tests/test_jsonable_encoder.py
index 5e55f2f918..f4fdcf6014 100644
--- a/tests/test_jsonable_encoder.py
+++ b/tests/test_jsonable_encoder.py
@@ -1,3 +1,4 @@
+from dataclasses import dataclass
 from datetime import datetime, timezone
 from enum import Enum
 from pathlib import PurePath, PurePosixPath, PureWindowsPath
@@ -19,6 +20,12 @@ class Pet:
         self.name = name
 
 
+@dataclass
+class Item:
+    name: str
+    count: int
+
+
 class DictablePerson(Person):
     def __iter__(self):
         return ((k, v) for k, v in self.__dict__.items())
@@ -131,6 +138,15 @@ def test_encode_dictable():
     }
 
 
+def test_encode_dataclass():
+    item = Item(name="foo", count=100)
+    assert jsonable_encoder(item) == {"name": "foo", "count": 100}
+    assert jsonable_encoder(item, include={"name"}) == {"name": "foo"}
+    assert jsonable_encoder(item, exclude={"count"}) == {"name": "foo"}
+    assert jsonable_encoder(item, include={}) == {}
+    assert jsonable_encoder(item, exclude={}) == {"name": "foo", "count": 100}
+
+
 def test_encode_unsupported():
     unserializable = Unserializable()
     with pytest.raises(ValueError):