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