Flask_BestPractices 开源项目使用教程

Flask_BestPractices 开源项目使用教程

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

1. 项目介绍

Flask_BestPractices 是一个基于 Flask 框架的开源项目，旨在提供一套完整的项目结构和最佳实践。该项目包含了 Restful API 的实现、Jinja2 模板渲染以及与前端分离的实践。此外，项目还提供了数据迁移、定时任务和异常处理等功能模块，可供开发者直接使用和扩展。

2. 项目快速启动

环境准备

确保已经安装 Python 3.9+，pip3 和 pipenv。

克隆项目

git clone https://github.com/yangyuexiong/Flask_BestPractices.git
cd Flask_BestPractices

配置虚拟环境

修改 Pipfile 中的安装源和 Python 版本：

# Pipfile
[requires]
python_version = "3.9"

[packages]
# ...

[dev-packages]
# ...

安装虚拟环境与依赖的包：

pipenv install

进入虚拟环境：

pipenv shell

配置 Flask 运行环境变量

在虚拟环境中设置 Flask 运行环境变量：

export FLASK_ENV=development
export FLASK_DEBUG=1
export FLASK_APP=ApplicationExample.py

启动项目

在虚拟环境中运行以下命令启动项目：

flask run

项目默认运行在 http://127.0.0.1:5000/。

3. 应用案例和最佳实践

项目结构

项目的目录结构如下：

Flask_BestPractices/
├── app/
│   ├── __init__.py
│   ├── all_reference.py
│   ├── api/
│   ├── controllers/
│   ├── models/
│   ├── static/
│   └── templates/
├── common/
│   ├── __init__.py
│   ├── interceptors/
│   └── libs/
├── config/
│   ├── __init__.py
│   ├── config.py
│   ├── dev.ini
│   └── pro.ini
├── ExtendRegister/
│   ├── __init__.py
│   ├── bp_register.py
│   ├── command_register.py
│   ├── 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

Restful API 示例

在 app/api/restful_demo.py 中，可以找到 Flask Restful 的使用示例：

from flask_restful import Resource

class RestfulDemo(Resource):
    def get(self):
        return {'message': 'Hello, Flask Restful!'}

路由注册

在 app/api/__init__.py 中注册路由：

from flask import Blueprint
from app.api.restful_demo import RestfulDemo

api_bp = Blueprint('api', __name__)

api_bp.add_resource(RestfulDemo, '/api/restful_demo/')

异常处理

在 common/libs/customException.py 中定义了自定义异常，可以在视图函数中抛出这些异常：

from flask import jsonify

class CustomException(Exception):
    def __init__(self, code, message):
        self.code = code
        self.message = message

    def to_dict(self):
        return jsonify({'code': self.code, 'message': self.message})

4. 典型生态项目

• ExileTestPlatformWeb：一个基于 Flask_BestPractices 的自动化测试平台 Web 端。
• ExileTestPlatformServer：自动化测试平台服务端。
• AioHttp_BestPractices：AioHttp 的最佳实践。
• FastApi_BestPractices：FastApi 的最佳实践（即将完成）。

以上是 Flask_BestPractices 的基本使用教程。希望对开发者学习和使用 Flask 框架有所帮助。

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