Merge pull request #28 from GeodetischeInfrastructuur/fix-mypy

fix type annotations and add mypy type check to pre-commit hook

.githooks/pre-commit

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+set -u
 
 print_message() {
     padding_char=">"
@@ -27,10 +28,17 @@ print_message() {
 command_available() {
     command="$1"
     if ! command -v "$command" &>/dev/null; then
-        print_message "ERROR: ${command} could not be found" 2 "ERROR" false
+        print_message "ERROR: ${command} could not be found - commit aborted" 2 "ERROR" false
         exit 1
     fi
 }
+command_available "mypy"
+print_message "pre-commit - running mypy static type checking" 1 "" true
+if ! mypy coordinates_transformation_api;then
+    print_message "mypy static type check failed - commit aborted" 1 "ERROR" true
+    exit 1
+fi
+
 
 command_available "black"
 print_message "pre-commit - running Black formatting" 1 "" true

coordinates_transformation_api/util.py

@@ -3,25 +3,14 @@
 
 import yaml
 from fastapi.exceptions import RequestValidationError
-from geojson_pydantic import (
-    Feature,
-    FeatureCollection,
-    LineString,
-    MultiLineString,
-    MultiPoint,
-    MultiPolygon,
-    Point,
-    Polygon,
-)
-from geojson_pydantic.geometries import Geometry, GeometryCollection, _GeometryBase
-from geojson_pydantic.types import (
-    LineStringCoords,
-    MultiLineStringCoords,
-    MultiPointCoords,
-    MultiPolygonCoords,
-    PolygonCoords,
-    Position,
-)
+from geojson_pydantic import (Feature, FeatureCollection, LineString,
+                              MultiLineString, MultiPoint, MultiPolygon, Point,
+                              Polygon)
+from geojson_pydantic.geometries import (Geometry, GeometryCollection,
+                                         _GeometryBase)
+from geojson_pydantic.types import (LineStringCoords, MultiLineStringCoords,
+                                    MultiPointCoords, MultiPolygonCoords,
+                                    PolygonCoords, Position)
 from pydantic import ValidationError
 from pydantic_core import InitErrorDetails, PydanticCustomError
 from pyproj import CRS, Transformer
@@ -163,10 +152,19 @@ def get_transform_callback(transformer: Transformer):
     def callback(
         val: Union[Tuple[float, float], Tuple[float, float, float]]
     ) -> Tuple[float, ...]:
+        if transformer.target_crs is None:
+            raise ValueError("transformer.target_crs is None")
         dim = len(transformer.target_crs.axis_info)
-
         if dim != None and dim != len(val):
-            val = val[0:dim]
+            if (
+                2 > dim > 3
+            ):  # check so we can safely cast to Tuple[float, float], Tuple[float, float, float]
+                raise ValueError(
+                    f"number of dimensions of target-crs should be 2 or 3, is {dim}"
+                )
+            val = cast(
+                Union[Tuple[float, float], Tuple[float, float, float]], val[0:dim]
+            )
         return tuple([float(round(x, 6)) for x in transformer.transform(*val)])
 
     return callback

pyproject.toml

@@ -21,8 +21,7 @@ requires-python = ">=3.11.4"
 dynamic = ["version"]
 
 [project.optional-dependencies]
-dev = ["black", "autoflake", "isort"]
-# TODO: add/enable mypy when using type annotations
+dev = ["black", "autoflake", "isort", "mypy"]
 
 [build-system]
 build-backend = "setuptools.build_meta"