using strict types.

Author: vincentsarago

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
 
     steps:
       - uses: actions/checkout@v3

.pre-commit-config.yaml

@@ -1,18 +1,18 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 22.12.0
     hooks:
       - id: black
         language_version: python
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
         language_version: python
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 5.0.4
+    rev: 6.0.0
     hooks:
       - id: flake8
         language_version: python
@@ -26,7 +26,7 @@ repos:
           - toml
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.971
+    rev: v0.991
     hooks:
       - id: mypy
         language_version: python

CHANGELOG.md

@@ -5,10 +5,46 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [unreleased]
+## [0.6.0] - TBD
 
+### Added
+
+- Enforce required keys and avoid defaults. This aim to follow the geojson specification to the letter.
+
+    ```python
+    # Before
+    Feature(geometry=Point(coordinates=(0,0)))
+
+    # Now
+    Feature(
+        type="Feature",
+        geometry=Point(
+            type="Point",
+            coordinates=(0,0)
+        ),
+        properties=None,
+    )
+    ```
+
+- Add has_z function to Geometries (author @eseglem, https://github.com/developmentseed/geojson-pydantic/pull/103)
+- Add optional bbox to geometries.
+
+### Changed
+
+- Refactor and simplify WKT construction (author @eseglem, https://github.com/developmentseed/geojson-pydantic/pull/97)
+- Support empty geometry coordinates (author @eseglem, https://github.com/developmentseed/geojson-pydantic/pull/100)
+
+### Fixed
+
+- Do not validates arbitrary dictionaries. Make `Type` a mandatory key for objects (https://github.com/developmentseed/geojson-pydantic/pull/94)
+- Add Geometry discriminator when parsing geometry objects (author @eseglem, https://github.com/developmentseed/geojson-pydantic/pull/101)
+- Mixed Dimensionality WKTs (make sure the coordinates are either all 2D or 3D) (author @eseglem, https://github.com/developmentseed/geojson-pydantic/pull/107)
 - allow Feature's **id** to be either a String or a Number
 
+### Removed
+
+- python 3.7 support
+
 ## [0.5.0] - 2022-12-16
 
 ### Added

geojson_pydantic/features.py

@@ -1,24 +1,25 @@
 """pydantic models for GeoJSON Feature objects."""
 
-from typing import Any, Dict, Generic, Iterator, List, Optional, TypeVar, Union
+from typing import Any, Dict, Generic, Iterator, List, Literal, Optional, TypeVar, Union
 
-from pydantic import BaseModel, Field, validator
+from pydantic import BaseModel, Field, StrictInt, StrictStr, validator
 from pydantic.generics import GenericModel
 
+from geojson_pydantic.geo_interface import GeoInterfaceMixin
 from geojson_pydantic.geometries import Geometry, GeometryCollection
 from geojson_pydantic.types import BBox
 
 Props = TypeVar("Props", bound=Union[Dict[str, Any], BaseModel])
 Geom = TypeVar("Geom", bound=Union[Geometry, GeometryCollection])
 
 
-class Feature(GenericModel, Generic[Geom, Props]):
+class Feature(GenericModel, Generic[Geom, Props], GeoInterfaceMixin):
     """Feature Model"""
 
-    type: str = Field(default="Feature", const=True)
-    geometry: Optional[Geom] = None
-    properties: Optional[Props] = None
-    id: Optional[Union[int, str]] = None
+    type: Literal["Feature"]
+    geometry: Union[Geom, None] = Field(...)
+    properties: Union[Props, None] = Field(...)
+    id: Optional[Union[StrictInt, StrictStr]] = None
     bbox: Optional[BBox] = None
 
     class Config:
@@ -32,36 +33,14 @@ def set_geometry(cls, geometry: Any) -> Any:
         """set geometry from geo interface or input"""
         if hasattr(geometry, "__geo_interface__"):
             return geometry.__geo_interface__
-        return geometry
-
-    @property
-    def __geo_interface__(self) -> Dict[str, Any]:
-        """GeoJSON-like protocol for geo-spatial (GIS) vector data.
-
-        ref: https://gist.github.com/sgillies/2217756#__geo_interface
-        """
-        geo: Dict[str, Any] = {
-            "type": self.type,
-            "geometry": self.geometry.__geo_interface__
-            if self.geometry is not None
-            else None,
-        }
-        if self.bbox:
-            geo["bbox"] = self.bbox
-
-        if self.id:
-            geo["id"] = self.id
-
-        if self.properties:
-            geo["properties"] = self.properties
 
-        return geo
+        return geometry
 
 
-class FeatureCollection(GenericModel, Generic[Geom, Props]):
+class FeatureCollection(GenericModel, Generic[Geom, Props], GeoInterfaceMixin):
     """FeatureCollection Model"""
 
-    type: str = Field(default="FeatureCollection", const=True)
+    type: Literal["FeatureCollection"]
     features: List[Feature[Geom, Props]]
     bbox: Optional[BBox] = None
 
@@ -76,19 +55,3 @@ def __len__(self) -> int:
     def __getitem__(self, index: int) -> Feature:
         """get feature at a given index"""
         return self.features[index]
-
-    @property
-    def __geo_interface__(self) -> Dict[str, Any]:
-        """GeoJSON-like protocol for geo-spatial (GIS) vector data.
-
-        ref: https://gist.github.com/sgillies/2217756#__geo_interface
-        """
-        features: List[Dict[str, Any]] = []
-        for feat in self.features:
-            features.append(feat.__geo_interface__)
-
-        geo: Dict[str, Any] = {"type": self.type, "features": features}
-        if self.bbox:
-            geo["bbox"] = self.bbox
-
-        return geo

geojson_pydantic/geo_interface.py

@@ -0,0 +1,23 @@
+"""Mixin for __geo_interface__ on GeoJSON objects."""
+
+from typing import Any, Dict, Protocol
+
+
+class _DictProtocol(Protocol):
+    """Protocol for use as the type of self in the mixin."""
+
+    def dict(self, *, exclude_unset: bool, **args: Any) -> Dict[str, Any]:
+        """Define a dict function so the mixin knows it exists."""
+        ...
+
+
+class GeoInterfaceMixin:
+    """Mixin for __geo_interface__ on GeoJSON objects."""
+
+    @property
+    def __geo_interface__(self: _DictProtocol) -> Dict[str, Any]:
+        """GeoJSON-like protocol for geo-spatial (GIS) vector data.
+
+        ref: https://gist.github.com/sgillies/2217756#__geo_interface
+        """
+        return self.dict(exclude_unset=True)