remove deprecated and fix typing hints

Author: vincentsarago

CHANGES.md

@@ -34,6 +34,7 @@
     - `titiler.core.dependencies.BandsExprParams`
     - `titiler.core.dependencies.parse_asset_indexes()`
     - `titiler.core.dependencies.parse_asset_expression()`
+    - `titiler.core.routing.apiroute_factory()`
 
 ### titiler.extensions
 

docs/mkdocs.yml

@@ -52,7 +52,6 @@ nav:
       - Performance Tuning: "advanced/performance_tuning.md"
       - Extensions: "advanced/Extensions.md"
       - Observability with OpenTelemetry: "advanced/telemetry.md"
-      # - APIRoute and environment variables: "advanced/APIRoute_and_environment_variables.md"
 
   - Packages:
     - titiler.core: "packages/core.md"

docs/src/advanced/APIRoute_and_environment_variables.md

@@ -36,10 +36,9 @@ dependencies = [
     "numpy",
     "pydantic~=2.0",
     "rasterio",
-    "rio-tiler>=9.0.0a1,<10.0",
+    "rio-tiler>=9.0.0a4,<10.0",
     "morecantile",
     "simplejson",
-    "typing_extensions>=4.6.1",
 ]
 
 [project.optional-dependencies]

src/titiler/core/pyproject.toml

@@ -8,7 +8,7 @@
 from dataclasses import dataclass
 from enum import Enum
 from io import BytesIO
-from typing import Dict, Optional, Sequence, Type
+from typing import Annotated, Dict, Optional, Sequence, Type
 from unittest.mock import patch
 from urllib.parse import quote, urlencode
 
@@ -27,7 +27,6 @@
 from rio_tiler.io import BaseReader, MultiBandReader, Reader, STACReader
 from starlette.requests import Request
 from starlette.testclient import TestClient
-from typing_extensions import Annotated
 
 from titiler.core import dependencies
 from titiler.core.errors import DEFAULT_STATUS_CODES, add_exception_handlers

src/titiler/core/tests/test_factories.py

@@ -1,131 +1,10 @@
-"""Test Custom APIRoute factory."""
-
-from concurrent import futures
+"""Test route dependencies."""
 
 import httpx
-import pytest
-import rasterio
-from fastapi import APIRouter, Depends, FastAPI, HTTPException, security, status
-from rasterio._env import get_gdal_config
+from fastapi import Depends, FastAPI, HTTPException, security, status
 from starlette.testclient import TestClient
 
-from titiler.core.routing import add_route_dependencies, apiroute_factory
-
-
-@pytest.mark.xfail
-def test_withoutCustomRoute(monkeypatch):
-    """Create App."""
-    monkeypatch.setenv("GDAL_DISABLE_READDIR_ON_OPEN", "something")
-
-    app = FastAPI()
-    router = APIRouter()
-
-    def f(r):
-        return get_gdal_config("GDAL_DISABLE_READDIR_ON_OPEN")
-
-    @router.get("/simple")
-    def home():
-        """Works and should return FALSE."""
-        with rasterio.Env(GDAL_DISABLE_READDIR_ON_OPEN="FALSE"):
-            res = get_gdal_config("GDAL_DISABLE_READDIR_ON_OPEN")
-        return {"env": res}
-
-    @router.get("/asimple")
-    async def home1():
-        """Works and should return FALSE."""
-        with rasterio.Env(GDAL_DISABLE_READDIR_ON_OPEN="FALSE"):
-            res = get_gdal_config("GDAL_DISABLE_READDIR_ON_OPEN")
-        return {"env": res}
-
-    @router.get("/future")
-    def home2():
-        """Doesn't work and should return the value from env."""
-        with rasterio.Env(GDAL_DISABLE_READDIR_ON_OPEN="FALSE"):
-            with futures.ThreadPoolExecutor() as executor:
-                res = list(executor.map(f, range(1)))[0]
-        return {"env": res}
-
-    @router.get("/afuture")
-    async def home3():
-        """Works and should return FALSE."""
-        with rasterio.Env(GDAL_DISABLE_READDIR_ON_OPEN="FALSE"):
-            with futures.ThreadPoolExecutor() as executor:
-                res = list(executor.map(f, range(1)))[0]
-        return {"env": res}
-
-    app.include_router(router)
-    client = TestClient(app)
-
-    response = client.get("/simple")
-    assert response.json()["env"] == "FALSE"
-
-    response = client.get("/asimple")
-    assert response.json()["env"] == "FALSE"
-
-    # confirm the multi threads case doesn't work
-    response = client.get("/future")
-    assert not response.json()["env"] == "FALSE"
-
-    response = client.get("/afuture")
-    assert response.json()["env"] == "FALSE"
-
-
-@pytest.mark.xfail
-def test_withCustomRoute(monkeypatch):
-    """Create App."""
-    monkeypatch.setenv("GDAL_DISABLE_READDIR_ON_OPEN", "something")
-
-    app = FastAPI()
-
-    env = {"GDAL_DISABLE_READDIR_ON_OPEN": "FALSE"}
-    with pytest.warns(DeprecationWarning):
-        route_class = apiroute_factory(env)
-    router = APIRouter(route_class=route_class)
-
-    def f(r):
-        return get_gdal_config("GDAL_DISABLE_READDIR_ON_OPEN")
-
-    @router.get("/simple")
-    def home():
-        """Works and should return FALSE."""
-        res = get_gdal_config("GDAL_DISABLE_READDIR_ON_OPEN")
-        return {"env": res}
-
-    @router.get("/asimple")
-    async def home1():
-        """Works and should return FALSE."""
-        res = get_gdal_config("GDAL_DISABLE_READDIR_ON_OPEN")
-        return {"env": res}
-
-    @router.get("/future")
-    def home2():
-        """Doesn't work and should return the value from env."""
-        with futures.ThreadPoolExecutor() as executor:
-            res = list(executor.map(f, range(1)))[0]
-        return {"env": res}
-
-    @router.get("/afuture")
-    async def home3():
-        """Works and should return FALSE."""
-        with futures.ThreadPoolExecutor() as executor:
-            res = list(executor.map(f, range(1)))[0]
-        return {"env": res}
-
-    app.include_router(router)
-    client = TestClient(app)
-
-    response = client.get("/simple")
-    assert response.json()["env"] == "FALSE"
-
-    response = client.get("/asimple")
-    assert response.json()["env"] == "FALSE"
-
-    # confirm the Custom APIRoute class fix
-    response = client.get("/future")
-    assert response.json()["env"] == "FALSE"
-
-    response = client.get("/afuture")
-    assert response.json()["env"] == "FALSE"
+from titiler.core.routing import add_route_dependencies
 
 
 def test_register_deps():

src/titiler/core/tests/test_routing.py

@@ -1,53 +1,10 @@
 """Custom routing classes."""
 
-import warnings
-from collections.abc import Callable
+from typing import TypedDict
 
-import rasterio
 from fastapi import params
 from fastapi.dependencies.utils import get_parameterless_sub_dependant
-from fastapi.routing import APIRoute
-from starlette.requests import Request
-from starlette.responses import Response
 from starlette.routing import BaseRoute, Match
-from typing_extensions import TypedDict
-
-
-def apiroute_factory(env: dict | None = None) -> type[APIRoute]:
-    """
-    Create Custom API Route class with custom Env.
-
-    Because we cannot create middleware for specific router we need to create
-    a custom APIRoute which add the `rasterio.Env(` block before the endpoint is
-    actually called. This way we set the env outside the threads and we make sure
-    that event multithreaded Reader will get the environment set.
-
-    Note: This has been tested in python 3.6 and 3.7 only.
-
-    """
-    warnings.warn(
-        "'apiroute_factory' has been deprecated and will be removed"
-        "in titiler 0.1.0. Please see `environment_dependency` option in endpoint factories.",
-        DeprecationWarning,
-        stacklevel=1,
-    )
-
-    class EnvAPIRoute(APIRoute):
-        """Custom API route with env."""
-
-        config = env or {}
-
-        def get_route_handler(self) -> Callable:
-            original_route_handler = super().get_route_handler()
-
-            async def custom_route_handler(request: Request) -> Response:
-                with rasterio.Env(**self.config):
-                    response: Response = await original_route_handler(request)
-                return response
-
-            return custom_route_handler
-
-    return EnvAPIRoute
 
 
 class EndpointScope(TypedDict, total=False):

src/titiler/core/titiler/core/routing.py

@@ -1,10 +1,9 @@
 """rio-stac Extension."""
 
-from typing import Annotated, Any, Literal
+from typing import Annotated, Any, Literal, TypedDict
 
 from attrs import define
 from fastapi import Depends, Query
-from typing_extensions import TypedDict
 
 from titiler.core.factory import FactoryExtension, TilerFactory
 

src/titiler/extensions/titiler/extensions/stac.py

@@ -2,14 +2,13 @@
 
 import warnings
 from collections.abc import Callable
-from typing import Annotated
+from typing import Annotated, TypedDict
 
 import xarray
 from attrs import define
 from fastapi import Depends, Query
 from rio_tiler.constants import WGS84_CRS
 from starlette.responses import HTMLResponse
-from typing_extensions import TypedDict
 
 from titiler.core.dependencies import DefaultDependency
 from titiler.core.factory import FactoryExtension

src/titiler/xarray/titiler/xarray/extensions.py

@@ -7,7 +7,7 @@
 from collections.abc import Callable
 from functools import cache
 from pathlib import Path
-from typing import Any, Literal
+from typing import Any, Literal, TypedDict
 from urllib.parse import urlparse
 
 import attr
@@ -18,7 +18,6 @@
 from morecantile import TileMatrixSet
 from rio_tiler.constants import WEB_MERCATOR_TMS
 from rio_tiler.io.xarray import XarrayReader
-from typing_extensions import TypedDict
 from zarr.storage import ObjectStore
 
 X_DIM_NAMES = ["lon", "longitude", "LON", "LONGITUDE", "Lon", "Longitude"]