Модульные приложения с чертежами¶

Почему именно чертежи?¶

Черновики во Flask предназначены именно для таких случаев:

• Преобразование приложения в набор чертежей. Это идеально подходит для больших приложений; проект может инстанцировать объект приложения, инициализировать несколько расширений и зарегистрировать коллекцию чертежей.

• Зарегистрируйте чертеж в приложении по префиксу URL и/или поддомену. Параметры в префиксе URL/поддомене становятся общими аргументами представления (с значениями по умолчанию) для всех функций представления в чертеже.

• Регистрация чертежа несколько раз в приложении с различными правилами URL.

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

• Зарегистрируйте чертеж на приложении для любого из этих случаев при инициализации расширения Flask.

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

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

Концепция чертежей¶

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

Мой первый чертеж¶

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

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, блюпринт запишет намерение зарегистрировать функцию show на приложении, когда оно будет зарегистрировано позже. Дополнительно он префикснет конечную точку функции именем чертежа, которое было передано конструктору Blueprint (в данном случае также simple_page). Имя blueprint’а не изменяет URL, только конечную точку.

Регистрация чертежей¶

Как же зарегистрировать этот чертеж? Вот так:

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 чертежа simple_page. Как вы можете видеть, они также имеют префикс с именем чертежа и разделены точкой (.).

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

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>])

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

Чертежи для раскроя¶

Можно зарегистрировать чертеж на другом чертеже.

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

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

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

Функции, специфичные для 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 указывается имя чертежа и точка (.):

url_for('admin.index')

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

url_for('.index')

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

Обработчики ошибок чертежей¶

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

Вот пример исключения «404 Page Not Found»:

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

Большинство обработчиков ошибок будут работать, как и ожидалось; однако есть оговорка относительно обработчиков исключений 404 и 405. Эти обработчики ошибок вызываются только из соответствующего оператора raise или вызова abort в другой функции представления блюпринта; они не вызываются, например, при неправильном доступе к URL. Это происходит потому, что блюпринт не «владеет» определенным пространством URL, поэтому у экземпляра приложения нет возможности узнать, какой обработчик ошибок блюпринта он должен запустить, если ему будет предоставлен неверный 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

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