Merge pull request #148 from developmentseed/bugfix/147-model-serialization

Adjust model serializer.

Author: vincentsarago

CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 Note: Minor version `0.X.0` update might break the API, It's recommended to pin geojson-pydantic to minor version: `geojson-pydantic>=0.6,<0.7`
 
+## [1.0.1] - 2023-10-04
+
+### Fixed
+
+* Model serialization when using include/exclude (ref: https://github.com/developmentseed/geojson-pydantic/pull/148)
+
 ## [1.0.0] - 2023-07-24
 
 ### Fixed
@@ -342,7 +348,8 @@ Although the type file was added in `0.2.0` it wasn't included in the distribute
 ### Added
 - Initial Release
 
-[unreleased]: https://github.com/developmentseed/geojson-pydantic/compare/1.0.0...HEAD
+[unreleased]: https://github.com/developmentseed/geojson-pydantic/compare/1.0.1...HEAD
+[1.0.1]: https://github.com/developmentseed/geojson-pydantic/compare/1.0.0...1.0.1
 [1.0.0]: https://github.com/developmentseed/geojson-pydantic/compare/0.6.3...1.0.0
 [0.6.3]: https://github.com/developmentseed/geojson-pydantic/compare/0.6.2...0.6.3
 [0.6.2]: https://github.com/developmentseed/geojson-pydantic/compare/0.6.1...0.6.2

geojson_pydantic/base.py

@@ -52,17 +52,22 @@ def validate_bbox(cls, bbox: Optional[BBox]) -> Optional[BBox]:
 
         return bbox
 
-    @model_serializer(when_used="json", mode="wrap")
-    def clean_model(self, serializer: Any, _info: SerializationInfo) -> Dict[str, Any]:
+    @model_serializer(when_used="always", mode="wrap")
+    def clean_model(self, serializer: Any, info: SerializationInfo) -> Dict[str, Any]:
         """Custom Model serializer to match the GeoJSON specification.
 
         Used to remove fields which are optional but cannot be null values.
         """
         # This seems like the best way to have the least amount of unexpected consequences.
         # We want to avoid forcing values in `exclude_none` or `exclude_unset` which could
         # cause issues or unexpected behavior for downstream users.
+        # ref: https://github.com/pydantic/pydantic/issues/6575
         data: Dict[str, Any] = serializer(self)
-        for field in self.__geojson_exclude_if_none__:
-            if field in data and data[field] is None:
-                del data[field]
+
+        # Only remove fields when in JSON mode.
+        if info.mode_is_json():
+            for field in self.__geojson_exclude_if_none__:
+                if field in data and data[field] is None:
+                    del data[field]
+
         return data

tests/test_features.py

@@ -321,6 +321,14 @@ def test_feature_serializer():
     assert "bbox" in f.model_dump()
     assert "id" in f.model_dump()
 
+    # Exclude
+    assert "bbox" not in f.model_dump(exclude={"bbox"})
+    assert "bbox" not in list(json.loads(f.model_dump_json(exclude={"bbox"})).keys())
+
+    # Include
+    assert ["bbox"] == list(f.model_dump(include={"bbox"}).keys())
+    assert ["bbox"] == list(json.loads(f.model_dump_json(include={"bbox"})).keys())
+
     feat_ser = json.loads(f.model_dump_json())
     assert "bbox" in feat_ser
     assert "id" in feat_ser
@@ -336,6 +344,8 @@ def test_feature_serializer():
             "properties": {},
         }
     )
+    # BBOX Should'nt be present if `None`
+    # https://github.com/developmentseed/geojson-pydantic/issues/125
     assert "bbox" in f.model_dump()
 
     feat_ser = json.loads(f.model_dump_json())
@@ -381,6 +391,14 @@ def test_feature_collection_serializer():
     )
     assert "bbox" in fc.model_dump()
 
+    # Exclude
+    assert "bbox" not in fc.model_dump(exclude={"bbox"})
+    assert "bbox" not in list(json.loads(fc.model_dump_json(exclude={"bbox"})).keys())
+
+    # Include
+    assert ["bbox"] == list(fc.model_dump(include={"bbox"}).keys())
+    assert ["bbox"] == list(json.loads(fc.model_dump_json(include={"bbox"})).keys())
+
     featcoll_ser = json.loads(fc.model_dump_json())
     assert "bbox" in featcoll_ser
     assert "bbox" in featcoll_ser["features"][0]