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

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-адреса blueprints

Поскольку blueprints могут автоматически добавлять префикс ко всем URL-адресам с общим строковым значением, легко автоматически добавить это для каждой функции. Кроме того, blueprints могут иметь обработчики URL на уровне blueprints, что устраняет большую часть логики из функции 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():
    ...