Flask View Function API

View-Funktionen können spezielle Attribute haben, die an sie angehängt werden, um das Routing-Verhalten zu steuern. Diese Attribute müssen normalerweise nicht manuell festgelegt werden, sind aber in bestimmten fortgeschrittenen Szenarien sehr nützlich.


Attribute von View-Funktionen

Eigenschaft Type Standardwert Beschreibung
__name__ str Funktionsname Wird als Endpunktname verwendet. In Blueprints wird automatisch das Präfix des Blueprint-Namens vorangestellt.
methods Liste Keine Die von der View-Funktion akzeptierten HTTP-Methoden. Wenn in add_url_rule nichts angegeben ist, wird dieser Wert verwendet.
required_methods set Keine HTTP-Methoden, die hinzugefügt werden müssen. Selbst wenn add_url_rule explizit Methoden angibt, werden diese Methoden trotzdem zwangsweise hinzugefügt.
provide_automatic_options bool Keine Ob OPTIONS-Anfragen automatisch behandelt werden sollen. Auf False setzen, um die OPTIONS-Antwort anzupassen.

Anwendungsfall

Szenarien Verwendetes Attribut Beschreibung
Benutzerdefinierte OPTIONS-Antwort provide_automatic_options=False Verhindern, dass Flask OPTIONS automatisch generiert; die View-Funktion soll es selbst behandeln.
Methoden in Dekoratoren festlegen methods Dekoratoren können die Methodenliste der View-Funktion vorab festlegen.
Methoden zwangsweise hinzufügen required_methods Sicherstellen, dass bestimmte Methoden immer registriert werden

Codebeispiele

Beispiel

from flask import Flask, request

app = Flask(__name__)

# Beispiel 1: Benutzerdefinierte OPTIONS-Antwort
def custom_endpoint():
    if request.method == "OPTIONS":
        # Benutzerdefinierte OPTIONS-Antwort zurückgeben
        return "", 200, {"Allow": "GET, POST"}
    return "Hallo, EXAMPLE!"

# Automatische OPTIONS deaktivieren
custom_endpoint.provide_automatic_options = False
custom_endpoint.methods = ["GET", "POST", "OPTIONS"]

app.add_url_rule("/custom", view_func=custom_endpoint)

# Beispiel 2: Einen Dekorator definieren, um Methoden automatisch festzulegen
def api_view(func):
    """Benutzerdefinierter Dekorator: legt Methoden für View-Funktionen automatisch fest"""
    func.methods = ["GET", "POST"]
    return func

@api_view
def api_handler():
    return {"status": "ok"}

app.add_url_rule("/api", view_func=api_handler)
# An diesem Punkt werden Methoden automatisch aus den Funktionsattributen gelesen
Weitere Erweiterungen