Flask_BestPractices 项目使用文档

Flask_BestPractices 项目使用文档

Flask_BestPractices Flask最佳实践 项目地址: https://gitcode.com/gh_mirrors/fl/Flask_BestPractices

1. 项目目录结构及介绍

项目采用典型的MVC（Model-View-Controller）结构，以下是项目的目录结构及其介绍：

Flask_BestPractices/
├── app/                     # 应用目录，包含业务逻辑
│   ├── __init__.py          # 应用初始化文件
│   ├── all_reference.py     # 通用统一导入
│   ├── api/                 # API相关模块
│   ├── controllers/         # 其他业务模块
│   ├── models/              # 数据模型
│   ├── static/              # 静态文件（CSS、JS、图片等）
│   ├── templates/           # 模板文件（HTML）
├── common/                  # 公共文件分类
│   ├── __init__.py
│   ├── interceptors/        # 路由钩子
│   ├── libs/                # 公共库
├── config/                  # 配置文件目录
│   ├── __init__.py
│   ├── config.py
│   ├── dev.ini              # 开发环境配置
│   ├── pro.ini              # 生产环境配置
├── ExtendRegister/          # 扩展统一注册
│   ├── __init__.py
│   ├── bp_register.py       # 蓝图注册
│   ├── command_register.py  # flask shell 注册
│   ├── conf_register.py     # 配置文件注册
│   ├── db_register.py       # 数据库注册
│   ├── excep_register.py    # 异常处理注册
│   ├── hook_register.py     # 路由钩子拦截器注册
│   ├── model_register.py    # 模型注册
├── logs/                    # 日志文件
├── migrations/              # 数据迁移文件
├── tasks/                   # 定时任务/异步任务
├── test/                    # 测试文件
├── ApplicationExample.py    # 应用实例
├── LICENSE                  # 许可证文件
├── Pipfile                  # 环境依赖文件
├── Pipfile.lock
├── README.md                # 项目说明文件
├── run.py                   # 启动文件
└── test_run.py             # 调试启动文件

2. 项目的启动文件介绍

项目提供了两个启动文件，分别为 run.py 和 test_run.py。

• run.py: 正常启动应用的入口文件，通常用于生产环境。
• test_run.py: 调试启动文件，通常用于开发环境，可以忽略或删除。

启动应用时，可以执行以下命令：

python run.py

或者，如果是开发环境，可以执行：

python test_run.py

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包括以下几个文件：

• config.py: 包含基本的配置信息。
• dev.ini: 开发环境下的配置文件。
• pro.ini: 生产环境下的配置文件。

配置文件中可以设置数据库连接信息、静态文件路径、日志配置等。在 config.py 中可以通过环境变量切换不同的配置文件。

例如，在开发环境中，可以在 dev.ini 文件中设置：

[app:main]
use_redirecteur = false
debug = true
...

在生产环境中，则在 pro.ini 文件中设置：

[app:main]
use_redirecteur = true
debug = false
...

通过设置环境变量 FLASK_ENV，可以指定 Flask 使用的配置环境，如：

export FLASK_ENV=development

或者通过修改 Pipfile 中的 flask 命令设置环境变量：

[scripts]
flask = flask run --env=development

这样，在使用 flask 命令时，将自动采用开发环境的配置。

Flask_BestPractices Flask最佳实践 项目地址: https://gitcode.com/gh_mirrors/fl/Flask_BestPractices