Merge pull request #138 from arthurdjn/featureCollectionGeneric

Feature collection generic

Author: vincentsarago

CHANGELOG.md

@@ -18,6 +18,16 @@ Note: Minor version `0.X.0` update might break the API, It's recommanded to pin
 
 ### Changed
 
+* update pydantic `FeatureCollection` generic model to allow named features in the generated schemas.
+
+    ```python
+    # before
+    FeatureCollection[Geometry, Properties]
+
+    # now
+    FeatureCollection[Feature[Geometry, Properties]]
+    ```
+
 * update pydantic requirement to `~=2.0`
 
 * raise `ValueError` in `geomtries.parse_geometry_obj` instead of `ValidationError`

geojson_pydantic/features.py

@@ -32,22 +32,25 @@ def set_geometry(cls, geometry: Any) -> Any:
         return geometry
 
 
-class FeatureCollection(BaseModel, Generic[Geom, Props], GeoInterfaceMixin):
+Feat = TypeVar("Feat", bound=Feature)
+
+
+class FeatureCollection(BaseModel, Generic[Feat], GeoInterfaceMixin):
     """FeatureCollection Model"""
 
     type: Literal["FeatureCollection"]
-    features: List[Feature[Geom, Props]]
+    features: List[Feat]
     bbox: Optional[BBox] = None
 
-    def __iter__(self) -> Iterator[Feature]:  # type: ignore [override]
+    def __iter__(self) -> Iterator[Feat]:  # type: ignore [override]
         """iterate over features"""
         return iter(self.features)
 
     def __len__(self) -> int:
         """return features length"""
         return len(self.features)
 
-    def __getitem__(self, index: int) -> Feature:
+    def __getitem__(self, index: int) -> Feat:
         """get feature at a given index"""
         return self.features[index]
 

tests/test_features.py

@@ -173,7 +173,7 @@ def test_generic_properties_should_raise_for_string():
 
 
 def test_feature_collection_generic():
-    fc = FeatureCollection[Polygon, GenericProperties](
+    fc = FeatureCollection[Feature[Polygon, GenericProperties]](
         type="FeatureCollection", features=[test_feature, test_feature]
     )
     assert len(fc) == 2