API функций представления Flask

Функции представления могут иметь специальные атрибуты, привязанные к ним для управления поведением маршрутизации. Обычно эти атрибуты не нужно задавать вручную, но они очень полезны в некоторых продвинутых сценариях.


Атрибуты функций представления

Свойство Type Значение по умолчанию Описание
__name__ str Имя функции Используется как имя конечной точки. В blueprints префикс имени blueprint автоматически добавляется в начало.
methods list Отсутствует HTTP-методы, принимаемые функцией представления. Если они не указаны в add_url_rule, используется это значение.
required_methods set Отсутствует HTTP-методы, которые должны быть добавлены. Даже если add_url_rule явно указывает методы, эти методы всё равно будут принудительно добавлены.
provide_automatic_options bool Отсутствует Следует ли автоматически обрабатывать OPTIONS-запросы. Установите False, чтобы настроить ответ OPTIONS.

Сценарий использования

Сценарии Используемый атрибут Описание
Пользовательский ответ OPTIONS provide_automatic_options=False Запретите Flask автоматически генерировать OPTIONS; пусть функция представления обрабатывает их самостоятельно.
Установка методов в декораторах methods Декораторы могут заранее задавать список методов функции представления.
Принудительное добавление методов required_methods Убедитесь, что конкретные методы всегда зарегистрированы

Примеры кода

Пример

from flask import Flask, request

app = Flask(__name__)

# Пример 1: пользовательский ответ OPTIONS
def custom_endpoint():
    if request.method == "OPTIONS":
        # Вернуть пользовательский ответ OPTIONS
        return "", 200, {"Allow": "GET, POST"}
    return "Hello, EXAMPLE!"

# Отключить автоматические OPTIONS
custom_endpoint.provide_automatic_options = False
custom_endpoint.methods = ["GET", "POST", "OPTIONS"]

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

# Пример 2: Определить декоратор для автоматической установки методов
def api_view(func):
    """Пользовательский декоратор: автоматически устанавливает методы для функций представления"""
    func.methods = ["GET", "POST"]
    return func

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

app.add_url_rule("/api", view_func=api_handler)
# На этом этапе методы будут автоматически считываться из атрибутов функции
Другие расширения