Flask API für Hilfsfunktionen und Klassen
Flask bietet eine Reihe global verfügbarer Funktionen für allgemeine Vorgänge wie das Generieren von URLs, das Beenden von Anfragen und das Erstellen von Antworten.
Alle bestandenfrom flask import ...Import.
Globales Proxy-Objekt
| Objekt | Type | Beschreibung |
|---|---|---|
| current_app | Proxy → Flask | Verweist auf die aktuell aktive Flask-Anwendungsinstanz. Verfügbar im Anwendungskontext. |
URLs und Weiterleitungen.
| Funktion | Signatur | Beschreibung |
|---|---|---|
| url_for | (endpoint, *, _anchor, _method, _scheme, _external, **values) | Generiert eine URL basierend auf dem Namen der View-Funktion. _external=True generiert eine absolute URL. |
| redirect | (location, code=303, Response=None) | Erstellt eine Weiterleitungsantwort. Der code ist standardmäßig 303 (See Other). |
Request-Abbau und Antwortkonstruktion.
| Funktion | Signatur | Beschreibung |
|---|---|---|
| abort | (code, *args, **kwargs) | Beendet die Anfrage sofort und gibt einen HTTP-Fehler zurück. code ist der Statuscode, description ist die Beschreibung. |
| make_response | (*args) | Wandelt den Rückgabewert der View in ein Response-Objekt um. Wenn mehrere Argumente übergeben werden, werden sie als Tupel behandelt. |
| after_this_request | (func) | Registriert eine Funktion, die nur einmal nach der aktuellen Anfrage ausgeführt wird. Wird verwendet, um after_request dynamisch hinzuzufügen. |
Kontextprüfung
| Funktion | Beschreibung |
|---|---|
| has_request_context() | Gibt True zurück, wenn ein aktiver Request-Kontext vorhanden ist. |
| has_app_context() | Gibt True zurück, wenn ein aktiver Anwendungskontext vorhanden ist. |
| copy_current_request_context(func) | Decorator. Kopiert den aktuellen Request-Kontext, sodass die dekorierte Funktion weiterhin auf request, g usw. zugreifen kann, wenn sie außerhalb des Kontexts ausgeführt wird. |
Dateiversand
| Funktion | Signatur | Beschreibung |
|---|---|---|
| send_file | (path_or_file, mimetype, as_attachment, download_name, conditional, etag, last_modified, max_age) | Dateiinhalt senden. as_attachment=True löst einen Download aus. Unterstützt bedingte Anfragen und ETag. |
| send_from_directory | (directory, path, **kwargs) | Sendet Dateien sicher aus einem angegebenen Verzeichnis. Verwendet safe_join, um Path-Traversal-Angriffe zu verhindern. |
Codebeispiele
Beispiel
from flask import (Flask, current_app, url_for, redirect,
abort, make_response, after_this_request,
has_request_context, send_file, send_from_directory)
app = Flask(__name__)
@app.route("/")
def index():
# url_for generiert URL
login_url = url_for("login")
# Absolute URL generieren (einschließlich Domainname)
full_url = url_for("profile", username="example", _external=True)
return f'<a href="{login_url}">Anmelden</a>'
@app.route("/redirect-me")
def redirect_me():
# Weiterleitung zur Startseite
return redirect(url_for("index"))
@app.route("/profile/<username>")
def profile(username):
return f"Profil: {username}"
@app.route("/admin")
def admin():
# Unberechtigter Zugriff, gibt 403 zurück
abort(403, description="Zugriff verweigert")
@app.route("/download")
def download():
# Datei senden (Browser-Download auslösen)
return send_from_directory("uploads", "report.pdf",
as_attachment=True,
download_name="example_report.pdf")
@app.route("/custom-response")
def custom_response():
# Antwortobjekt manuell erstellen
resp = make_response("<h1>Benutzerdefiniert</h1>")
resp.headers["X-Powered-By"] = "EXAMPLE"
@after_this_request
def log_response(response):
app.logger.info(f"Anfrage an {request.path} abgeschlossen, Status={response.status_code}")
return response
return resp
abort, make_response, after_this_request,
has_request_context, send_file, send_from_directory)
app = Flask(__name__)
@app.route("/")
def index():
# url_for generiert URL
login_url = url_for("login")
# Absolute URL generieren (einschließlich Domainname)
full_url = url_for("profile", username="example", _external=True)
return f'<a href="{login_url}">Anmelden</a>'
@app.route("/redirect-me")
def redirect_me():
# Weiterleitung zur Startseite
return redirect(url_for("index"))
@app.route("/profile/<username>")
def profile(username):
return f"Profil: {username}"
@app.route("/admin")
def admin():
# Unberechtigter Zugriff, gibt 403 zurück
abort(403, description="Zugriff verweigert")
@app.route("/download")
def download():
# Datei senden (Browser-Download auslösen)
return send_from_directory("uploads", "report.pdf",
as_attachment=True,
download_name="example_report.pdf")
@app.route("/custom-response")
def custom_response():
# Antwortobjekt manuell erstellen
resp = make_response("<h1>Benutzerdefiniert</h1>")
resp.headers["X-Powered-By"] = "EXAMPLE"
@after_this_request
def log_response(response):
app.logger.info(f"Anfrage an {request.path} abgeschlossen, Status={response.status_code}")
return response
return resp