How to work with Fastapi #64

yxlwfds · 2023-12-18T02:25:08Z

yxlwfds
Dec 18, 2023

@router.get('/article', summary='Article信息') async def get_article(id: int, db: AsyncSession = Depends(get_db)):

Jinjax will blocked when use async of fastapi?

yxlwfds · 2023-12-18T03:23:51Z

yxlwfds
Dec 18, 2023
Author

Layout.jinja:
`{#def title #}

<title>{{ title }}</title> 111 {{ content }} `

router:
@app.get("/gc/components") def get_components(): catalog.render("Layout", title="Hello world", content="TEST")

Not work in fastapi!

0 replies

yxlwfds · 2023-12-18T03:56:29Z

yxlwfds
Dec 18, 2023
Author

you have to pass the request as part of the key-value pairs in the context for Jinja2. So, you also have to declare it in your path operation.
fastapi doc:https://fastapi.tiangolo.com/advanced/templates/

0 replies

thornewolf · 2023-12-28T19:20:42Z

thornewolf
Dec 28, 2023

So this took me a little bit of time to get correct since I wanted to bind to the existing starlette url_for implementation.

Here are some useful code snippets

_TEMPLATES_DIR = "fastapi_site/templates"
templates = Jinja2Templates(_TEMPLATES_DIR)
catalog = Catalog(jinja_env=templates.env)
catalog.add_folder(_TEMPLATES_DIR)

def render(*args, **kwargs):
    return HTMLResponse(catalog.render(*args, **kwargs))

# Then later
@app.get("/")
def index(request: Request) -> Response:
    return render(
        "Index",
        request=request,
        title="Home",
    )

Index.jinja

{#def request, title #}
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>My Simple Page</title>
</head>
<body>
    <h1>{{ title }}</h1>
    <SampleComponent request={request}/>
</body>
</html>

SampleComponent.jinja

{#def request #}
<ul>
        <li>Item 1</li>
        <li>Item 2</li>
        <li>Item 3</li>
        {{ url_for('index') }}
</ul>

0 replies

thomastraum · 2024-02-01T10:45:46Z

thomastraum
Feb 1, 2024

@thornewolf, this helped me loads. Maybe worth adding to the documentation. thank you for posting it here. is there a way to avoid having to pass requests all the time I am using url_for() pretty much everywhere.

0 replies

knowsuchagency · 2024-05-02T02:34:42Z

knowsuchagency
May 2, 2024

A simpler way IMO is to add the extension

import jinjax
from fastapi import FastAPI, Request
from fastapi.templating import Jinja2Templates

app = FastAPI()

templates = Jinja2Templates(directory="templates")

# add this
templates.env.add_extension(jinjax.JinjaX)

catalog = jinjax.Catalog(jinja_env=templates.env)
catalog.add_folder("templates/components")


@app.get("/")
async def read_root(request: Request):
    return templates.TemplateResponse("index.html", {"request": request})

3 replies

mjgraham123 Sep 26, 2024

JinjaX is awesome! It makes the building and reading templates way more efficient.
The suggestion from @knowsuchagency works great for keeping existing code working while sprinkling in components. Nice!
The only outstanding annoyance is that the use of url_for in FastAPI requires the request to be in context. That means that each component file needs to declare the request variable and all components need to pass the request in via an attribute.

Is there a way to get the request that's passed in via catalog.render('Component', request=request) available as a global variable in the Jinja environment (scoped to the current rendering in process)?

As a hint, here's an excerpt from the stack trace where the component didn't receive the request explicitly:

  File "/opt/nxtgen/app/templates/components/Page.jinja", line 4, in top-level template code
    {{ test_message }} this is broken -> {{ url_for('static', path='js/bootstrap.bundle.min.js') }}
    ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/venv/lib/python3.12/site-packages/starlette/templating.py", line 125, in url_for
    request: Request = context["request"]
                       ~~~~~~~^^^^^^^^^^^
  File "/opt/venv/lib/python3.12/site-packages/jinja2/runtime.py", line 336, in __getitem__
    raise KeyError(key)

mjgraham123 Sep 26, 2024

@yxlwfds Is there any way to automatically have .render pass on the request and/or a dict of "persistent" kwargs to each .irender? I tried request = kw.get("request") at the top of irender and then args["request"] = request just before returning component.render(**args) and it passed the request through to components and subcomponents. Not sure this would be the best way to do that, but it solves the issue of "the request is commonly needed at any given time in any given template". request provides url mapping (url_for), access to current scope like current_user, etc. Very valuable.

magoocas Oct 23, 2024

@mjgraham123 This is how I do it:

content = catalog.render('Component', __globals={"url_for": request.url_for, **context})

context would be any other globals you want available

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

How to work with Fastapi #64

{{title}}

Replies: 5 comments 3 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Select a reply

How to work with Fastapi #64

yxlwfds Dec 18, 2023

Replies: 5 comments · 3 replies

yxlwfds Dec 18, 2023 Author

yxlwfds Dec 18, 2023 Author

thornewolf Dec 28, 2023

thomastraum Feb 1, 2024

knowsuchagency May 2, 2024

mjgraham123 Sep 26, 2024

mjgraham123 Sep 26, 2024

magoocas Oct 23, 2024

yxlwfds
Dec 18, 2023

Replies: 5 comments 3 replies

yxlwfds
Dec 18, 2023
Author

yxlwfds
Dec 18, 2023
Author

thornewolf
Dec 28, 2023

thomastraum
Feb 1, 2024

knowsuchagency
May 2, 2024