python sqlalchemy flask 项目结构

原创

mob64ca12eaf194 2024-09-27 06:29:35 ©著作权

文章标签 flask 项目结构 python 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12eaf194的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python SQLAlchemy Flask 项目结构指南

在现代Web开发中，Flask是一个流行的轻量级Web框架，它具有灵活性和简洁性。而SQLAlchemy则是Python中的一个强大的ORM（对象关系映射）库，可以轻松地与数据库进行交互。将这两者结合在一起，创建一个结构清晰的项目是非常重要的。本文将介绍一个典型的Flask与SQLAlchemy项目结构，并通过代码示例进行说明。

项目结构

一个建议的项目结构如下所示：

/my_flask_app
    ├── app/
    │   ├── __init__.py
    │   ├── models.py
    │   ├── routes.py
    │   └── config.py
    ├── migrations/
    ├── tests/
    ├── run.py
    └── requirements.txt

1. `init.py`

这个文件负责初始化Flask应用及其配置信息，连接到数据库。

# app/__init__.py
from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config.from_object('app.config.Config')
db = SQLAlchemy(app)

from app import routes, models

2. `config.py`

在此文件中，定义应用的配置，包括数据库配置等。

# app/config.py
class Config:
    SQLALCHEMY_DATABASE_URI = 'sqlite:///yourdatabase.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

3. `models.py`

在这里定义数据库模型，如用户和文章模型。

# app/models.py
from app import db

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), unique=True, nullable=False)

    def __repr__(self):
        return f'<User {self.username}>'

class Post(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    title = db.Column(db.String(200), nullable=False)
    content = db.Column(db.Text, nullable=False)
    user_id = db.Column(db.Integer, db.ForeignKey('user.id'), nullable=False)

    def __repr__(self):
        return f'<Post {self.title}>'

4. `routes.py`

在这里定义处理请求的路由。

# app/routes.py
from flask import jsonify
from app import app, db
from app.models import User

@app.route('/users', methods=['GET'])
def get_users():
    users = User.query.all()
    return jsonify([{'id': user.id, 'username': user.username} for user in users])

5. `run.py`

在此文件中启动Flask应用。

# run.py
from app import app

if __name__ == '__main__':
    app.run(debug=True)

数据库迁移

使用Flask-Migrate可以轻松管理数据库迁移。在项目目录下运行：

pip install Flask-Migrate

接着在__init__.py中进行配置：

from flask_migrate import Migrate

migrate = Migrate(app, db)

创建迁移脚本并升级数据库：

flask db init
flask db migrate -m "Initial migration."
flask db upgrade

状态图

在这里展示我们Flask应用的基本状态流转。我们可以使用Mermaid语法绘制图表。

stateDiagram
    [*] --> Unauthenticated
    Unauthenticated --> Authenticated : Login
    Authenticated --> Unauthenticated : Logout
    Authenticated --> ViewingPosts : View Posts
    ViewingPosts --> Authenticated : Go Back

序列图

以下是一个简单的序列图，展示用户请求用户列表的过程。

sequenceDiagram
    participant User
    participant FlaskApp
    participant DB

    User->>FlaskApp: GET /users
    FlaskApp->>DB: Query all users
    DB-->>FlaskApp: Return user data
    FlaskApp-->>User: Return user data in JSON format