19

我正在使用 Flask 的内置开发服务器开发 Flask 应用程序。我使用 Flask-Script 启动它。我想切换到使用 Gunicorn 作为 Web 服务器。为此，我是否需要在 Flask-Script 和 Gunicorn 之间编写某种集成代码？或者 Flask-Script 与使用 Gunicorn 运行应用程序无关？

提前致谢！

给@sean-lynch 的道具。以下是根据他的回答工作的、经过测试的代码。我所做的更改是：

  • sys.argv在remove_non_gunicorn_command_line_args()尝试启动服务器之前，将删除 Gunicorn 无法识别的选项。否则 Gunicorn 会抛出错误，并显示如下消息：error: unrecognized arguments: --port 5010. 我删除-p是因为，即使它不会导致错误，那只是因为 Gunicorn 认为它是其pidfile选项的简短形式，这显然不是预期的。

  • 修改 GunicornServer.handle() 签名以匹配它覆盖的方法，即 Command.handle()

-

from flask_script import Command
from gunicorn.app.base import Application

class GunicornServer(Command):

    description = 'Run the app within Gunicorn'

    def __init__(self, host='127.0.0.1', port=8000, workers=6):

        self.port = port
        self.host = host
        self.workers = workers

    def get_options(self):
        return (
            Option('-t', '--host',
                   dest='host',
                   default=self.host),

            Option('-p', '--port',
                   dest='port',
                   type=int,
                   default=self.port),

            Option('-w', '--workers',
                   dest='workers',
                   type=int,
                   default=self.workers),
        )

    def handle(self, app, *args, **kwargs):

        host = kwargs['host']
        port = kwargs['port']
        workers = kwargs['workers']

        def remove_non_gunicorn_command_line_args():
            import sys
            args_to_remove = ['--port','-p']
            def args_filter(name_or_value):
                keep = not args_to_remove.count(name_or_value)
                if keep:
                    previous = sys.argv[sys.argv.index(name_or_value) - 1]
                    keep = not args_to_remove.count(previous)
                return keep
            sys.argv = filter(args_filter, sys.argv)

        remove_non_gunicorn_command_line_args()

        from gunicorn import version_info
        if version_info < (0, 9, 0):
            from gunicorn.arbiter import Arbiter
            from gunicorn.config import Config
            arbiter = Arbiter(Config({'bind': "%s:%d" % (host, int(port)),'workers': workers}), app)
            arbiter.run()
        else:
            class FlaskApplication(Application):
                def init(self, parser, opts, args):
                    return {
                        'bind': '{0}:{1}'.format(host, port),
                        'workers': workers
                    }

                def load(self):
                    return app

            FlaskApplication().run()

manager.add_command('gunicorn', GunicornServer())
4

7 回答 7

15

正如 Dhaivat 所说，您可以直接将 Flask 应用程序与 Gunicorn 一起使用。

如果您仍想使用 Flask-Script，则需要创建一个自定义的Command. 我对 Gunicorn 没有任何经验，但我为 Flask-Actions 找到了类似的解决方案，并将其移植到 Flask-Script，尽管请注意，它未经测试。

from flask_script import Command, Option

class GunicornServer(Command):

    description = 'Run the app within Gunicorn'

    def __init__(self, host='127.0.0.1', port=8000, workers=4):
        self.port = port
        self.host = host
        self.workers = workers

    def get_options(self):
        return (
            Option('-H', '--host',
                   dest='host',
                   default=self.host),

            Option('-p', '--port',
                   dest='port',
                   type=int,
                   default=self.port),

            Option('-w', '--workers',
                   dest='workers',
                   type=int,
                   default=self.workers),
        )

    def handle(self, app, host, port, workers):

        from gunicorn import version_info

        if version_info < (0, 9, 0):
            from gunicorn.arbiter import Arbiter
            from gunicorn.config import Config
            arbiter = Arbiter(Config({'bind': "%s:%d" % (host, int(port)),'workers': workers}), app)
            arbiter.run()
        else:
            from gunicorn.app.base import Application

            class FlaskApplication(Application):
                def init(self, parser, opts, args):
                    return {
                        'bind': '{0}:{1}'.format(host, port),
                        'workers': workers 
                    }

                def load(self):
                    return app

            FlaskApplication().run()

然后，您可以在以下位置注册它以替换 Flask 的本地开发服务器python manage.py runserver 

manager.add_command("runserver", GunicornServer())

或注册为新命令，例如python manage.py gunicorn

manager.add_command("gunicorn", GunicornServer())

2016 年 6 月编辑：使用最新版本的 Flask-Script，将方法更改handle为__call__. 旧烧瓶脚本与新烧瓶脚本

于 2013-01-28T19:43:45.393 回答
9

我基于 Sean Lynch 编写了一个更好的 GunicornServer 版本，该命令现在接受所有 gunicorn 的参数

from yourapp import app
from flask.ext.script import Manager, Command, Option

class GunicornServer(Command):
    """Run the app within Gunicorn"""

    def get_options(self):
        from gunicorn.config import make_settings

        settings = make_settings()
        options = (
            Option(*klass.cli, action=klass.action)
            for setting, klass in settings.iteritems() if klass.cli
        )
        return options

    def run(self, *args, **kwargs):
        from gunicorn.app.wsgiapp import WSGIApplication

        app = WSGIApplication()
        app.app_uri = 'manage:app'
        return app.run()

manager = Manager(app)
manager.add_command("gunicorn", GunicornServer())
于 2014-07-07T09:05:05.907 回答
4

根据肖恩的回答，我还写了一个更适合我的版本。

@manager.option('-h', '--host', dest='host', default='127.0.0.1')
@manager.option('-p', '--port', dest='port', type=int, default=6969)
@manager.option('-w', '--workers', dest='workers', type=int, default=3)
def gunicorn(host, port, workers):
    """Start the Server with Gunicorn"""
    from gunicorn.app.base import Application

    class FlaskApplication(Application):
        def init(self, parser, opts, args):
            return {
                'bind': '{0}:{1}'.format(host, port),
                'workers': workers
            }

        def load(self):
            return app

    application = FlaskApplication()
    return application.run()

你可以使用这样的命令运行 gunicornpython manager.py gunicorn

于 2015-02-02T08:07:51.353 回答
2

Flask 实际上有文档可以在这里运行 Gunicorn 。

你必须记住 Gunicorn 是一个有一些细节的 WSGI 服务器。

于 2013-01-28T17:55:54.123 回答
1

感谢@menghan 的解决方案和@OutOfFoodException 改进。但请记住 forgunicorn=20.0.4使用-b, --bind option绑定服务器套接字。结果命令对我来说是这样的：

python3 manage.py gunicorn -b 0.0.0.0:5000

from yourapp import app
from flask.ext.script import Manager, Command, Option

class GunicornServer(Command):
    """Run the app within Gunicorn"""

    def get_options(self):
        from gunicorn.config import make_settings

        settings = make_settings()
        options = (
            Option(*klass.cli, action=klass.action)
            for setting, klass in settings.iteritems() if klass.cli
        )
        return options

    def run(self, *args, **kwargs):
        from gunicorn.app.wsgiapp import WSGIApplication

        app = WSGIApplication()
        app.app_uri = 'manage:app'
        return app.run()

manager = Manager(app)
manager.add_command("gunicorn", GunicornServer())
于 2020-07-17T17:29:21.137 回答
0

根据 menghan 的回答，接收来自 Application config 的所有参数。

from flask_script import Command, Option


class GunicornApp(Command):

    def get_options(self):
        from gunicorn.config import make_settings

        settings = make_settings()
        options = (
            Option(*klass.cli, dest=klass.name, default=klass.default)
            for setting, klass in settings.items() if klass.cli
        )
        return options

    def __call__(self, app=None, *args, **kwargs):

        from gunicorn.app.base import Application
        class FlaskApplication(Application):
            def init(self, parser, opts, args):
                return kwargs

            def load(self):
                return app

        FlaskApplication().run()
于 2017-07-31T18:07:21.837 回答
0

我将进一步详细说明@NinjaDQ 的答案。如果要同时使用app_uri属性来定义例如烧瓶应用程序配置文件和自定义命令行参数，则需要使用WSGIApplication. 问题是这个应用程序overrides的命令行参数因此有必要忽略sys.argv.

        from gunicorn.app.base import Application

        class FlaskApplication(Application):
            def init(self, parser, opts, args):
                return {
                    "bind": "{0}:{1}".format(host, port),
                    "workers": 4
                }

            def chdir(self):
                # chdir to the configured path before loading,
                # default is the current dir
                os.chdir(self.cfg.chdir)

                # add the path to sys.path
                sys.path.insert(0, self.cfg.chdir)

            def load_wsgiapp(self):
                self.chdir()

                # load the app
                return util.import_app(self.app_uri)

            def load(self):
                return self.load_wsgiapp()

        # Important! Do not pass any cmd line arguments to gunicorn
        sys.argv = sys.argv[:2]

        wsgi_app = FlaskApplication()
        wsgi_app.app_uri = "manage:create_app('{0}')".format(config_file)

        return wsgi_app.run()
于 2017-06-23T06:29:26.780 回答