starlette-async-jinja 1.2.5

No project description provided

starlette-async-jinja

Jinja2 is_async template support for Starlette +

About

• Provides AsyncJinja2Templates class which enables use of the is_async Jinja environment flag with Startlette and Starlette based applications like FastAPI
• Integrated Jinja Partials and Jinja Fragments
• Supports asynchronous template loaders (examples here) (not yet tested but should work)

Issues

• Only asynchronous template loaders (not yet tested but should work) are currently supported

• The Jinja bytecodecache requires an asynchronous Redis backend

Usage

Import AsyncJinja2 Templates:

from starlette_async_jinja import AsyncJinja2Templates

Replace Jinja2Templates with AsyncJinja2Templates:

templates = Jinja2Templates(directory='templates')

Render the async template in the response:

async def homepage(request: Request):
    return await templates.AsyncTemplateResponse('index.html', {'request': request})

Even simpler:

async def homepage(request: Request):
    return await templates.render_template('index.html', {'request': request})

To render Jinja Fragments or 'blocks':

async def only_block(request: Request):
    return await templates.render_block(
        "page.html.jinja2",
        {"request": request, "magic_number": 42},
        block_name="content"
    )

To render Jinja Partials:

in a template

{% for v in row %}
  <div class="col-md-3 video">
      {{ render_partial('shared/partials/video_square.html', video=v) }}
  </div>
{% endfor %}

or programmatically

async def render_partial(template: str, **kwargs):
  return await templates.render_partial(template, **kwargs)

Acknowledgements

License

BSD-3-Clause