大型应用作为一个包

假设有一个简单的应用结构如下:

  1. /yourapplication
  2.     yourapplication.py
  3.     /static
  4.         style.css
  5.     /templates
  6.         layout.html
  7.         index.html
  8.         login.html
  9.         ...

这个结构对于小应用来说没有问题，但是对于大应用来说应当用包来代替模块。 教程 就使用了包方案，参见 示例代码 。

简单的包

要把上例中的小应用装换为大型应用只要在现有应用中创建一个新的 yourapplication 文件夹，并把所有东西都移动到这个文件夹内。然后把 yourapplication.py 更名为 __init__.py 。（请首先删除所有 .pyc 文件，否则基本上会出问题）

修改完后应该如下例:

  1. /yourapplication
  2.     /yourapplication
  3.         __init__.py
  4.         /static
  5.             style.css
  6.         /templates
  7.             layout.html
  8.             index.html
  9.             login.html
  10.             ...

但是现在如何运行应用呢？原本的 python yourapplication/__init__.py 无法 运行了。因为 Python 不希望包内的模块成为启动文件。但是这不是一个大问题，只 要在 yourapplication 文件夹旁添加一个 runserver.py 文件就 可以了，其内容如下:

  1. from setuptools import setup
  3. setup(
  4.     name='yourapplication',
  5.     packages=['yourapplication'],
  6.     include_package_data=True,
  7.     install_requires=[
  8.         'flask',
  9.     ],
  10. )

为了运行应用，需要导出一个环境变量，告诉 Flask 应用实例的位置：

BashCMDPowershell

  1. $ export FLASK_APP=yourapplication
  1. > set FLASK_APP=yourapplication
  1. > $env:FLASK_APP = "yourapplication"

如果位于项目文件夹之外，请确保提供绝对路径。同样可以这样打开开发功能：

BashCMDPowershell

  1. $ export FLASK_ENV=development
  1. > set FLASK_ENV=development
  1. > $env:FLASK_ENV = "development"

为了安装并运行应用，需要执行以下命令:

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

我们从中学到了什么？现在我们来重构一下应用以适应多模块。只要记住以下几点：

  1. Flask 应用对象必须位于 __init__.py 文件中。这样每个模块就可以 安全地导入了，且 __name__ 变量会解析到正确的包。

  2. 所有视图函数（在顶端有 route() 的）必须在 __init__.py 文件中被导入。不是导入对象本身，而是导入视图模块。 请 在应用对象创建之后 导入视图对象。

__init__.py 示例:

  1. from flask import Flask
  2. app = Flask(__name__)
  4. import yourapplication.views

views.py 内容如下:

  1. from yourapplication import app
  3. @app.route('/')
  4. def index():
  5.     return 'Hello World!'

最终全部内容如下:

  1. /yourapplication
  2.     setup.py
  3.     /yourapplication
  4.         __init__.py
  5.         views.py
  6.         /static
  7.             style.css
  8.         /templates
  9.             layout.html
  10.             index.html
  11.             login.html
  12.             ...

回环导入

回环导入是指两个模块互相导入，本例中我们添加的 views.py 就 与 __init__.py 相互依赖。每个 Python 程序员都讨厌回环导入。 一般情况下回环导入是个坏主意，但在这里一点问题都没有。原因是我们没 有真正使用 __init__.py 中的视图，只是保证模块被导入，并且我 们在文件底部才这样做。

但是这种方式还是有些问题，因为没有办法使用装饰器。要找到解决问题的 灵感请参阅 大型应用 一节。

使用蓝图

对于大型应用推荐把应用分隔为小块，每个小块使用蓝图辅助执行。关于这个主题的 介绍请参阅 使用蓝图进行应用模块化 一节 。