API маршрутизации, определяемой URL

Flask предоставляет три способа определения правил маршрутизации:@app.route()Декоратор,add_url_rule()Методы, прямые операцииurl_map。


Конвертер переменных URL

Конвертер Синтаксис Правила сопоставления Типы Python
string <string:name> или <name> Любой текст без / (по умолчанию) str
int <int:id> Положительное целое число int
float <float:value> Положительное число с плавающей точкой float
path <path:filepath> Любой текст (включая /) str
any <any(a,b,c):item> Соответствует любому значению в списке str
uuid <uuid:id> Стандартный формат UUID str

Параметры add_url_rule

Параметр Type Описание
rule str Строка правила URL, например "/user/<username>"
endpoint str Имя конечной точки, по умолчанию совпадает с именем функции. url_for использует его для ссылки на маршрут.
view_func вызываемый объект Функция представления. Можно опустить; позже сохраняется в словаре view_functions.
defaults dict Значения по умолчанию для переменных URL, например defaults={"page": 1}
subdomain str Сопоставление поддоменов. Требуется включить subdomain_matching
methods list Разрешённые методы HTTP. По умолчанию ["GET"] (HEAD и OPTIONS добавляются автоматически)
host str Сопоставление имени хоста. Требуется включить host_matching

Поведение при завершающем слеше

Правила Доступ без / Доступ с /
@app.route("/projects/") 308 перенаправление на /projects/ Обычный доступ
@app.route("/about") Обычный доступ 404 Not Found

Маршрут со значением по умолчанию

Необязательные переменные URL можно реализовать с помощью параметра defaults:

Пример

# Два URL указывают на одну и ту же функцию; /users/ эквивалентен /users/page/1
@app.route("/users/", defaults={"page": 1})
@app.route("/users/page/<int:page>")
def show_users(page):
    return f"Показана страница {page}"

# Доступ /users/ → page=1
# Доступ /users/page/3 → page=3

Если существуют и маршрут со значением по умолчанию, и маршрут с переменными, то при обращении к URL со значениями по умолчанию будет выполнено 308-перенаправление на упрощённую форму.


Пользовательский конвертер

Пример

from werkzeug.routing import BaseConverter

# Определяем пользовательский конвертер типа
class ListConverter(BaseConverter):
    """Сопоставляет список, разделённый запятыми, например, /tags/python,flask"""
    def to_python(self, value):
        return value.split(",")

    def to_url(self, values):
        return ",".join(values)

# Зарегистрировать в url_map
app.url_map.converters["list"] = ListConverter

# Использовать пользовательский конвертер
@app.route("/tags/<list:tags>")
def show_tags(tags):
    # tags — это список Python: ["python", "flask", "web"]
    return f"Теги: {', '.join(tags)}"
Другие расширения