命令行接口

命令行接口

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

探索应用

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

BashCMDPowershell

1. $ export FLASK_APP=hello
2. $ flask run

1. > set FLASK_APP=hello
2. > flask run

1. > $env:FLASK_APP = "hello"
2. > flask run

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

(空)

名称“ app ”或者“ wsgi ”被导入（作为一个“ .py ”文件或者包），自动探测一个应用（ app 或者 application ）或者工厂（ create_app 或者 make_app ）。

FLASK_APP=hello

给定的名称被导入，自动探测一个应用（ app 或者 application ）或者工厂（ create_app 或者 make_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 的函数，使用该函数返回的实例。

如果工厂名称后面是括号，那么其中的内容会被视作为 Python 语言内容，并用作函数的参数。这意味着字符串必须使用双引号包围。

运行开发服务器

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

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

Warning

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

打开一个 Shell

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

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

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

环境

Changelog

New in version 1.0.

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

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

BashCMDPowershell

1. $ export FLASK_ENV=development
2. $ flask run
3. * Serving Flask app "hello"
4. * Environment: development
5. * Debug mode: on
6. * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
7. * Restarting with inotify reloader
8. * Debugger is active!
9. * Debugger PIN: 223-456-919

1. > set FLASK_ENV=development
2. > flask run
3. * Serving Flask app "hello"
4. * Environment: development
5. * Debug mode: on
6. * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
7. * Restarting with inotify reloader
8. * Debugger is active!
9. * Debugger PIN: 223-456-919

1. > $env:FLASK_ENV = "development"
2. > flask run
3. * Serving Flask app "hello"
4. * Environment: development
5. * Debug mode: on
6. * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
7. * Restarting with inotify reloader
8. * Debugger is active!
9. * Debugger PIN: 223-456-919

用重启器监视额外文件

当使用开发模式时，您的 Python 代码或者导入模块发生变动时会触发重启器。如果使用 --extra-files 参数或者设置 FLASK_RUN_EXTRA_FILES 环境变量，那么重启器可以监视额外的文件。多重路径使用 : 分隔， Windows 下使用 ; 。

BashCMDPowershell

1. $ flask run --extra-files file1:dirA/file2:dirB/
2. # or
3. $ export FLASK_RUN_EXTRA_FILES=file1:dirA/file2:dirB/
4. $ flask run
5. * Running on http://127.0.0.1:8000/
6. * Detected change in '/path/to/file1', reloading

1. > flask run --extra-files file1:dirA/file2:dirB/
2. # or
3. > set FLASK_RUN_EXTRA_FILES=file1:dirA/file2:dirB/
4. > flask run
5. * Running on http://127.0.0.1:8000/
6. * Detected change in '/path/to/file1', reloading

1. > flask run --extra-files file1:dirA/file2:dirB/
2. # or
3. > $env:FLASK_RUN_EXTRA_FILES = "file1:dirA/file2:dirB/"
4. > flask run
5. * Running on http://127.0.0.1:8000/
6. * Detected change in '/path/to/file1', reloading

调试模式

如前文所述，当 FLASK_ENV 是 development 时会开启调试模式。如果想要单独控制调试模式，要使用 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 ，而是使用:

BashCMDPowershell

1. $ export FLASK_RUN_PORT=8000
2. $ flask run
3. * Running on http://127.0.0.1:8000/

1. > set FLASK_RUN_PORT=8000
2. > flask run
3. * Running on http://127.0.0.1:8000/

1. > $env:FLASK_RUN_PORT = 8000
2. > flask run
3. * Running on http://127.0.0.1:8000/

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

禁用 dotenv

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

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

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

BashCMDPowershell

1. $ export FLASK_SKIP_DOTENV=1
2. $ flask run

1. > set FLASK_SKIP_DOTENV=1
2. > flask run

1. > $env:FLASK_SKIP_DOTENV = 1
2. > flask run

通过 virturalenv 设置环境变量

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

BashCMDPowershell

Unix Bash, venv/bin/activate:

1. $ export FLASK_APP=hello

Windows CMD, venv\Scripts\activate.bat:

1. > set FLASK_APP=hello

Windows Powershell, venv\Scripts\activate.ps1:

1. > $env:FLASK_APP = "hello"

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

自定义命令

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

以下示例添加了 create-user 命令，带有 name 参数。

1. import click
2. from flask import Flask

4. app = Flask(__name__)

6. @app.cli.command("create-user")
7. @click.argument("name")
8. def create_user(name):
9. ...

1. $ flask create-user admin

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

1. import click
2. from flask import Flask
3. from flask.cli import AppGroup

5. app = Flask(__name__)
6. user_cli = AppGroup('user')

8. @user_cli.command('create')
9. @click.argument('name')
10. def create_user(name):
11. ...

13. app.cli.add_command(user_cli)

1. flask user create demo

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

以蓝图注册命令

如果你的应用使用蓝图，那么可以把 CLI 命令直接注册到蓝图上。当蓝图注册到应用上的时候，相关的命令就可以应用于 flask 命令了。缺省情况下，那些命令会嵌套于一个与蓝图相关匹配的组。

1. from flask import Blueprint

3. bp = Blueprint('students', __name__)

5. @bp.cli.command('create')
6. @click.argument('name')
7. def create(name):
8. ...

10. app.register_blueprint(bp)

1. $ flask students create alice

组名称可以在创建 Blueprint 对像时通过 cli_group 参数定义，也可以创建之后使用 app.register_blueprint(bp, cli_group=’…’) 来变更。下面两条命令功能是相同的：

1. bp = Blueprint('students', __name__, cli_group='other')
2. # or
3. app.register_blueprint(bp, cli_group='other')

1. $ flask other create alice

指定 cli_group=None 会删除嵌套并把命令直接合并到应用级别：

1. bp = Blueprint('students', __name__, cli_group=None)
2. # or
3. app.register_blueprint(bp, cli_group=None)

1. $ flask create alice

应用情境

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

1. import click
2. from flask.cli import with_appcontext

4. @click.command
5. @with_appcontext
6. def do_work():
7. ...

9. app.cli.add_command(do_work)

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

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

插件

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

1. from setuptools import setup

3. setup(
4. name='flask-my-extension',
5. ...,
6. entry_points={
7. 'flask.commands': [
8. 'my-command=flask_my_extension.commands:cli'
9. ],
10. },
11. )

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

1. import click

3. @click.command()
4. def cli():
5. ...

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

自定义脚本

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

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

1. import click
2. from flask import Flask
3. from flask.cli import FlaskGroup

5. def create_app():
6. app = Flask('wiki')
7. # other setup
8. return app

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

在 setup.py 中定义入口点:

1. from setuptools import setup

3. setup(
4. name='flask-my-extension',
5. ...,
6. entry_points={
7. 'console_scripts': [
8. 'wiki=wiki:cli'
9. ],
10. },
11. )

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

1. $ pip install -e .
2. $ wiki run

自定义脚本错误

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

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

PyCharm 集成

PyCharm 专业版提供了一个特定的 Flask run 配置。对于 PyCharm 社区版来说，我们必需做些配置才能顺利使用正确的环境变量来调用 flask run 命令行接口。这些说明同样也适用于其他 IDE 。

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

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

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

从（ A ）下拉框中选择 Module name ，然后输入 flask 。

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

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

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

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

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

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