Заводские фабрики приложений

Если вы уже используете пакеты и чертежи для своего приложения (Модульные приложения с чертежами), есть несколько отличных способов улучшить опыт. Общим шаблоном является создание объекта приложения при импорте чертежа. Но если вы переместите создание этого объекта в функцию, вы сможете создавать несколько экземпляров этого приложения позже.

Так зачем вам это нужно?

Тестирование. Вы можете иметь экземпляры приложения с различными настройками для проверки каждого случая.
Несколько экземпляров. Представьте, что вы хотите запустить различные версии одного и того же приложения. Конечно, вы можете иметь несколько экземпляров с различными конфигурациями, настроенными в вашем веб-сервере, но если вы используете фабрики, вы можете иметь несколько экземпляров одного и того же приложения, работающего в одном процессе приложения, что может быть полезно.

Итак, как вы это реализуете?

Базовые фабрики

Идея заключается в настройке приложения в функции. Вот так:

def create_app(config_filename):
    app = Flask(__name__)
    app.config.from_pyfile(config_filename)

    from yourapplication.model import db
    db.init_app(app)

    from yourapplication.views.admin import admin
    from yourapplication.views.frontend import frontend
    app.register_blueprint(admin)
    app.register_blueprint(frontend)

    return app

Недостатком является то, что вы не можете использовать объект приложения в чертежах во время импорта. Однако вы можете использовать его внутри запроса. Как получить доступ к приложению с конфигурацией? Используйте current_app:

from flask import current_app, Blueprint, render_template
admin = Blueprint('admin', __name__, url_prefix='/admin')

@admin.route('/')
def index():
    return render_template(current_app.config['INDEX_TEMPLATE'])

Здесь мы ищем имя шаблона в конфигурации.

Фабрики и расширения

Желательно создавать ваши расширения и фабрики приложений таким образом, чтобы объект расширения изначально не был привязан к приложению.

Используя Flask-SQLAlchemy, например, вы не должны делать ничего подобного:

def create_app(config_filename):
    app = Flask(__name__)
    app.config.from_pyfile(config_filename)

    db = SQLAlchemy(app)

Но, скорее, в model.py (или эквиваленте):

db = SQLAlchemy()

и в вашем application.py (или эквиваленте):

def create_app(config_filename):
    app = Flask(__name__)
    app.config.from_pyfile(config_filename)

    from yourapplication.model import db
    db.init_app(app)

Используя этот шаблон проектирования, никакие специфические для приложения состояния не хранятся в объекте расширения, поэтому один объект расширения может быть использован для нескольких приложений. Для получения дополнительной информации о проектировании расширений см. Разработка расширений Flask.

Использование приложений

Чтобы запустить такое приложение, вы можете использовать команду flask:

$ flask --app hello run

Flask автоматически обнаружит фабрику, если она называется create_app или make_app в hello. Вы также можете передать аргументы в фабрику, как это:

$ flask --app hello:create_app(local_auth=True) run

Затем фабрика create_app в myapp вызывается со ключевым аргументом local_auth=True. Подробнее см. Интерфейс командной строки.

Улучшения фабрики

Функция фабрики выше не очень умная, но вы можете ее улучшить. Следующие изменения легко реализовать:

Сделать возможным передачу значений конфигурации для модульных тестов, чтобы вам не приходилось создавать файлы конфигурации на файловой системе.
Вызвать функцию из чертежа при настройке приложения, чтобы у вас было место для изменения атрибутов приложения (например, подключение обработчиков запросов до/после).
Добавить WSGI-средние, если необходимо, при создании приложения.

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