Модульные приложения с Blueprints

Почему Blueprints?

Blueprints в Flask предназначены для следующих случаев:

• Разделение приложения на набор blueprints. Это идеально подходит для больших приложений; проект может создать объект приложения, инициализировать несколько расширений и зарегистрировать набор blueprints.
• Регистрация blueprint в приложении с префиксом URL и/или поддоменом. Параметры в префиксе URL/поддомене станут общими аргументами представления (с значениями по умолчанию) для всех функций представления в blueprint.
• Регистрация blueprint в приложении несколько раз с различными правилами URL.
• Предоставление фильтров шаблонов, статических файлов, шаблонов и других утилит через blueprints. Blueprint не обязательно должен реализовывать приложения или функции представления.
• Регистрация blueprint в приложении для любого из этих случаев при инициализации Flask-расширения.

Blueprint в Flask не является подключаемым приложением, так как фактически не является приложением — это набор операций, которые могут быть зарегистрированы в приложении, даже несколько раз. Почему не использовать несколько объектов приложения? Вы можете сделать это (см. Обработка приложений), но ваши приложения будут иметь отдельные конфигурации и будут управляться на уровне WSGI.

Blueprints вместо этого обеспечивают разделение на уровне Flask, совместно используют конфигурацию приложения и могут изменять объект приложения по мере необходимости при регистрации. Недостаток заключается в том, что вы не можете удалить blueprint после создания приложения без уничтожения всего объекта приложения.

Концепция Blueprints

Основная концепция blueprints заключается в том, что они записывают операции, которые должны быть выполнены при регистрации в приложении. Flask связывает функции представления с blueprints при обработке запросов и генерации URL от одного конечного пункта к другому.

Мой первый Blueprint

Вот как выглядит очень простой blueprint. В этом случае мы хотим реализовать blueprint, который просто отображает статические шаблоны:

from flask import Blueprint, render_template, abort
from jinja2 import TemplateNotFound

simple_page = Blueprint('simple_page', __name__,
                        template_folder='templates')

@simple_page.route('/', defaults={'page': 'index'})
@simple_page.route('/<page>')
def show(page):
    try:
        return render_template(f'pages/{page}.html')
    except TemplateNotFound:
        abort(404)

Когда вы связываете функцию с помощью декоратора @simple_page.route, blueprint будет записывать намерение зарегистрировать функцию show в приложении при её последующей регистрации. Кроме того, он будет добавлять префикс к точке входа функции с именем blueprint, которое было передано конструктору Blueprint (в данном случае также simple_page). Имя blueprint не изменяет URL, а только точку входа.

Регистрация Blueprints

Как вы регистрируете этот blueprint? Вот так:

from flask import Flask
from yourapplication.simple_page import simple_page

app = Flask(__name__)
app.register_blueprint(simple_page)

Если вы проверите зарегистрированные правила в приложении, вы найдете эти:

>>> app.url_map
Map([<Rule '/static/<filename>' (HEAD, OPTIONS, GET) -> static>,
 <Rule '/<page>' (HEAD, OPTIONS, GET) -> simple_page.show>,
 <Rule '/' (HEAD, OPTIONS, GET) -> simple_page.show>])

Первое, очевидно, из самого приложения для статических файлов. Остальные два — для функции show blueprint simple_page. Как вы можете видеть, они также имеют префикс с именем blueprint и разделены точкой (.).

Однако blueprints также могут быть смонтированы в разных местах:

app.register_blueprint(simple_page, url_prefix='/pages')

И, конечно же, вот сгенерированные правила:

>>> app.url_map
Map([<Rule '/static/<filename>' (HEAD, OPTIONS, GET) -> static>,
 <Rule '/pages/<page>' (HEAD, OPTIONS, GET) -> simple_page.show>,
 <Rule '/pages/' (HEAD, OPTIONS, GET) -> simple_page.show>])

Кроме того, вы можете регистрировать blueprints несколько раз, хотя не каждый blueprint может должным образом отреагировать на это. Фактически, это зависит от того, как реализован blueprint, может ли он быть смонтирован более одного раза.

Вложенные Blueprints

Возможна регистрация blueprint в другом blueprint.

parent = Blueprint('parent', __name__, url_prefix='/parent')
child = Blueprint('child', __name__, url_prefix='/child')
parent.register_blueprint(child)
app.register_blueprint(parent)

Дочерний blueprint получит имя родительского blueprint в качестве префикса к своему имени, а дочерние URL будут иметь префикс URL родительского blueprint.

url_for('parent.child.create')
/parent/child/create

Кроме того, дочерний blueprint получит поддомен родительского blueprint в качестве префикса, если он присутствует, т.е.

parent = Blueprint('parent', __name__, subdomain='parent')
child = Blueprint('child', __name__, subdomain='child')
parent.register_blueprint(child)
app.register_blueprint(parent)

url_for('parent.child.create', _external=True)
"child.parent.domain.tld"

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

Ресурсы Blueprint

Blueprints также могут предоставлять ресурсы. Иногда вы можете ввести blueprint только для ресурсов, которые он предоставляет.

>>> simple_page.root_path
'/Users/username/TestProject/yourapplication'

with simple_page.open_resource('static/style.css') as f:
    code = f.read()

admin = Blueprint('admin', __name__, static_folder='static')

url_for('admin.static', filename='style.css')

admin = Blueprint('admin', __name__, template_folder='templates')

yourpackage/
    blueprints/
        admin/
            templates/
                admin/
                    index.html
            __init__.py

Создание ссылок на URL

Если вам нужно создать ссылку на другую страницу, вы можете использовать функцию url_for() так же, как обычно, только с префиксом URL-точки входа именем blueprint и точкой (.):

url_for('admin.index')

Кроме того, если вы находитесь в функции представления blueprint или в рендерируемом шаблоне и хотите создать ссылку на другую точку входа того же blueprint, вы можете использовать относительные перенаправления, добавляя в начало точки входа только точку:

url_for('.index')

Это ссылается на admin.index , например, в случае, если текущий запрос был направлен на любую другую точку входа admin blueprint.

Обработчики ошибок Blueprint

Blueprints поддерживают декоратор errorhandler так же, как и объект приложения Flask, поэтому легко создать страницы ошибок, специфичные для Blueprint.

Вот пример для исключения «404 Страница не найдена»:

@simple_page.errorhandler(404)
def page_not_found(e):
    return render_template('pages/404.html')

Большинство обработчиков будут работать как ожидается; однако, есть оговорка, касающаяся обработчиков исключений 404 и 405. Эти обработчики вызываются только из соответствующего raise оператора или вызова abort в другой функции представления blueprint; они не вызываются, например, при доступе к недопустимому URL. Это происходит потому, что Blueprint не «владеет» определённым пространством URL, поэтому экземпляр приложения не может знать, какой обработчик ошибок Blueprint следует запустить при получении недопустимого URL. Если вы хотите выполнить разные стратегии обработки для этих ошибок на основе префиксов URL, они могут быть определены на уровне приложения с помощью объекта прокси request:

@app.errorhandler(404)
@app.errorhandler(405)
def _handle_api_error(ex):
    if request.path.startswith('/api/'):
        return jsonify(error=str(ex)), ex.code
    else:
        return ex

См. Обработка ошибок приложения.