Flask Template-Rendering-API
Flask verwendet die Jinja2-Engine, um Templates zu rendern und Python-Daten in HTML-Seiten einzubetten.
Template-Dateien werden standardmäßig im Projektstammverzeichnistemplates/im Ordner abgelegt.
render_template
Die am häufigsten verwendete Funktion zum Rendern von Vorlagen; lädt eine Vorlage aus einer Datei und rendert sie.
| Parameter | Type | Beschreibung |
|---|---|---|
| template_name_or_list | str / list | Vorlagendateiname (relativ zum Vorlagenordner) oder eine Liste von Vorlagennamen (gibt die erste vorhandene zurück). |
| **context | Schlüsselwortargumente | Variablen, die an die Vorlage übergeben werden, wie z. B. title="Hello", user=user_obj |
Alle Rendering-Funktionen
| Funktion | Beschreibung |
|---|---|
| render_template(template_name_or_list, **context) | Rendert eine Vorlage aus einer Datei und gibt einen HTML-String zurück. |
| render_template_string(source, **context) | Rendert ein Template aus einer Zeichenkette, geeignet für eingebettete Templates. |
| stream_template(template_name_or_list, **context) | Streamt das gerenderte Template, gibt einen Generator zurück. Geeignet für große Seiten. |
| stream_template_string(source, **context) | Streaming-Rendering von String-Templates |
| get_template_attribute(template_name, attribute) | Ruft ein Makro oder eine Variable aus dem Template ab. Kann Jinja2-Makros aus Python aufrufen. |
Eingebaute Objekte in Templates
Die folgenden Objekte sind in Templates verfügbar, ohne explizit übergeben zu werden:
| Objekt | Beschreibung |
|---|---|
| request | Aktuelles Anfrageobjekt |
| session | Aktuelles Session-Objekt |
| g | Globales Objekt auf Request-Ebene |
| config | Konfigurationswörterbuch der Anwendung |
| url_for | URL-Generierungsfunktion |
| get_flashed_messages | Funktion zum Abrufen von Flask-Nachrichten |
Codebeispiele
Beispiel
from flask import Flask, render_template, render_template_string
app = Flask(__name__)
@app.route("/")
def index():
return render_template("index.html",
title=BEISPIEL Startseite,
posts=[{"id": 1, "title": Artikel A},
{"id": 2, "title": Artikel B}])
@app.route("/inline")
def inline_template():
# Aus Zeichenkette rendern (Template-Inhalt direkt im Code geschrieben)
return render_template_string("""
<h1>Hallo, {{ name }}!</h1>
<p>Willkommen bei EXAMPLE.</p>
""", name="Welt")
@app.route("/stream")
def stream_large_page():
# Große Seiten per Stream rendern, dabei direkt generieren und senden
return stream_template("large_report.html",
items=get_10k_items())
app = Flask(__name__)
@app.route("/")
def index():
return render_template("index.html",
title=BEISPIEL Startseite,
posts=[{"id": 1, "title": Artikel A},
{"id": 2, "title": Artikel B}])
@app.route("/inline")
def inline_template():
# Aus Zeichenkette rendern (Template-Inhalt direkt im Code geschrieben)
return render_template_string("""
<h1>Hallo, {{ name }}!</h1>
<p>Willkommen bei EXAMPLE.</p>
""", name="Welt")
@app.route("/stream")
def stream_large_page():
# Große Seiten per Stream rendern, dabei direkt generieren und senden
return stream_template("large_report.html",
items=get_10k_items())