命令行接口

在虚拟环境中安装 Flask 时会同时安装 flask 脚本,这是一个 Click 命令 行接口。在终端中执行该脚本可以操作内建的、扩展的和应用定义的命令。关于命令 的更多信息和选择可以通过使用 --help 参数查看。

探索应用

flask 命令由 Flask 安装,而不是你的应用。为了可以使用,它必须被告知可 以在哪里找到你的应用。 FLASK_APP 环境变量用于定义如何载入应用。

Unix Bash ( Linux 、Mac 及其他):

$ export FLASK_APP=hello
$ flask run

Windows CMD:

> set FLASK_APP=hello
> flask run

Windows PowerShell:

> $env:FLASK_APP = "hello"
> flask run

虽然 FLASK_APP 支持多种选项来定义应用,但多数情况下应该很简单。以下是 典型值:

(空)
wsgi.py 文件被导入,自动探测应用( app )。这提供了一种简 单的方法来从工厂创建具有额外参数的应用。
FLASK_APP=hello
名称被导入,自动探测一个应用( app )或者工厂( create_app )。

FLASK_APP 分三个部分:一是一个可选路径,用于设置当前工作文件夹;二是一 个 Python 文件或者带点的导入路径;三是一个可选的实例或工厂的变量名称。如果 名称是工厂,则可以选择在后面的括号中加上参数。以下演示说明:

FLASK_APP=src/hello
设置当前工作文件夹为 src 然后导入 hello
FLASK_APP=hello.web
导入路径 hello.web
FLASK_APP=hello:app2
使用 hello 中的 app2 Flask 实例。
FLASK_APP="hello:create_app('dev')"
调用 hello 中的 create_app 工厂,把 'dev' 作为参数。

如果没有设置 FLASK_APP ,命令会查找 wsgi.py 文件或者 app.py 文件并尝试探测一个应用实例或者工厂。

根据给定的导入,命令会寻找一个名为 app 或者 application 的应用实例。 如果找不到会继续寻找任意应用实例。如果找不到任何实例,会接着寻找名为 create_app 或者 make_app 的函数,使用该函数返回的实例。

当调用一个应用工厂时,如果工厂接收一个名为 info 的参数,那么 class:~cli.ScriptInfo 实例会被作为一个关键字参数传递。如果括号紧随着工厂 名称,那么其中的内容会被视作为 Python 语言内容,并用作函数的参数。这意味着 字符串必须使用双引号包围。

运行开发服务器

run 命令可以启动开发服务器,它在大多数情况下替代 Flask.run() 方法。:

$ flask run
 * Serving Flask app "hello"
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

Warning

不要在生产中使用此命令运行应用,只能在开发过程中使用开发服务 器。开发服务器只是为了提供方便,但是不够安全、稳定和高效。有关如何在生 产中运行服务器,请参阅 部署方式

打开一个 Shell

为了探索应用中的数据,可以 shell 命令开启一个 交互 Python shell 。这样,一个应用情境被激活,应用实例会被导入。:

$ flask shell
Python 3.6.2 (default, Jul 20 2017, 03:52:27)
[GCC 7.1.1 20170630] on linux
App: example
Instance: /home/user/Projects/hello/instance
>>>

使用 shell_context_processor() 添加其他自动导入。

环境

Changelog

New in version 1.0.

Flask 应用所运行的环境由 FLASK_ENV 环境变更指定。如果配置该变量, 那么缺省为 production 。另一个可用的环境值是 development 。 Flask 和扩展可能基于环境不同而改变行为。

如果环境是 developmentflask 命令会开启调试模式并且 flask run 会开启交互调试器和重启器。

$ FLASK_ENV=development flask run
 * Serving Flask app "hello"
 * Environment: development
 * Debug mode: on
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with inotify reloader
 * Debugger is active!
 * Debugger PIN: 223-456-919

调试模式

如前文所述,当 FLASK_ENVdevelopment 时会开启调试模式。 如果想要单独控制调试模式,要使用 FLASK_DEBUG 。值为 1 表示开启, 0 表示关闭。

通过 dotenv 设置环境变量

与其每次打开新的终端都要设置 FLASK_APP ,不如使用 Flask 的 dotenv 支持 功能自动设置环境变量。

如果 python-dotenv 已安装,那么运行 flask 会根据 .env.flaskenv 中配置来设置环境变量。这样可以在每次打开 终端后,避免手动设置 FLASK_APP 和其他类似使用环境变量进行配置的服务部署 工作。

命令行设置的变量会重载 .env 中的变量, .env 中的变量会重载 .flaskenv 中的变量。 .flaskenv 应当用于公共变量,如 FLASK_APP.env 则应用用于私有变量,并且不提交到储存库。

为了找到定位文件,将会从运行 flask 的文件夹向上扫描文件夹。 当前工作目录将被设置为文件的位置,假定这是最高级别的项目文件夹。

这些文件只能由``flask``命令或调用 run() 加载。如果想在生产运 行时加载这些文件,你应该手动调用 load_dotenv()

设置命令参数

Click 被配置为根据环境变量为命令选项载入缺省值。变量使用 FLASK_COMMAND_OPTION 模式。例如,要为运行命令设置端口,不使用 flask run --port 8000 ,而是使用:

export FLASK_RUN_PORT=8000
flask run
 * Running on http://127.0.0.1:8000/

这些可以添加到 .flaskenv 文件,就像 FLASK_APP 来控制缺省命令选项。

禁用 dotenv

如果检测到 dotenv 文件,但是没有安装 python-dotenv ,那么 flask 命令会 显示一个消息。

flask run
 * Tip: There are .env files present. Do "pip install python-dotenv" to use them.

通过设置 FLASK_SKIP_DOTENV 可以告诉 Flask 不要载入 dotenv 文件。在 python-dotenv 没有安装到情况下这个设置也是有效的。这个设置主要用于以下情形:当 你想要手动载入它们的时候,或者当你已经使用了一个项目运行器载入了它们。请牢记,环境 变量必须在项目载入之前设置,否则出问题。

export FLASK_SKIP_DOTENV=1
flask run

通过 virturalenv 设置环境变量

如果不想安装 dotenv 支持,可以通过把它们添加到 virtualenv 的 activate 文件末尾来设置环境变量。激活 virtualenv 时会设置环境变量。

Unix Bash , venv/bin/activate:

export FLASK_APP=hello

Windows CMD , venv\Scripts\activate.bat:

set FLASK_APP=hello

建议使用 dotenv 支持来做,因为 .flaskenv 可以被提交到储存库,当提 取项目代码后就可以自动发挥作用。

自定义命令

flask 命令使用 Click 来实现。如何编写命令的完整信息参见该项目的文档。

以下示例添加了 create_user 命令,带有 name 参数。

import click
from flask import Flask

app = Flask(__name__)

@app.cli.command()
@click.argument('name')
def create_user(name):
    ...
flask create_user admin

以下示例也添加了同样功能的命令,但是以命令组的方式添加的,名为 user create 。这样做有助于组织一组相关的命令。

import click
from flask import Flask
from flask.cli import AppGroup

app = Flask(__name__)
user_cli = AppGroup('user')

@user_cli.command('create')
@click.argument('name')
def create_user(name):
    ...

app.cli.add_command(user_cli)
flask user create demo

关于如何测试自定义命令的概览,参见 测试 CLI 命令

应用情境

使用 Flask 应用的 cli command() 装饰器添加的命令会在执行 时压入应用情境,这样命令和扩展就可以访问应用和应用的配置。如果使用 Click 的 command() 装饰器创建命令,而不是 Flask 的装饰器,那 么可以使用 with_appcontext() ,达到同样的效果。

import click
from flask.cli import with_appcontext

@click.command
@with_appcontext
def do_work():
    ...

app.cli.add_command(do_work)

如果确定命令不需要情境,那么可以禁用它:

@app.cli.command(with_appcontext=False)
def do_work():
    ...

插件

Flask 会自动载入在 flask.commands entry point 定义的命令。这样有助 于扩展在安装时添加命令。入口点在 setup.py 中定义:

from setuptools import setup

setup(
    name='flask-my-extension',
    ...,
    entry_points={
        'flask.commands': [
            'my-command=flask_my_extension.commands:cli'
        ],
    },
)

flask_my_extension/commands.py 内可以导出一个 Click 对象:

import click

@click.command()
def cli():
    ...

一旦该软件包与 Flask 项目安装在相同的 virtualenv 中,你可以运行 flask my-command 来调用该命令。

自定义脚本

当使用应用工厂方案时,自定义 Click 脚本会更方便。这样可以创建自己的 Click 对象并导出它作为一个 console script 入口点,而不是使用 FLASK_APP 并让 Flask 裁入应用。

创建一个 FlaskGroup 的实例并传递给工厂:

import click
from flask import Flask
from flask.cli import FlaskGroup

def create_app():
    app = Flask('wiki')
    # other setup
    return app

@click.group(cls=FlaskGroup, create_app=create_app)
def cli():
    """Management script for the Wiki application."""

setup.py 中定义入口点:

from setuptools import setup

setup(
    name='flask-my-extension',
    ...,
    entry_points={
        'console_scripts': [
            'wiki=wiki:cli'
        ],
    },
)

在 virtualenv 中以可编辑模式安装应用,自定义脚本可用。注意,不需要设置 FLASK_APP

$ pip install -e .
$ wiki run

自定义脚本错误

当使用自定义脚本时,如果模块级别代码出错,重载器会失效,因为它无法 再载入入口点。

一般建议使用 flask 命令,因为该命令与你的代码是分离的,不会出现 这种问题。

PyCharm 集成

在 PyCharm 2018.1 版本之前, Flask CLI 功能尚未能完全整合进 PyCharm ,因此 我们必需做些调整才能顺利使用。这些说明同样也适用于其他 IDE 。

在 PyCharm 中,打开你的项目,在菜单中点击 Run 后点击 Edit Configurations 。你会看到类似如下窗口:

screenshot of pycharm's run configuration settings

有许多选项要改变,但一旦做好了一条命令,其他命令只要复制整个配置调整一下就 行了。包括你想自定义的其他命令也同样如此。

点击 + ( Add New Configuration )按钮选择 Python 。为配置取一个具有良 好描述性的名称,例如“ Run Flask Server ”(运行 Flask 服务器)。 为 flask run 命令选择“ Single instance only ”,因为不能同时运行多个 服务器。

从( A )下拉框中选择 Module name ,然后输入 flask

Parameters 字段( B )用于设置 CLI 命令(可以带参数)。本例中我们使 用 run ,它可用于运行开发服务器。

如果使用 通过 dotenv 设置环境变量 可以跳过这一步。为了标识我们的应用,需要添加一个环 境变量( C )。点击展开按钮,并在左边添加一个 FLASK_APP 条目, Python 要导入的库或者文件放在右边(本例使用 hello )。

下一步我们需要把应用所在的文件夹设置为工作文件夹( D )。

如果你是在 virtualenv 中把项目作为一个包安装的,那么可以取消选择 PYTHONPATH 选项( E ),这样会与以后部署应用更匹配。

点击 Apply 保存配置,或者点击 OK 保存并关闭窗口。在 PyCharm 主窗口中选 择该配置并点击旁边的运行按钮开始运行服务器。

现在我们已经在 PyCharm 中有了一个运行 flask run 的配置,复制这个配置并 改变 Script 参数,就可以运行一个不同的 CLI 命令,比如 flask shell