项目布局 — Flask 文档

来自菜鸟教程
Flask/docs/2.0.x/tutorial/layout
跳转至:导航、​搜索

项目布局

创建项目目录并输入:

$ mkdir flask-tutorial
$ cd flask-tutorial

然后按照【X16X】安装说明【X45X】搭建Python虚拟环境,为你的项目安装Flask。

本教程假设您从现在开始在 flask-tutorial 目录下工作。 每个代码块顶部的文件名都是相对于该目录的。



Flask 应用程序可以像单个文件一样简单。

hello.py

from flask import Flask

app = Flask(__name__)


@app.route('/')
def hello():
    return 'Hello, World!'

然而,随着项目变大,将所有代码保存在一个文件中变得势不可挡。 Python 项目使用 packages 将代码组织成多个模块,可以在需要的地方导入,本教程也会这样做。

项目目录将包含:

  • flaskr/,一个包含您的应用程序代码和文件的 Python 包。
  • tests/,包含测试模块的目录。
  • venv/,一个 Python 虚拟环境,其中安装了 Flask 和其他依赖项。
  • 安装文件告诉 Python 如何安装你的项目。
  • 版本控制配置,例如 git。 无论大小,您都应该养成对所有项目使用某种类型的版本控制的习惯。
  • 您将来可能添加的任何其他项目文件。

最后,您的项目布局将如下所示:

/home/user/Projects/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

venv/

*.pyc
__pycache__/

instance/

.pytest_cache/
.coverage
htmlcov/

dist/
build/
*.egg-info/

继续 应用程序设置