Spec-Zone.ru › Flask 3.0

Использование обработчиков URL

Журнал изменений

Новая версия 0.7.

Flask 0.7 вводит понятие обработчиков URL. Идея в том, что у вас может быть множество ресурсов с общими частями в URL, которые вы не всегда хотите явно указывать. Например, у вас может быть множество URL, содержащих код языка, но вы не хотите обрабатывать его в каждой отдельной функции.

Обработчики URL особенно полезны в сочетании с blueprints. Мы будем рассматривать обработчики URL как для приложений, так и для blueprints.

Международные URL-адреса приложения

Рассмотрим приложение такого типа:

from flask import Flask, g

app = Flask(__name__)

@app.route('/<lang_code>/')
def index(lang_code):
    g.lang_code = lang_code
    ...

@app.route('/<lang_code>/about')
def about(lang_code):
    g.lang_code = lang_code
    ...

Это очень много повторений, поскольку вам нужно обрабатывать установку кода языка для объекта g в каждой отдельной функции. Конечно, для упрощения можно использовать декоратор, но если вы хотите генерировать URL из одной функции в другую, вам все равно нужно явно указывать код языка, что может быть неудобно.

В последнем случае вступают в действие функции url_defaults(). Они могут автоматически вставлять значения в вызов url_for(). Приведенный ниже код проверяет, не содержится ли код языка в словаре значений URL и хочет ли конечная точка значение с именем 'lang_code'.

@app.url_defaults
def add_language_code(endpoint, values):
    if 'lang_code' in values or not g.lang_code:
        return
    if app.url_map.is_endpoint_expecting(endpoint, 'lang_code'):
        values['lang_code'] = g.lang_code

Метод is_endpoint_expecting() карты URL можно использовать, чтобы определить, имеет ли смысл предоставить код языка для данной конечной точки.

Обратной стороной этих функций являются обработчики url_value_preprocessor(). Они выполняются сразу после сопоставления запроса и могут выполнять код на основе значений URL. Идея состоит в том, чтобы извлечь информацию из словаря значений и поместить ее в другое место:

@app.url_value_preprocessor
def pull_lang_code(endpoint, values):
    g.lang_code = values.pop('lang_code', None)

Таким образом, вам больше не нужно выполнять присваивание lang_code объекту g в каждой функции. Вы можете дополнительно улучшить это, написав собственный декоратор, который добавляет префикс кода языка к URL-адресам, но более изящное решение — использование blueprints. Как только значение 'lang_code' будет извлечено из словаря значений, оно больше не будет передаваться функции представления, что приведет к следующему коду:

from flask import Flask, g

app = Flask(__name__)

@app.url_defaults
def add_language_code(endpoint, values):
    if 'lang_code' in values or not g.lang_code:
        return
    if app.url_map.is_endpoint_expecting(endpoint, 'lang_code'):
        values['lang_code'] = g.lang_code

@app.url_value_preprocessor
def pull_lang_code(endpoint, values):
    g.lang_code = values.pop('lang_code', None)

@app.route('/<lang_code>/')
def index():
    ...

@app.route('/<lang_code>/about')
def about():
    ...

Международные URL-адреса Blueprint

Поскольку blueprints могут автоматически добавлять общий префикс ко всем URL-адресам, легко автоматически сделать это для каждой функции. Кроме того, blueprints могут иметь обработчики URL на уровне blueprint, которые устраняют значительную часть логики из функции url_defaults(), поскольку ей больше не нужно проверять, действительно ли URL заинтересован в параметре 'lang_code'.

from flask import Blueprint, g

bp = Blueprint('frontend', __name__, url_prefix='/<lang_code>')

@bp.url_defaults
def add_language_code(endpoint, values):
    values.setdefault('lang_code', g.lang_code)

@bp.url_value_preprocessor
def pull_lang_code(endpoint, values):
    g.lang_code = values.pop('lang_code')

@bp.route('/')
def index():
    ...

@bp.route('/about')
def about():
    ...

© 2010 Pallets
Licensed under the BSD 3-clause License.
https://flask.palletsprojects.com/en/3.0.x/patterns/urlprocessors/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API