update/fix type hints (#1287)

* update/fix type for titiler.core

* update/fix type for titiler.extensions

* update/fix type for titiler.xarray

* update/fix type for titiler.mosaic

* update/fix type for titiler.application

* update changelog

* run mypy in CI

* update type hints for tests

Author: vincentsarago

.github/workflows/ci.yml

@@ -62,10 +62,11 @@ jobs:
         run: |
           uv run pytest src/titiler/application --cov=titiler.application --cov-report=xml --cov-append --cov-report=term-missing
 
-      - name: run pre-commit
+      - name: run pre-commit and mypy
         if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}
         run: |
           uv run pre-commit run --all-files
+          uv run --with mypy --with types-attrs --with types-simplejson mypy -p titiler.core -p titiler.extensions -p titiler.xarray -p titiler.application -p titiler.mosaic  --ignore-missing-imports
 
       - name: Upload Results
         if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}

CHANGES.md

@@ -9,6 +9,7 @@
 * remove `/{tileMatrixSetId}/WMTSCapabilities.xml` endpoints from factories **breaking change**
 * add python 3.14 support
 * add `linux/arm64` docker image 
+* update/fix type hints 
 
 ### titiler.core
 

src/titiler/application/titiler/application/main.py

@@ -3,7 +3,7 @@
 import json
 import logging
 from logging import config as log_config
-from typing import Annotated, Literal, Optional
+from typing import Annotated, Literal
 
 import jinja2
 import rasterio
@@ -58,7 +58,7 @@
 api_settings = ApiSettings()
 
 # custom template directory
-templates_location = (
+templates_location: list[jinja2.BaseLoader] = (
     [jinja2.FileSystemLoader(api_settings.template_directory)]
     if api_settings.template_directory
     else []
@@ -173,7 +173,7 @@ def validate_access_token(access_token: str = Security(api_key_query)):
 # Mosaic endpoints
 if not api_settings.disable_mosaic:
     mosaic = MosaicTilerFactory(
-        backend=MosaicJSONBackend,
+        backend=MosaicJSONBackend,  # type: ignore
         router_prefix="/mosaicjson",
         extensions=[
             MosaicJSONExtension(),
@@ -365,7 +365,7 @@ def application_health_check():
 def landing(
     request: Request,
     f: Annotated[
-        Optional[Literal["html", "json"]],
+        Literal["html", "json"] | None,
         Query(
             description="Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
         ),
@@ -471,7 +471,7 @@ def landing(
 def conformance(
     request: Request,
     f: Annotated[
-        Optional[Literal["html", "json"]],
+        Literal["html", "json"] | None,
         Query(
             description="Response MediaType. Defaults to endpoint's default or value defined in `accept` header."
         ),

src/titiler/application/titiler/application/py.typed

@@ -1,7 +1,5 @@
 """Titiler API settings."""
 
-from typing import Optional
-
 from pydantic import field_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
@@ -27,7 +25,7 @@ class ApiSettings(BaseSettings):
     root_path: str = ""
     debug: bool = False
 
-    template_directory: Optional[str] = None
+    template_directory: str | None = None
 
     disable_cog: bool = False
     disable_stac: bool = False
@@ -38,7 +36,7 @@ class ApiSettings(BaseSettings):
     telemetry_enabled: bool = False
 
     # an API key required to access any endpoint, passed via the ?access_token= query parameter
-    global_access_token: Optional[str] = None
+    global_access_token: str | None = None
 
     model_config = SettingsConfigDict(
         env_prefix="TITILER_API_", env_file=".env", extra="ignore"

src/titiler/application/titiler/application/settings.py

@@ -1,7 +1,7 @@
 """``pytest`` configuration."""
 
 import os
-from typing import Any, Dict
+from typing import Any
 
 import pytest
 import rasterio
@@ -21,7 +21,7 @@ def set_env(monkeypatch):
     monkeypatch.setenv("AWS_CONFIG_FILE", "/tmp/noconfigheere")
 
 
-def parse_img(content: bytes) -> Dict[Any, Any]:
+def parse_img(content: bytes) -> dict[Any, Any]:
     """Read tile image and return metadata."""
     with MemoryFile(content) as mem:
         with mem.open() as dst:

src/titiler/core/tests/conftest.py

@@ -1,7 +1,6 @@
 """Test TiTiler Custom Render Params."""
 
 from dataclasses import dataclass
-from typing import Optional, Union
 
 import numpy
 from fastapi import FastAPI, Query
@@ -17,12 +16,12 @@
 class CustomRenderParams(ImageRenderingParams):
     """Custom renderparams class."""
 
-    nodata: Optional[Union[str, int, float]] = Query(
+    nodata: str | int | float | None = Query(
         None,
         title="Tiff Ouptut Nodata value",
         alias="output_nodata",
     )
-    compress: Optional[str] = Query(
+    compress: str | None = Query(
         None,
         title="Tiff compression schema",
         alias="output_compression",

src/titiler/core/tests/test_CustomRender.py

@@ -1,6 +1,6 @@
 """Test titiler.core.middleware.LowerCaseQueryStringMiddleware."""
 
-from typing import Annotated, List
+from typing import Annotated
 
 from fastapi import FastAPI, Query
 from starlette.testclient import TestClient
@@ -33,7 +33,7 @@ def test_lowercase_middleware_multiple_values():
     app = FastAPI()
 
     @app.get("/route1")
-    async def route1(value: Annotated[List[str], Query()]):
+    async def route1(value: Annotated[list[str], Query()]):
         """route1."""
         return {"value": value}
 
@@ -53,7 +53,7 @@ def test_lowercase_middleware_url_with_query_parameters():
     app = FastAPI()
 
     @app.get("/route1")
-    async def route1(url: List[str] = Query(...)):
+    async def route1(url: list[str] = Query(...)):
         """route1."""
         return {"url": url}
 

src/titiler/core/tests/test_case_middleware.py

@@ -2,7 +2,7 @@
 
 import json
 from dataclasses import dataclass
-from typing import Annotated, Literal, Optional
+from typing import Annotated, Literal
 
 import pytest
 from fastapi import Depends, FastAPI, Path
@@ -146,7 +146,7 @@ def test_default():
 
     @dataclass
     class dep(dependencies.DefaultDependency):
-        v: Optional[int] = None
+        v: int | None = None
 
     assert dep(v=1).as_dict() == {"v": 1}
     assert dep().as_dict() == {}

src/titiler/core/tests/test_dependencies.py

@@ -2,7 +2,7 @@
 
 import json
 from copy import copy
-from typing import Annotated, Dict, List, Literal, Optional, Type
+from typing import Annotated, Literal
 
 import attr
 from fastapi import HTTPException, Query
@@ -19,7 +19,7 @@
 from titiler.core.algorithm.math import _Max, _Mean, _Median, _Min, _Std, _Sum, _Var
 from titiler.core.algorithm.ops import CastToInt, Ceil, Floor
 
-default_algorithms: Dict[str, Type[BaseAlgorithm]] = {
+default_algorithms: dict[str, type[BaseAlgorithm]] = {
     "hillshade": HillShade,
     "slope": Slope,
     "contours": Contours,
@@ -45,30 +45,30 @@
 class Algorithms:
     """Algorithms."""
 
-    data: Dict[str, Type[BaseAlgorithm]] = attr.ib()
+    data: dict[str, type[BaseAlgorithm]] = attr.ib(factory=dict)
 
-    def get(self, name: str) -> BaseAlgorithm:
+    def get(self, name: str) -> type[BaseAlgorithm]:
         """Fetch a TMS."""
         if name not in self.data:
             raise KeyError(f"Invalid name: {name}")
 
         return self.data[name]
 
-    def list(self) -> List[str]:
+    def list(self) -> list[str]:
         """List registered Algorithm."""
         return list(self.data.keys())
 
     def register(
         self,
-        algorithms: Dict[str, BaseAlgorithm],
+        algorithms: dict[str, BaseAlgorithm],
         overwrite: bool = False,
     ) -> "Algorithms":
         """Register Algorithm(s)."""
         for name, _algo in algorithms.items():
             if name in self.data and not overwrite:
                 raise Exception(f"{name} is already a registered. Use overwrite=True.")
 
-        return Algorithms({**self.data, **algorithms})
+        return Algorithms({**self.data, **algorithms})  # type: ignore [dict-item]
 
     @property
     def dependency(self):
@@ -80,10 +80,10 @@ def post_process(
                 Query(description="Algorithm name"),
             ] = None,
             algorithm_params: Annotated[
-                Optional[str],
+                str | None,
                 Query(description="Algorithm parameter"),
             ] = None,
-        ) -> Optional[BaseAlgorithm]:
+        ) -> BaseAlgorithm | None:
             """Data Post-Processing options."""
             kwargs = json.loads(algorithm_params) if algorithm_params else {}
             if algorithm: