API Reference

Public API for jinja_partials: framework registration, partial rendering, and the Jinja2 extension.

Framework registration

Register render_partial with your web framework once at app startup.

register_extensions()

Register jinja_partials with a Flask application.

register_fastapi_extensions()

Register jinja_partials with a FastAPI application.

register_starlette_extensions()

Register jinja_partials with Starlette templates.

register_quart_extensions()

Register jinja_partials with a Quart application.

register_environment()

Register jinja_partials with a plain Jinja2 environment.

Rendering

Render partial templates directly or build framework-specific renderers.

render_partial()

Render a partial template and return the resulting HTML fragment.

generate_render_partial()

Create a render_partial function bound to a specific renderer.

Jinja2 extension

Declarative registration via the Jinja2 extension mechanism.

PartialsJinjaExtension

Jinja2 extension that automatically registers render_partial functionality.

Exceptions

Errors raised by jinja_partials.

PartialsException

Raised when jinja_partials is misconfigured or a required web framework is not installed.