feat(examples): use minijinja in place of jinja2

Author: aekasitt

examples/body.py

@@ -9,14 +9,30 @@
 # HISTORY:
 # *************************************************************
 from fastapi import FastAPI, Request, Depends
-from fastapi.responses import JSONResponse
-from fastapi.templating import Jinja2Templates
+from fastapi.responses import HTMLResponse, JSONResponse
 from fastapi_csrf_protect import CsrfProtect
 from fastapi_csrf_protect.exceptions import CsrfProtectError
+from os import path
+from minijinja import Environment
 from pydantic_settings import BaseSettings
+from typing import Annotated
+
+
+def loader(name):
+  segments: list[str] = []
+  for segment in name.split("/"):
+    if "\\" in segment or segment in (".", ".."):
+      return None
+    segments.append(segment)
+  try:
+    with open(path.join("templates", *segments)) as file:
+      return file.read()
+  except (IOError, OSError):
+    pass
+
 
 app = FastAPI()
-templates = Jinja2Templates(directory="templates")
+environment = Environment(loader=loader)
 
 
 class CsrfSettings(BaseSettings):
@@ -32,13 +48,16 @@ def get_csrf_config():
   return CsrfSettings()
 
 
-@app.get("/")
-async def form(request: Request, csrf_protect: CsrfProtect = Depends()):
+@app.get("/", response_class=HTMLResponse)
+async def form(
+  request: Request, csrf_protect: Annotated[CsrfProtect, Depends(CsrfProtect)]
+) -> HTMLResponse:
   """
   Returns form template.
   """
   csrf_token, signed_token = csrf_protect.generate_csrf_tokens()
-  response = templates.TemplateResponse("form.html", {"request": request, "csrf_token": csrf_token})
+  content = environment.render_template("form.html", csrf_token=csrf_token, request=request)
+  response = HTMLResponse(content=content)
   csrf_protect.set_csrf_cookie(signed_token, response)
   return response
 

examples/form_data.py

@@ -9,15 +9,31 @@
 # HISTORY:
 # *************************************************************
 from fastapi import FastAPI, Form, Request, Depends
-from fastapi.responses import JSONResponse
-from fastapi.templating import Jinja2Templates
+from fastapi.responses import HTMLResponse, JSONResponse
 from fastapi_csrf_protect import CsrfProtect
 from fastapi_csrf_protect.exceptions import CsrfProtectError
+from minijinja import Environment
+from os import path
 from pydantic import EmailStr, StrictStr
 from pydantic_settings import BaseSettings
+from typing import Annotated
+
+
+def loader(name):
+  segments: list[str] = []
+  for segment in name.split("/"):
+    if "\\" in segment or segment in (".", ".."):
+      return None
+    segments.append(segment)
+  try:
+    with open(path.join("templates", *segments)) as file:
+      return file.read()
+  except (IOError, OSError):
+    pass
+
 
 app = FastAPI()
-templates = Jinja2Templates(directory="templates")
+environment = Environment(loader=loader, reload_before_render=True)
 
 
 class CsrfSettings(BaseSettings):
@@ -33,13 +49,16 @@ def get_csrf_config():
   return CsrfSettings()
 
 
-@app.get("/")
-async def form(request: Request, csrf_protect: CsrfProtect = Depends()):
+@app.get("/", response_class=HTMLResponse)
+async def form(
+  request: Request, csrf_protect: Annotated[CsrfProtect, Depends(CsrfProtect)]
+) -> HTMLResponse:
   """
   Returns form template.
   """
   csrf_token, signed_token = csrf_protect.generate_csrf_tokens()
-  response = templates.TemplateResponse("form.html", {"request": request, "csrf_token": csrf_token})
+  content: str = environment.render_template("form.html", csrf_token=csrf_token, request=request)
+  response: HTMLResponse = HTMLResponse(content=content)
   csrf_protect.set_csrf_cookie(signed_token, response)
   return response
 

examples/header.py

@@ -9,14 +9,30 @@
 # HISTORY:
 # *************************************************************
 from fastapi import FastAPI, Request, Depends
-from fastapi.responses import JSONResponse
-from fastapi.templating import Jinja2Templates
+from fastapi.responses import HTMLResponse, JSONResponse
 from fastapi_csrf_protect import CsrfProtect
 from fastapi_csrf_protect.exceptions import CsrfProtectError
+from minijinja import Environment
+from os import path
 from pydantic_settings import BaseSettings
+from typing import Annotated
+
+
+def loader(name):
+  segments: list[str] = []
+  for segment in name.split("/"):
+    if "\\" in segment or segment in (".", ".."):
+      return None
+    segments.append(segment)
+  try:
+    with open(path.join("templates", *segments)) as file:
+      return file.read()
+  except (IOError, OSError):
+    pass
+
 
 app = FastAPI()
-templates = Jinja2Templates(directory="templates")
+environment = Environment(loader=loader, reload_before_render=True)
 
 
 class CsrfSettings(BaseSettings):
@@ -30,15 +46,16 @@ def get_csrf_config():
   return CsrfSettings()
 
 
-@app.get("/")
-async def form(request: Request, csrf_protect: CsrfProtect = Depends()):
+@app.get("/", response_class=HTMLResponse)
+async def form(
+  request: Request, csrf_protect: Annotated[CsrfProtect, Depends(CsrfProtect)]
+) -> HTMLResponse:
   """
   Returns form template.
   """
   csrf_token, signed_token = csrf_protect.generate_csrf_tokens()
-  response = templates.TemplateResponse(
-    "header.html", {"request": request, "csrf_token": csrf_token}
-  )
+  content = environment.render_template("header.html", csrf_token=csrf_token, request=request)
+  response = HTMLResponse(content=content)
   csrf_protect.set_csrf_cookie(signed_token, response)
   return response
 

pyproject.toml

@@ -10,10 +10,11 @@ dev = [
   'ruff >=0.4.7',
 ]
 examples = [
-  'Jinja2 >=3.0.1',
   'python-multipart >=0.0.6',
   'pydantic[email] >=1.7.2,<3.0.0',
   'uvicorn >=0.15.0',
+  'minijinja >=2.11.0',
+  'fastapi >=0.115.12',
 ]
 tests = [
   'fastapi >=0',

templates/form.html

@@ -1,30 +1,28 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title>
-      Registration Form
-    </title>
-    <link href='https://fonts.googleapis.com/css?family=Roboto:300,400,500,700' rel='stylesheet'>
+    <link
+      href='https://fonts.googleapis.com/css?family=Roboto:300,400,500,700'
+      rel='stylesheet'
+      >
     <link
       crossorigin='anonymous'
       href='https://use.fontawesome.com/releases/v5.4.1/css/all.css'
       integrity='sha384-5sAR7xN1Nv6T6+dT2mhtzEpVJvfS3NScPQTrOxhwjIuvcA67KV2R5Jz6kr4abQsz'
       rel='stylesheet'
       >
+     <link
+       href='data:image/png;base64,iVBORw0KGgo='
+       rel='icon'
+       >
     <style>
-      html,
-      body {
+      body, html {
         display: flex;
         justify-content: center;
         height: 100%;
       }
 
-      body,
-      div,
-      h1,
-      form,
-      input,
-      p {
+      body, div, form, input, p {
         padding: 0;
         margin: 0;
         outline: none;
@@ -40,15 +38,18 @@
         text-align: center;
       }
 
-      p {
-        font-size: 12px;
-      }
-
       hr {
         color: #a9a9a9;
         opacity: 0.3;
       }
+
+      p {
+        font-size: 12px;
+      }
     </style>
+    <title>
+      Registration Form
+    </title>
   </head>
   <body>
     <div class='main-block'>
@@ -73,8 +74,8 @@ <h1>
         <input type='password' name='password' id='password' placeholder='Password' required/>
         <hr>
         <input type='submit' value='Submit'/>
-        <input type='hidden' name='csrf-token' value="{{ csrf_token }}"/>
+        <input type='hidden' name='csrf-token' value='{{ csrf_token }}'/>
       </form>
     </div>
   </body>
-</html>
+</html>