Add native Jinja2 extension for DRF template rendering (#4084) - #9999
Open
M97Chahboun wants to merge 5 commits into
Open
Add native Jinja2 extension for DRF template rendering (#4084)#9999M97Chahboun wants to merge 5 commits into
M97Chahboun wants to merge 5 commits into
Conversation
auvipy
self-requested a review
July 21, 2026 18:30
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces first-party Jinja2 support for DRF’s template-based form rendering helpers by adding a Jinja2 extension that exposes render_form and render_field as globals, plus tests to validate the integration.
Changes:
- Added
rest_framework.jinja2.DRFExtensionto registerrender_form/render_fieldin a Jinja2 environment. - Added new pytest coverage for using these globals in Jinja2 templates.
- Added
jinja2>=3.0to optional dependencies.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
rest_framework/jinja2.py |
Adds the new Jinja2 extension that exposes DRF form/field rendering helpers. |
tests/test_jinja2_templates.py |
Adds tests validating Jinja2 usage of render_form / render_field. |
pyproject.toml |
Adds Jinja2 as an optional dependency to support the new integration. |
Suppressed comments (2)
rest_framework/jinja2.py:18
render_formshould return a Jinja2-safe string (Markup) and should passstylein the same shape thatHTMLFormRenderer.render()expects (top-levelstyle). The current implementation passes an unusedserializerkey and returns an unmarked string.
def render_form(self, serializer, style=None):
"""Render a complete HTML form for the given serializer."""
renderer = HTMLFormRenderer()
return renderer.render(
serializer.data,
rest_framework/jinja2.py:25
render_fieldshould also returnMarkupso the HTML isn’t escaped by Jinja2 autoescape. Also, for parity with the existing Django template tag, consider honoringstyle['renderer']when provided (so callers can reuse the renderer instance populated by form rendering).
def render_field(self, field, style=None):
"""Render an individual HTML field."""
renderer = HTMLFormRenderer()
return renderer.render_field(field, style or {})
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+3
| from jinja2.ext import Extension | ||
|
|
||
| from rest_framework.renderers import HTMLFormRenderer |
Collaborator
There was a problem hiding this comment.
@M97Chahboun can you please cross check this and other suggestions?
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #4084
Summary
This PR adds native Jinja2 support for DRF's template rendering tags (
render_formandrender_field).Previously, these tags only worked with Django's default template engine. When a project was configured to use the
Jinja2backend, attempting to use these tags resulted inTemplateSyntaxErroror missing tag exceptions.To resolve this without introducing third-party dependencies (like
django-jinja), this PR introduces a new native Jinja2 extension:rest_framework.jinja2.DRFExtension.Developers can now seamlessly register this extension in their Jinja2 environment to expose the
render_formandrender_fieldglobals, matching the behavior provided for Django templates.