Заводы приложений
Если вы уже используете пакеты и чертежи для своего приложения (Модульные приложения с чертежами), есть несколько действительно хороших способов улучшить опыт. Общим шаблоном является создание объекта приложения при импорте чертежа. Но если вы перенесете создание этого объекта в функцию, вы сможете создавать несколько экземпляров этого приложения позже.
Так зачем вам это нужно?
- Тестирование. Вы можете иметь экземпляры приложения с различными настройками, чтобы проверить каждый случай.
- Несколько экземпляров. Представьте, что вы хотите запустить разные версии одного и того же приложения. Конечно, вы можете иметь несколько экземпляров с различными конфигурациями, настроенными в вашем веб-сервере, но если вы используете фабрики, вы можете иметь несколько экземпляров одного и того же приложения, работающих в одном процессе приложения, что может быть удобно.
Так как же вы это на самом деле реализуете?
Базовые фабрики
Идея состоит в том, чтобы настроить приложение в функции. Вот так:
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 run --app hello run
Flask автоматически обнаружит фабрику, если она называется create_app или make_app в hello. Вы также можете передавать аргументы в фабрику, например:
$ flask run --app hello:create_app(local_auth=True)``
Тогда create_app фабрика в myapp вызывается с ключевым аргументом local_auth=True. См. Интерфейс командной строки для получения дополнительной информации.
Улучшения фабрики
Функция фабрики выше не очень умная, но вы можете ее улучшить. Следующие изменения легко реализовать:
- Сделать возможным передавать значения конфигурации для юнит-тестов, чтобы не создавать файлы конфигурации на файловой системе.
- Вызвать функцию из чертежа, когда приложение настраивается, чтобы у вас было место для изменения атрибутов приложения (например, подключать обработчики до/после запросов и т.д.).
- Добавить WSGI-прослойки при создании приложения, если необходимо.
© 2007–2022 Pallets
Licensed under the BSD 3-clause License.
https://flask.palletsprojects.com/en/2.2.x/patterns/appfactories/