14

关于应用程序可调用对象、WSGI 服务器和 Flask 循环导入的问题

我(可能)很困惑。我想从 app-factories 安全地创建 Flask / WSGI 应用程序,并且仍然能够轻松地在 WSGI 服务器中使用它们。

tl;博士

  1. 我可以安全地避免在导入init时创建应用程序(如推荐的那样),而是稍后创建它(即使用工厂方法)

  2. 如何使该应用程序与 WSGI 服务器一起工作?尤其是当我传入配置和其他设置而不是从 ENV 中提取它们时

例如::

def make_app(configdict, appname):
    app = Flask(appname)
    app.config.update(configdict)
    init_db(configdict)
    set_app_in_global_namespace(app)

    #importing now will allow from pkg import app        
    from mypackage import views

    return app

我想使用上面的“工厂”,因为我想轻松地控制配置以进行测试等。

然后我大概想创建一个 wsgi.py 模块,将应用程序提供给 WSGI 服务器。

所以最终事情看起来有点像这样

初始化.py::

app = None

def make_app(configdict, appname):
    flaskapp = Flask(appname)
    flaskapp.config.update(configdict)
    init_db(configdict)

    global app
    app = flaskapp    

    #importing now will allow from pkg import app        
    from mypackage import views

    return flaskapp

wsgi.py::

from mypackage import app

app = make_app(configfromsomewhere, "myname")

uWSGI::

uwsgi --module=mypackage.wsgi:app

但是 wsgi.py 仍然不是我可以调用的东西,例如 wsgi.py --settings=x --host=10.0.0.1 所以我真的不知道如何将配置传递给 .

我问是因为虽然这看起来......好吧......它也有点乱。

当一切都在 ENV 中时,生活会更轻松。

不仅如此,而且:

那么使用 app-factory 有什么不安全的地方

给出的建议here <http://flask.pocoo.org/docs/patterns/packages>是::

1. the Flask application object creation has to be in the
__init__.py file. That way each module can import it safely and
the __name__ variable will resolve to the correct package.

2. all the view functions (the ones with a route() decorator on
  top) have to be imported in the __init__.py file. Not the object
  itself, but the module it is in. Import the view module after
  the application object is created.

回复:2. 显然,路由装饰器期望实例化应用程序具有某些能力,没有它们就无法运行。没关系。

回复:1.,好的,我们需要正确的名称。但是什么是不安全的?为什么?如果未初始化,导入和使用应用程序是否不安全?好吧,它会坏掉,但那不是不安全的。它是大肆吹嘘的线程本地吗?可能。但是,如果我不顾一切地从随机模块中提取应用程序实例,我应该会遇到麻烦。

含义——我们不从视图以外的任何地方引用应用程序对象——本质上我们保持我们的模块化良好和紧凑,并传递字典、错误对象甚至 WebObs。

http://flask.pocoo.org/docs/patterns/appdispatch http://flask.pocoo.org/docs/deploying/#deployment http://flask.pocoo.org/docs/patterns/packages/#larger-应用程序 http://flask.pocoo.org/docs/becomingbig

4

1 回答 1

28

根据Flask Documentation,应用程序工厂很好,因为:

  1. 测试。您可以使用具有不同设置的应用程序实例来测试每种情况。

  2. 多个实例。想象一下,您想运行同一应用程序的不同版本。当然,您可以在您的网络服务器中设置多个具有不同配置的实例,但是如果您使用工厂,则可以在同一个应用程序进程中运行同一应用程序的多个实例,这很方便。

但是,正如文档的其他测试技巧部分所述,如果您使用应用程序工厂before_request()after_request()则不会自动调用这些函数。

在接下来的段落中,我将展示如何将应用程序工厂模式与 uWSGI 应用程序服务器和 nginx 一起使用(我只使用过这些,但我可以尝试帮助您使用另一台服务器对其进行配置)。

应用工厂

因此,假设您的应用程序位于文件夹yourapplication中,其中包含__init__.py文件:

import os
from flask import Flask

def create_app(cfg=None):
    app = Flask(__name__)

    load_config(app, cfg)

    # import all route modules
    # and register blueprints

    return app

def load_config(app, cfg):
    # Load a default configuration file
    app.config.from_pyfile('config/default.cfg')

    # If cfg is empty try to load config file from environment variable
    if cfg is None and 'YOURAPPLICATION_CFG' in os.environ:
        cfg = os.environ['YOURAPPLICATION_CFG']

    if cfg is not None:
        app.config.from_pyfile(cfg)

现在您需要一个文件来创建应用程序的实例:

from yourapplication import create_app

app = create_app()

if __name__ == "__main__":
    app.run()

在上面的代码中,我假设有一个环境变量设置了配置文件的路径,但是您可以将配置路径提供给工厂,如下所示:

app = create_app('config/prod.cfg')

或者,您可以使用带有环境和相应配置文件的字典之类的东西:

CONFIG_FILES = {'development': 'config/development.cfg',
                'test'       : 'config/test.cfg',
                'production' : 'config/production.cfg' }

在这种情况下,load_config函数将如下所示:

def load_config(app, env):
    app.config.from_pyfile('config/default.cfg')

    var = "YOURAPPLICATION_ENV"
    if env is None and var in os.environ:
        env = os.environ[var]

    if env in CONFIG_FILES:
        app.config.from_pyfile(CONFIG_FILES[env])

Nginx 和 uWSGI

以下是 nginx 的配置文件示例:

server {
    listen             80;
    server_name        yourapplication.com;
    access_log         /var/www/yourapplication/logs/access.log;
    error_log          /var/www/yourapplication/logs/error.log;

    location / {
        try_files $uri @flask;
    }

    location @flask {
        include        uwsgi_params;
        uwsgi_pass     unix:/tmp/yourapplication.sock;

        # /env is the virtualenv directory
        uwsgi_param    UWSGI_PYHOME                /var/www/yourapplication/env;

        # the path where the module run is located
        uwsgi_param    UWSGI_CHDIR                 /var/www/yourapplication;

        # the name of the module to be called
        uwsgi_param    UWSGI_MODULE                run;

        # the variable declared in the run module, an instance of Flask
        uwsgi_param    UWSGI_CALLABLE              app;
    }
}

uWSGI 配置文件如下所示:

[uwsgi]
plugins=python
vhost=true
socket=/tmp/yourapplication.sock
env = YOURAPPLICATION_ENV=production
logto = /var/www/yourapplication/logs/uwsgi.log

如何使用before_request()after_request()

这些函数的问题在于,如果您在其他模块中调用它们,则在应用程序实例化之前无法导入这些模块。同样,文档对此有话要说:

缺点是您不能在导入时使用蓝图中的应用程序对象。但是,您可以在请求中使用它。您如何使用配置访问应用程序?使用 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'])

或者你可以考虑创建一个 extension,然后你可以在没有任何 Flask 实例的情况下导入类,因为类扩展只会在创建后使用 Flask 实例。

于 2012-12-06T23:16:59.903 回答