python - Flask 应用程序的启动应该如何构建？

Question

我构建了一个 flask 应用程序，我从 if __name__ == '__main__': 开始 block ，正如我在教程中看到的那样。当需要让应用程序从 wsgi 启动以供生产使用时，我不得不删除 port和 host来自 app.run() 的选项，并更改我不太确定的启动代码的结构。我现在正在添加测试用例，这增加了更多启动和访问应用程序的方法( with app.test_client() 、 with app.test_request_context() ，谁知道还有什么。)构建创建和启动应用程序的代码的正确/推荐方法是什么，以便它在从 wsgi 独立启动并进行测试时表现正确(且一致)？

我目前的结构如下:

def create_app():
    """
    Create and initialize our app. Does not call its run() method
    """
    app = Flask(__name__)
    some_initialization(app, "config_file.json")

    return app

app = create_app()

...
# Services decorated with @app.route(...)
...

if __name__ == "__main__":
    # The options break wsgi, I had to use `run()`
    app.run(host="0.0.0.0", port=5555)

明确地说，我已经让 wsgi 和测试正常工作，所以这个问题不是关于如何做的；它是关于组织状态创建步骤的推荐方法，以便结果表现为一个模块，可以根据需要多次创建应用程序对象，可以设置端口和服务器等服务参数等。我的代码应该是什么大纲其实长什么样子？

除了启动标志问题之外，当前代码还创建了一个应用程序对象(一次)作为导入的副作用；我可以用 create_app() 创造更多但是from mycode import app将检索共享对象...我想知道所有那些装饰原始对象的装饰器。

我查看了文档，但示例被简化了，而且完整的文档提供了太多替代方案，以至于我无法弄清楚 Flask 的创建者所设想的代码结构。我希望这是一个简单的并且它必须有一个得到良好支持的代码模式；那是什么？

Answer 1

Disclaimer While this isn't the only struture for Flask, this has best suited my needs and is inspired from the Flask officials docs ofusing a FactoryPattern

项目结构遵循 Documentation 的结构

/home/user/Projects/flask-tutorial
├── flaskr/
│   ├── __init__.py
│   ├── db.py
│   ├── schema.sql
│   ├── auth.py
│   ├── blog.py
│   ├── templates/
│   │   ├── base.html
│   │   ├── auth/
│   │   │   ├── login.html
│   │   │   └── register.html
│   │   └── blog/
│   │       ├── create.html
│   │       ├── index.html
│   │       └── update.html
│   └── static/
│       └── style.css
├── tests/
│   ├── conftest.py
│   ├── data.sql
│   ├── test_factory.py
│   ├── test_db.py
│   ├── test_auth.py
│   └── test_blog.py
├── venv/
├── setup.py
└── MANIFEST.in

flaskr/, a Python package containing your application code and files.

flaskr 将包含工厂以生成可供 WGSI 服务器使用的 flask 应用程序实例，并将与测试、orms(用于迁移)等一起工作。

flaskr/__init__.py 包含工厂方法

工厂该工厂旨在配置和创建 Flask 应用程序。这意味着您需要在 one of the many ways 中传递所有必需的配置被 Flask 接受

开发 Flask 服务器期望函数 create_app() 出现在包 __init__.py 文件中。但是当使用像 docs 中列出的那些生产服务器时您可以传递要调用的函数的名称。

来自 documentation 的示例:

# flaskr/__init__.py
import os

from flask import Flask


def create_app(test_config=None):
    # create and configure the app
    app = Flask(__name__, instance_relative_config=True)
    app.config.from_mapping(
        SECRET_KEY='dev',
        DATABASE=os.path.join(app.instance_path, 'flaskr.sqlite'),
    )

    if test_config is None:
        # load the instance config, if it exists, when not testing
        app.config.from_pyfile('config.py', silent=True)
    else:
        # load the test config if passed in
        app.config.from_mapping(test_config)

    # ensure the instance folder exists
    try:
        os.makedirs(app.instance_path)
    except OSError:
        pass

    # a simple page that says hello
    @app.route('/hello')
    def hello():
        return 'Hello, World!'

    return app

在运行 dev flask 服务器时，按照描述设置环境变量

$ export FLASK_APP=flaskr
$ export FLASK_ENV=development
$ flask run

路线Flask 应用程序可能有多个模块需要 App 对象才能运行，如您在评论中提到的 @app.route 。为了优雅地处理这个问题，我们可以使用 Blueprints .这允许我们将路由保存在不同的文件中并在 create_app()

中注册它们

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)

我们可以修改create_app()来注册蓝图，如下所示:

def create_app(test_config=None):
    app = Flask(__name__, instance_relative_config=True)
    # configure the app
    .
    .
    .
    from yourapplication.simple_page import simple_page
    app.register_blueprint(simple_page)
    return app

您需要在本地导入蓝图以避免循环导入。但是当有很多蓝图时，这并不优雅。因此，我们可以在蓝图包中创建一个 init_blueprints(app) 函数，例如

# flaskr/blueprints/__init__.py
from flaskr.blueprints.simple_page import simple_page
def init_blueprints(app):
    with app.app_context():
        app.register_blueprint(simple_page)

并将create_app()修改为

from flaskr.blueprints import init_blueprints
def create_app(test_config=None):
    app = Flask(__name__, instance_relative_config=True)
    # configure the app
    .
    .
    .
    init_blueprints(app)
    return app

这样您的工厂就不会被蓝图弄得乱七八糟。您可以根据自己的选择在蓝图包内处理蓝图的注册。这也避免了循环导入。

其他扩展大多数常见的 Flask 扩展都支持工厂模式，允许您创建扩展的对象，然后调用 obj.init_app(app) 以使用 Flask App 对其进行初始化。这里以 Marshmallow 为例，但它适用于所有人。如此修改 create_app() -

ma = Marshmallow()

def create_app(test_config=None):
    app = Flask(__name__, instance_relative_config=True)
    # configure the app
    .
    .
    .
    init_blueprints(app)
    ma.init_app(app)
    return app

您现在可以从 flaskr 导入 ma 所需的文件。

生产服务器正如最初提到的，生产 WSGI serevrs 将调用 create_app() 来创建 Flask 实例。使用 gunicorn作为示例，但可以使用所有支持的 WSGI 服务器。

$ gunicorn "flaskr:create_app()"

您可以按照 gunicorn docs 传递配置，同样可以在脚本中实现。