Context Processors

Context processors are callables that inject data into every template context automatically, so you don’t repeat the same variables in every view.

Built-in processors

Processor	Injects	Default
buraq.template.context_processors.request	{{ request }}	Yes
buraq.template.context_processors.auth	{{ user }}	Yes
buraq.template.context_processors.debug	{{ DEBUG }}	No
buraq.template.context_processors.i18n	{{ LANGUAGE_CODE }}	No

Configuration

settings.py

TEMPLATE_CONTEXT_PROCESSORS = [
    "buraq.template.context_processors.request",
    "buraq.template.context_processors.auth",
    "buraq.template.context_processors.debug",
    "buraq.template.context_processors.i18n",
    "myapp.context_processors.site_settings",
]

Writing a custom processor

myapp/context_processors.py

async def site_settings(request) -> dict:
    from buraq.contrib.sites.models import Site
    site = await Site.get_current(request)
    return {"site": site}

Both sync and async processors are supported. Async processors are awaited automatically.

Using in views

render() automatically calls every listed processor and merges the results before rendering — you don’t need to do anything:

from buraq.shortcuts import render

async def my_view(request):
    posts = await Post.objects.filter(is_published=True).all()
    return await render(request, "posts/list.html", {"posts": posts})
    # {{ user }}, {{ request }}, etc. are available automatically

If you’re building context manually (e.g. with TemplateResponse directly), call run_context_processors yourself:

from buraq.template.context_processors import run_context_processors

async def my_view(request):
    ctx = await run_context_processors(request)
    ctx["posts"] = await Post.objects.filter(published=True).all()
    return templates.TemplateResponse(request, "posts/list.html", ctx)

Using in templates

After processors run, their variables are available in any template:

<p>Hello, {{ user.username }}</p>
<p>Language: {{ LANGUAGE_CODE }}</p>