warn about env_options usage

encode · Jun 1, 2023 · 7c9f4fc · 7c9f4fc
1 parent 39ee96e
commit 7c9f4fc
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/starlette/templating.py b/starlette/templating.py
@@ -1,4 +1,5 @@
 import typing
+import warnings
 from os import PathLike
 
 from starlette.background import BackgroundTask
@@ -71,6 +72,11 @@ def __init__(
         env: typing.Optional[jinja2.Environment] = None,
         **env_options: typing.Any,
     ) -> None:
+        if env_options:
+            warnings.warn(
+                "Extra environment options are deprecated. Use a preconfigured jinja2.Environment instead.",  # noqa: E501
+                DeprecationWarning,
+            )
         assert jinja2 is not None, "jinja2 must be installed to use Jinja2Templates"
         assert directory or env, "either 'directory' or 'env' arguments must be passed"
         self.context_processors = context_processors or []

diff --git a/tests/test_templates.py b/tests/test_templates.py
@@ -117,3 +117,8 @@ def test_templates_with_environment(tmpdir):
     templates = Jinja2Templates(env=env)
     template = templates.get_template("index.html")
     assert template.render({}) == "Hello"
+
+
+def test_templates_with_environment_options_emit_warning(tmpdir):
+    with pytest.warns(DeprecationWarning):
+        Jinja2Templates(str(tmpdir), autoescape=True)