项目布局
教程项目包含如下内容:
-
flaskr/
,一个包含应用代码和文件的 Python 包。 -
tests/
,一个包含测试模块的文件夹。 -
venv/
,一个 Python 虚拟环境,用于安装 Flask 和其他依赖的包。 - 告诉 Python 如何安装项目的安装文件。
- 版本控制配置,如 git 。不管项目大小,应当养成使用版本控制的习惯。
- 项目需要的其他文件。
最后,项目布局如下:
D:\pythonProject\flask-tutorial
├── flaskr/
│ ├── __init__.py
│ ├── db.py
│ ├── schema.sql
│ ├── auth.py
│ ├── blog.py
│ ├── templates/
│ │ ├── base.html
│ │ ├── auth/
│ │ │ ├── login.html
│ │ │ └── register.html
│ │ └── blog/
│ │ ├── create.html
│ │ ├── index.html
│ │ └── update.html
│ └── static/
│ └── style.css
├── tests/
│ ├── conftest.py
│ ├── data.sql
│ ├── test_factory.py
│ ├── test_db.py
│ ├── test_auth.py
│ └── test_blog.py
├── venv/
├── setup.py
└── MANIFEST.in
如果使用了版本控制,那么应当忽略运行项目时产生的临时文件以及编辑代码时编辑 器产生的临时文件。忽略文件的基本原则是:不是你自己写的文件就可以忽略。举例 来说,假设使用 git 来进行版本控制,那么使用.gitignore
来设置应当忽略 的文件,.gitignore
文件应当与下面类似:
venv/
*.pyc
__pycache__/
instance/
dist/
build/
*.egg-info/
构建和安装
当需要把应用部署到其他地方时,需要构建一个发行文件。当前 Python 的标准发行 文件是 wheel 格式的,扩展名为 .whl 。先确保已经安装好 wheel 库:
(venv) D:\pythonProject\flask-tutorial\flaskr>pip install wheel
用 Python 运行 setup.py 会得到一个命令行工具,以使用构建相关命令。 bdist_wheel 命令会构建一个 wheel 发行文件。
(venv) D:\pythonProject\flask-tutorial\flaskr> python setup.py bdist_wheel
构建的文件为 dist/flaskr-1.0.0-py3-none-any.whl 。文件名由项目名称、版 本号和一些关于项目安装要求的标记组成。
使用PyCharm创建一个新项目flask-test时会创建一个新的虚拟环境 ,然后复制构建文件flaskr-1.0.0-py3-none-any.whl 到flask-test目录下,然后用 pip 安装这个文件
(venv) D:\pythonProject\flask-test>pip install flaskr-1.0.0-py3-none-any.whl
Pip 会安装项目和相关依赖。(需要将flaskr程序复制到该目录下)
再次运行 init-db 命令,会在venv/var/flaskr-instance 实例文件夹中创建数据库。
(venv) D:\pythonProject\flask-test> set FLASK_APP=flaskr
(venv) D:\pythonProject\flask-test> flask init-db
运行产品服务器
当运行公开服务器而不是进行开发的时候,应当不使用内建的开发服务器 ( flask run )。开发服务器由 Werkzeug 提供,目的是为了方便开发,但是 不够高效、稳定和安全。
替代地,应当选用一个产品级的 WSGI 服务器。例如使用 Waitress 。首先在虚拟环境中安装它:
(venv) D:\pythonProject\flask-test> pip install waitress
需要把应用告知 Waitress ,但是方式与 flask run 那样使用 FLASK_APP 不同。需要告知 Waitress 导入并调用应用工厂来得到一个应用对象。
(venv) D:\pythonProject\flask-test> waitress-serve --call flaskr:create_app
访问后如下图
使用 Waitress 只是一个示例,选择它是因为它同时支持 Windows 和 Linux 。还有其他许多 WSGI 服务器和部署选项可供选择。不同方式部署应用的列表参见 部署方式