项目可安装化

项目可安装化是指创建一个项目 发行 文件,以使用项目可以安装到其他环境, 就像在你的项目中安装 Flask 一样。这样可以使你的项目如同其他库一样进行部署, 可以使用标准的 Python 工具来管理项目。

可安装化还可以带来如下好处,这些好处在教程中可以不太明显或者初学者可能没 注意到:

  • 现在, Python 和 Flask 能够理解如何 flaskr 包,是因为你是在项目 文件夹中运行的。可安装化后,可以从任何地方导入项目并运行。
  • 可以和其他包一样管理项目的依赖,即使用 pip install yourproject.whl 来安装项目并安装相关依赖。
  • 测试工具可以分离测试环境和开发环境。

Note

这些内容会在随后的教程中说明,但是在以后的项目中应当以此为项目的起点。

描述项目

setup.py 文件描述项目及其从属的文件。

setup.py
from setuptools import find_packages, setup

setup(
    name='flaskr',
    version='1.0.0',
    packages=find_packages(),
    include_package_data=True,
    zip_safe=False,
    install_requires=[
        'flask',
    ],
)

packages 告诉 Python 包所包括的文件夹(及其所包含的 Python 文件)。 find_packages() 自动找到这些文件夹,这样就不用手动写出来。 为了包含其他文件夹,如静态文件和模板文件所在的文件夹,需要设置 include_package_data 。 Python 还需要一个名为 MANIFEST.in 文件来说明这些文件有哪些。

MANIFEST.in
include flaskr/schema.sql
graft flaskr/static
graft flaskr/templates
global-exclude *.pyc

这告诉 Python 复制所有 statictemplates 文件夹中的文件, schema.sql 文件,但是排除所有字节文件。

更多内容和参数参见 官方打包指南

安装项目

使用 pip 在虚拟环境中安装项目。

pip install -e .

这个命令告诉 pip 在当前文件夹中寻找 setup.py 并在 编辑开发 模式下安装。编辑模式是指当改变本地代码后,只需要重新项目。比如改变了项目 依赖之类的元数据的情况下。

可以通过 pip list 来查看项目的安装情况。

pip list

Package        Version   Location
-------------- --------- ----------------------------------
click          6.7
Flask          1.0
flaskr         1.0.0     /home/user/Projects/flask-tutorial
itsdangerous   0.24
Jinja2         2.10
MarkupSafe     1.0
pip            9.0.3
setuptools     39.0.1
Werkzeug       0.14.1
wheel          0.30.0

至此,如何运行项目没有改变。 FLASK_APP 还是被设置为 flaskr ,并且还是使用 flask run 运行 应用。

下面请阅读 测试覆盖