fix template loading for starlette >= 0.28

developmentseed · Jan 1, 2024 · 245bed9 · 245bed9
1 parent 0fddd7e
commit 245bed9
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 19 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,9 +2,16 @@
 
 ## Unreleased
 
+### titiler.core
+* fix template loading for starlette >= 0.28 by using `jinja2.Environment` argument
+
+### titiler.extensions
+* fix template loading for starlette >= 0.28 by using `jinja2.Environment` argument
+
 ### titiler.application
 
 * add simple *auth* (optional) based on `global_access_token` string, set with `TITILER_API_GLOBAL_ACCESS_TOKEN` environment variable (author @DeflateAwning, https://github.com/developmentseed/titiler/pull/735)
+* fix template loading for starlette >= 0.28 by using `jinja2.Environment` argument
 
 ## 0.15.6 (2023-11-16)
 

diff --git a/src/titiler/application/titiler/application/main.py b/src/titiler/application/titiler/application/main.py
@@ -40,10 +40,10 @@
 logging.getLogger("botocore.utils").disabled = True
 logging.getLogger("rio-tiler").setLevel(logging.ERROR)
 
-templates = Jinja2Templates(
-    directory="",
-    loader=jinja2.ChoiceLoader([jinja2.PackageLoader(__package__, "templates")]),
-)  # type:ignore
+jinja2_env = jinja2.Environment(
+    loader=jinja2.ChoiceLoader([jinja2.PackageLoader(__package__, "templates")])
+)
+templates = Jinja2Templates(env=jinja2_env)
 
 
 api_settings = ApiSettings()
@@ -56,7 +56,8 @@
 def validate_access_token(access_token: str = Security(api_key_query)):
     """Validates API key access token, set as the `api_settings.global_access_token` value.
     Returns True if no access token is required, or if the access token is valid.
-    Raises an HTTPException (401) if the access token is required but invalid/missing."""
+    Raises an HTTPException (401) if the access token is required but invalid/missing.
+    """
     if api_settings.global_access_token is None:
         return True
 

diff --git a/src/titiler/core/titiler/core/factory.py b/src/titiler/core/titiler/core/factory.py
@@ -70,11 +70,10 @@
 from titiler.core.routing import EndpointScope
 from titiler.core.utils import render_image
 
-DEFAULT_TEMPLATES = Jinja2Templates(
-    directory="",
-    loader=jinja2.ChoiceLoader([jinja2.PackageLoader(__package__, "templates")]),
-)  # type:ignore
-
+jinja2_env = jinja2.Environment(
+    loader=jinja2.ChoiceLoader([jinja2.PackageLoader(__package__, "templates")])
+)
+DEFAULT_TEMPLATES = Jinja2Templates(env=jinja2_env)
 
 img_endpoint_params: Dict[str, Any] = {
     "responses": {

diff --git a/src/titiler/extensions/titiler/extensions/viewer.py b/src/titiler/extensions/titiler/extensions/viewer.py
@@ -9,10 +9,10 @@
 
 from titiler.core.factory import BaseTilerFactory, FactoryExtension
 
-DEFAULT_TEMPLATES = Jinja2Templates(
-    directory="",
-    loader=jinja2.ChoiceLoader([jinja2.PackageLoader(__package__, "templates")]),
-)  # type:ignore
+jinja2_env = jinja2.Environment(
+    loader=jinja2.ChoiceLoader([jinja2.PackageLoader(__package__, "templates")])
+)
+DEFAULT_TEMPLATES = Jinja2Templates(env=jinja2_env)
 
 
 @dataclass

diff --git a/src/titiler/extensions/titiler/extensions/wms.py b/src/titiler/extensions/titiler/extensions/wms.py
@@ -22,10 +22,10 @@
 from titiler.core.resources.enums import ImageType, MediaType
 from titiler.core.utils import render_image
 
-DEFAULT_TEMPLATES = Jinja2Templates(
-    directory="",
-    loader=jinja2.ChoiceLoader([jinja2.PackageLoader(__package__, "templates")]),
-)  # type:ignore
+jinja2_env = jinja2.Environment(
+    loader=jinja2.ChoiceLoader([jinja2.PackageLoader(__package__, "templates")])
+)
+DEFAULT_TEMPLATES = Jinja2Templates(env=jinja2_env)  # type:ignore
 
 
 class WMSMediaType(str, Enum):
@@ -522,7 +522,6 @@ def _reader(src_path: str):
                 return image, format, transparent
 
             if request_type.lower() == "getmap":
-
                 # List of required parameters (styles and crs are excluded)
                 req_keys = {
                     "version",