URL-definierte Routing-API
Flask bietet drei Möglichkeiten, Routing-Regeln zu definieren:@app.route()Dekorator,add_url_rule()Methoden, direkte Operationenurl_map。
URL-Variablenkonverter
| Konverter | Syntax | Übereinstimmungsregeln | Python-Typen |
|---|---|---|---|
| string | <string:name> oder <name> | Beliebiger Text ohne / (Standard) | str |
| int | <int:id> | Positive Ganzzahl | int |
| float | <float:value> | Positive Gleitkommazahl | float |
| path | <path:filepath> | Beliebiger Text (einschließlich /) | str |
| any | <any(a,b,c):item> | Beliebigen Wert in der Liste abgleichen | str |
| uuid | <uuid:id> | Standard-UUID-Format | str |
add_url_rule-Parameter
| Parameter | Type | Beschreibung |
|---|---|---|
| rule | str | URL-Regel-Zeichenkette, wie "/user/<username>" |
| endpoint | str | Endpunktname, standardmäßig der Funktionsname. url_for verwendet dies, um auf die Route zu verweisen. |
| view_func | callable | View-Funktion. Kann weggelassen werden; wird später im view_functions-Dictionary gespeichert. |
| defaults | dict | Standardwerte für URL-Variablen, wie z. B. defaults={"page": 1} |
| subdomain | str | Subdomain-Abgleich. Erfordert die Aktivierung von subdomain_matching |
| methods | Liste | Erlaubte HTTP-Methoden. Standard ["GET"] (HEAD und OPTIONS werden automatisch hinzugefügt) |
| host | str | Hostnamen-Abgleich. Erfordert die Aktivierung von host_matching |
Verhalten bei abschließendem Schrägstrich
| Regeln | Zugriff ohne / | Zugriff mit / |
|---|---|---|
| @app.route("/projects/") | 308-Weiterleitung zu /projects/ | Normaler Zugriff |
| @app.route("/about") | Normaler Zugriff | 404 Nicht gefunden |
Standardwert-Route
Optionale URL-Variablen können über den Parameter defaults implementiert werden:
Beispiel
# Zwei URLs verweisen auf dieselbe Funktion; /users/ ist äquivalent zu /users/page/1
@app.route("/users/", defaults={"page": 1})
@app.route("/users/page/<int:page>")
def show_users(page):
return f"Seite {page} wird angezeigt"
# Zugriff auf /users/ → page=1
# Zugriff auf /users/page/3 → page=3
@app.route("/users/", defaults={"page": 1})
@app.route("/users/page/<int:page>")
def show_users(page):
return f"Seite {page} wird angezeigt"
# Zugriff auf /users/ → page=1
# Zugriff auf /users/page/3 → page=3
Wenn sowohl die Route mit Standardwert als auch die Route mit Variablen existiert, wird der Zugriff auf die URL mit Standardwerten mit einem 308-Redirect auf die vereinfachte Form umgeleitet.
Benutzerdefinierter Konverter
Beispiel
from werkzeug.routing import BaseConverter
# Benutzerdefinierten Typkonverter definieren
class ListConverter(BaseConverter):
"""Entspricht einer kommagetrennten Liste, z. B. /tags/python,flask"""
def to_python(self, value):
return value.split(",")
def to_url(self, values):
return ",".join(values)
# Bei url_map registrieren
app.url_map.converters["list"] = ListConverter
# Einen benutzerdefinierten Konverter verwenden
@app.route("/tags/<list:tags>")
def show_tags(tags):
# tags ist eine Python-Liste: ["python", "flask", "web"]
return f"Tags: {', '.join(tags)}"
# Benutzerdefinierten Typkonverter definieren
class ListConverter(BaseConverter):
"""Entspricht einer kommagetrennten Liste, z. B. /tags/python,flask"""
def to_python(self, value):
return value.split(",")
def to_url(self, values):
return ",".join(values)
# Bei url_map registrieren
app.url_map.converters["list"] = ListConverter
# Einen benutzerdefinierten Konverter verwenden
@app.route("/tags/<list:tags>")
def show_tags(tags):
# tags ist eine Python-Liste: ["python", "flask", "web"]
return f"Tags: {', '.join(tags)}"