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