Hotfix/types are not flagged by static type checking

[frank-hulo]

This is my first PR on this repo, for me the contributing guidelines are not entirely clear, but will check the remakrs.

This pull request includes updates to the geojson_pydantic/geometries.py file to improve type consistency and string formatting. The most important changes include setting default values for type fields in geometry models.

Reason for this update is mitigate not every time required to define the type and model init. E.g. Point(type="Point", coordinates=(0,1)). This is flagged by strict type checkers the only valid method.

Improvements to type consistency:

• geojson_pydantic/geometries.py: Set default values for type fields in Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, and GeometryCollection models. [1] [2] [3] [4] [5] [6] [7]

Improvements to string formatting:

• geojson_pydantic/geometries.py: Updated string formatting in the wkt method of GeometryCollection to use double quotes for consistency.

[vincentsarago]

dear @frank-hulo

Thanks for the PR.

Sadly default type key was made on purpose, see:

• "Enforce required keys and enforce defaults" makes code needlessly cumbersome #124
• Enforce type geometry properties #94
• https://github.com/developmentseed/geojson-pydantic/blob/main/CHANGELOG.md#060a0---2023-04-04

from geojson_pydantic.geometries import _GeometryBase
from geojson_pydantic.types import Position
from typing import Any, Literal

class Point(_GeometryBase):
    """Point Model"""

    type: Literal["Point"] = "Point"
    coordinates: Position


    def __wkt_coordinates__(self, coordinates: Any, force_z: bool) -> str:
        """return WKT coordinates."""
        pass

    @property
    def has_z(self):
        """Checks if any coordinate has a Z value."""
        pass


invalid_point_geometry = {"coordinates": [0, 0]}

Point.model_validate(invalid_point_geometry) # This should fail

# But it doesn't 
>> Point(bbox=None, type='Point', coordinates=Position2D(longitude=0.0, latitude=0.0))

We choose this to make sure geojson models validation was strict. Now if there is a better way to make the validation step better I'm super open to discuss

For the second point I'm not quite sure to see the consistency 🤷

This is my first PR on this repo, for me the contributing guidelines are not entirely clear, but will check the remakrs.

For important changes (like the one proposed), we usually expect issue/discussion before submitting any code (to avoid people wasting time proposing something that would be discarded). I'll update the contributions page 🙏

[frank-hulo]

update

Thank you for the swift response. Good to understand the history, and just to understand your requirements:

class Point(_GeometryBase):
    """Point Model"""

    type: Literal["Point"] = "Point"
    coordinates: Position


    def __wkt_coordinates__(self, coordinates: Any, force_z: bool) -> str:
        """return WKT coordinates."""
        pass

    @property
    def has_z(self):
        """Checks if any coordinate has a Z value."""
        pass


invalid_point_geometry = {"coordinates": [0, 0]}
valid_point_geometry = {"coordinates": [0, 0], type="Point"}

Point.model_validate(invalid_point_geometry) # This should fail
Point.model_validate(valid_point_geometry ) # This should pass
Point(coordinates= [0, 0]) # this should pass

[vincentsarago]

invalid_point_geometry = {"coordinates": [0, 0]}
valid_point_geometry = {"coordinates": [0, 0], type="Point"}

Point.model_validate(invalid_point_geometry) # This should fail
Point.model_validate(valid_point_geometry ) # This should pass
Point(coordinates= [0, 0]) # this should pass

yeah, invalid_point_geometry is missing the type so it's not a valid GeoJSON geometry. With the proposed changed geojson-pydantic Point model will not complain when using Point.model_validate({"coordinates": [0, 0]})

We understand when building object using the model (e.g Point(coordinates= [0, 0])) it's annoying to have to pass Point(coordinates= [0, 0], type="point") but as mentioned, the validation feature is considered as more important for the library