Skip to content

Templates

Selva offers support for rendering html responses from templates.

Usage

First install the Jinja extension.

By default, template files are located in the resources/templates directory:

project/
├── application/
│   └── ...
└── resources/
    └── templates/
        ├── index.html
        └── ...

To render templates, inject the selva.web.templates.Template dependency and call its respond method:

from typing import Annotated
from selva.di import Inject
from selva.web import controller, get
from selva.web.templates import Template


@controller
class Controller:
    template: Annotated[Template, Inject]

    @get
    async def index(self, request):
        context = {"title": "Index"}
        await self.template.respond(request.response, "index.html", context)

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Jinja Templates</title>
</head>
<body>
    <h1>{{ title }}</h1>
</body>
</html>

Render templates to str

The Template interface provide methods to render templates into an str, instead of rendering to the response.

The method Tempate.render accepts a template name and returns a string with the rendered template.

The method Template.render_str accepts a template string, compiles it and returns the result.

Configuration

Selva offers configuration options for templates.

templates:
  backend: "jinja" # (1)
  paths: # (2)
    ["resources/templates"]
  1. If there are more extensions that provide templates, the backend property can be used to choose which one to use.
  2. Paths that will be used to look for templates.

Extensions providing templates

If you are writing an extension that provides a selva.web.templates.Template implementation, make sure to check whether the value of configuration property templates.backend matches with your extension's __package__ or no other implementation has been registered yet.

For example, the function selva_extension in your extension could be implemented like the following:

from selva.configuration.settings import Settings
from selva.di.container import Container
from selva.web.templates import Template


def selva_extension(container: Container, settings: Settings):
    backend = settings.templates.backend

    if backend and backend != __package__:
        return

    if not backend and container.has(Template):
        return

    # ...