【Python】使用 Pydantic + SQLAlchemy + MySQL 实现自动记录创建时间和更新时间

于 2024-09-29 16:22:32 发布
阅读量274 收藏 10
点赞数 16
分类专栏： Python Python Web 架构设计 文章标签： python 开发语言 mysql
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/h1773655323/article/details/142638219
版权
Python 同时被 3 个专栏收录
53 篇文章 7 订阅
订阅专栏
Python Web
26 篇文章 1 订阅
订阅专栏
架构设计
11 篇文章 0 订阅
订阅专栏

使用 Pydantic + SQLAlchemy + MySQL 实现自动记录创建时间和更新时间

在 Web 应用开发中，自动记录数据库中的 创建时间 和 更新时间 是常见的需求。无论是日志记录、数据跟踪，还是审计功能，这类时间戳都至关重要。本文将介绍如何结合 SQLAlchemy 和 Pydantic，在使用 MySQL 作为数据库时，自动处理数据插入和更新时的时间戳。

技术栈

  • MySQL：作为数据库，保存数据记录。
  • SQLAlchemy：用于操作数据库的 ORM 工具，使得开发者可以通过 Python 类来操作数据库表。
  • Pydantic：用于数据验证和序列化，常用于 FastAPI 等 Web 框架。
  • MySQL Connector：通过 MySQL Connector 或 pymysql 作为 MySQL 的驱动。

需求分析

每个表记录需要包含两个时间字段：

  1. 创建时间 (created_at)：记录数据首次插入数据库的时间，只在插入时设置一次。
  2. 更新时间 (updated_at)：记录数据最近一次被修改的时间，在每次修改时自动更新。

目标是通过 SQLAlchemy 自动处理这两个字段，并且结合 Pydantic 验证和返回数据。

步骤 1：安装依赖

首先，确保你已经安装了以下必要的库：

pip install sqlalchemy pydantic pymysql mysql-connector-python
  • SQLAlchemy：用于与数据库交互。
  • Pydantic：用于数据模型验证。
  • PyMySQL 或 mysql-connector-python：作为 MySQL 的驱动。

步骤 2：配置数据库连接

我们使用 SQLAlchemy 的 create_engine 来连接 MySQL 数据库。假设你已经在 MySQL 中创建了名为 test_db 的数据库。

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

# MySQL 数据库连接
DATABASE_URL = "mysql+pymysql://username:password@localhost:3306/test_db"

# 创建 SQLAlchemy 的 Engine
engine = create_engine(DATABASE_URL)

# 创建数据库 session
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

# 基础模型类
Base = declarative_base()

步骤 3：定义包含时间戳的基础模型

接下来我们创建一个基础模型，该模型包含 created_at 和 updated_at 字段。通过 SQLAlchemy 的 Column 和 DateTime，可以自动处理这些字段。

from sqlalchemy import Column, Integer, DateTime, func

# 创建带有时间戳的基础模型
class TimestampMixin:
    created_at = Column(DateTime, default=func.now(), nullable=False)
    updated_at = Column(DateTime, default=func.now(), onupdate=func.now(), nullable=False)

# 用户自定义基础类，所有模型继承自该类
class BaseModel(Base, TimestampMixin):
    __abstract__ = True  # 该模型不被映射到数据库

    id = Column(Integer, primary_key=True, index=True)

解释

  • TimestampMixin: 该类包含 created_at 和 updated_at 两个字段。created_at 使用 default=func.now() 确保在首次插入数据时自动设置当前时间；updated_at 使用 onupdate=func.now() 确保在每次数据更新时自动更新为当前时间。
  • BaseModel: 作为其他数据模型的基础类，包含 id 字段以及从 TimestampMixin 继承的时间戳字段。

步骤 4：定义具体的数据模型

下面我们定义一个用户模型 User，它继承了 BaseModel，并且包含用户的 name 和 email 字段。

from sqlalchemy import Column, String

# 用户模型
class User(BaseModel):
    __tablename__ = 'users'
    
    # 用户字段
    name = Column(String(50), nullable=False)
    email = Column(String(120), unique=True, nullable=False)

解释

  • User 模型继承自 BaseModel，因此它自动拥有 id、created_at 和 updated_at 字段。
  • name 和 email 是用户模型的其他字段，分别用于存储用户的名字和邮箱地址。

步骤 5：Pydantic 数据模型

为了确保输入数据的验证和输出数据的格式化，我们使用 Pydantic 创建输入和输出数据模型。Pydantic 在结合 FastAPI 等框架时非常有用，能够轻松验证并序列化数据。

from pydantic import BaseModel
from datetime import datetime

# 用户创建输入数据模型
class UserCreate(BaseModel):
    name: str
    email: str

# 用户响应输出数据模型
class UserResponse(BaseModel):
    id: int
    name: str
    email: str
    created_at: datetime
    updated_at: datetime
    
    class Config:
        orm_mode = True

解释

  • UserCreate: 用于验证创建用户时输入的数据，包含 name 和 email。
  • UserResponse: 用于返回给客户端的数据模型，包含 id、name、email 以及 created_at 和 updated_at。
  • orm_mode = True: 允许 Pydantic 从 SQLAlchemy 模型自动生成 Pydantic 模型实例。

步骤 6：实现数据库插入和更新操作

在插入和更新数据时，我们使用 SQLAlchemy 的 Session 来操作数据，同时时间戳字段会自动更新。

from sqlalchemy.orm import Session

# 创建新用户
def create_user(db: Session, user: UserCreate):
    db_user = User(name=user.name, email=user.email)
    db.add(db_user)
    db.commit()
    db.refresh(db_user)  # 获取插入后的最新字段（包括 id 和时间戳）
    return db_user

# 更新用户信息
def update_user(db: Session, user_id: int, user: UserCreate):
    db_user = db.query(User).filter(User.id == user_id).first()
    if db_user:
        db_user.name = user.name
        db_user.email = user.email
        db.commit()
        db.refresh(db_user)  # 确保更新时间戳自动更新
    return db_user

解释

  • create_user: 创建新的用户，并通过 db.commit() 提交数据。db.refresh() 刷新用户对象，确保返回的对象包含最新的 id 和时间戳。
  • update_user: 根据 user_id 查找用户并更新用户信息，db.commit() 会自动更新 updated_at 字段。

步骤 7：创建数据库表并进行操作

在操作数据库之前，我们需要确保数据库表已存在。通过 SQLAlchemy 的 Base.metadata.create_all() 方法可以自动创建表格：

# 创建所有定义的表
Base.metadata.create_all(bind=engine)

之后，可以通过创建 Session 并调用上述的 create_user 和 update_user 函数来操作数据：

# 创建数据库 Session
db = SessionLocal()

# 创建用户
new_user = UserCreate(name="Alice", email="alice@example.com")
created_user = create_user(db, new_user)
print(created_user)

# 更新用户
updated_user = update_user(db, created_user.id, UserCreate(name="Alice Updated", email="alice.updated@example.com"))
print(updated_user)

完整代码示例

from sqlalchemy import create_engine, Column, Integer, String, DateTime, func
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker
from pydantic import BaseModel
from sqlalchemy.orm import Session
from datetime import datetime

# MySQL 数据库连接
DATABASE_URL = "mysql+pymysql://username:password@localhost:3306/test_db"
engine = create_engine(DATABASE_URL)
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
Base = declarative_base()

# 带有时间戳的基础模型
class TimestampMixin:
    created_at = Column(DateTime, default=func.now(), nullable=False)
    updated_at = Column(DateTime, default=func.now(), onupdate=func.now(), nullable=False)

# 基础模型类
class BaseModel(Base, TimestampMixin):
    __abstract__ = True
    id = Column(Integer, primary_key=True, index=True)

# 用户模型
class User(BaseModel):
    __tablename__ = 'users'
    name = Column(String(50), nullable=False)
    email = Column(String(120), unique=True, nullable=False)

# 创建所有表
Base.metadata.create_all(bind=engine)

# Pydantic 输入输出模型
class UserCreate(BaseModel):
    name: str
    email: str

class UserResponse(BaseModel):
    id: int
    name: str
    email: str
    created_at: datetime
    updated_at: datetime

    class Config:
        orm_mode = True

# 创建新

用户
def create_user(db: Session, user: UserCreate):
    db_user = User(name=user.name, email=user.email)
    db.add(db_user)
    db.commit()
    db.refresh(db_user)
    return db_user

# 更新用户
def update_user(db: Session, user_id: int, user: UserCreate):
    db_user = db.query(User).filter(User.id == user_id).first()
    if db_user:
        db_user.name = user.name
        db_user.email = user.email
        db.commit()
        db.refresh(db_user)
    return db_user

# 使用数据库
db = SessionLocal()
new_user = UserCreate(name="Alice", email="alice@example.com")
created_user = create_user(db, new_user)
print(created_user)

updated_user = update_user(db, created_user.id, UserCreate(name="Alice Updated", email="alice.updated@example.com"))
print(updated_user)

总结

通过以上步骤，我们实现了在使用 MySQL 作为数据库时，结合 SQLAlchemy 和 Pydantic 自动记录创建时间和更新时间的功能。SQLAlchemy 负责数据库操作，Pydantic 负责数据验证和序列化，两者结合使得代码更加简洁和安全。在现代 Web 应用开发中，这种模式非常实用，尤其是在使用 FastAPI 等框架时。

写bug如流水
关注
专栏目录
【python】flask操作数据库工具SQLAlchemy，详细用法和应用实战
景天科技苑
04-16 1万+
flask默认不提供数据库操作，也并没有提供ORM，所以一般开发的时候我们会采用flask-SQLAlchemy模块来实现ORM操作。 SQLAlchemy是一个python语言编写的高性能的关系型数据库ORM框架，它提供了高层的 ORM 和底层的原生数据库的操作。 我们使用sqlalchemy 不需要调用sqlalchemy 本身这个模块，而是采用flask-sqlalchemy ，这是一个简化了 SQLAlchemy 操作的flask扩展模块。（主要是简化了sqlalchemy初始化代码和分页操作等）
python和mysql数据类型对应_Flask SQLAlchemy 数据类型喝数据库的对应关系
weixin_29014237的博客
02-03 1228
类型名MySQL类型python类型描述SmallIntegersmallintint取值范围较小，一般为16位Integerintint普通整数，一般32位BigIntegerbigintint/long不限精度的整数Floatfloatfloat浮点数Numericdecimaldecimal.Decimal定点数Stringvarcharstr变长字符串Texttinytextstr变长字符...
Python + SQLAlchemy操作MySQL数据库（ORM）
上庸者-不服周
04-19 568
SQLAlchemy是用Python编程语言开发的一个开源项目。它提供了SQL工具包和ORM（对象关系映射）工具，使用MIT许可证发行。SQLAlchemy采用简单的Python语言，提供高效和高性能的数据库访问，实现了完整的企业级持久模型。它的理念是SQL数据库的量级和性能比对象集合重要，而对象集合的抽象又重要于表和行。
Pydantic与Sqlalchemy数据模型的枚举类型实践
bennybi的博客
05-21 758
【代码】Pydantic与Sqlalchemy数据模型的枚举类型实践。
FastAPI+SQLAlchemy数据库连接
AZURE060606的博客
07-07 864
【代码】FastAPI+SQLAlchemy数据库连接。
python+sqlalchemy 数据库的读取和写入
Amy9_Miss的博客
12-21 4172
Python+ SQLAlchemy 数据库的读取和写入 ​ SQLAlchemy是Python中最有名的ORM（Object Relational Mapping，对象关系映射）框架之一，该框架建立在数据库API之上，使用关系对象映射进行数据库操作，为高效和高性能的数据库访问设计 ，支持多数据库，如mysql、Oracle等。 环境 操作系统：Windows10 python：3.6 安...
Python中Flask-SQLAlchemy框架的使用
weixin_51762789的博客
04-26 454
Flask-SQLAlchemy 是一个 Flask 扩展，它为 Flask 应用提供了对 SQLAlchemy 的集成支持，使得在 Flask 应用中操作数据库变得非常简单。SQLAlchemy 是一个强大的 Python ORM（对象关系映射）框架，它允许开发者使用 Python 类和对象来操作数据库，而无需编写繁琐的 SQL 语句。
FastAPI 结合 SQLAlchemy 操作 MySQL 数据库
Michael是个半路程序员
12-02 3717
文章目录1. 安装 SQLAlchemy2. 创建数据库3. SQLAlchemy 连接 MySQL4. 创建数据模型5. 创建 Pydantic 模型6. crud 工具7. main函数 learning from 《python web开发从入门到精通》 1. 安装 SQLAlchemy pip install sqlalchemy 2. 创建数据库 mysql -u root -p 命令行登录 MySQL 创建数据库 fastapi_db mysql> create database
【FastAPI】Python FastAPI + MySQL 操作流程
热门推荐
VLyb
11-26 1万+
本文将使用Python Web框架 FastAPI 实现与关系数据库MySQL的连接与操作。 一、连接 MySQL 在database.py中，完成与MySQL的连接 # database.py from sqlalchemy import create_engine from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker SQLALCHEMY_DATABASE_UR
pydantic-sqlalchemy:将SQLAlchemy模型转换为Pydantic模型的工具
03-19
Pydantic-SQLAlchemy 从SQLAlchemy模型生成Pydantic模型的工具。 仍处于实验阶段。 如何使用 快速示例： from typing import List from pydantic_sqlalchemy import sqlalchemy_to_pydantic from sqlalchemy import...
ormar:考虑到fastapi和pydantic验证的python async orm
08-04
只需要维护一个模型- 您不必维护 pydantic 和其他 orm 模型（sqlalchemy、peewee、gino 等） 目标是创建一个简单的 ORM，可以直接使用（作为请求和响应模型）与的数据验证的 fastapi。 Ormar - 除了名称上明显的 ...
VeighNa：强大的Python开源量化交易平台
Unity打怪升级
09-26 621
VeighNa（简称 VN 或 vn.py）是一个基于 Python 的开源量化交易平台，专为量化交易爱好者和专业交易员设计。VeighNa 是由国内开发者社区推动的开源项目，旨在提供一个功能丰富、灵活且易于扩展的量化交易解决方案。该框架不仅支持多种资产类别的交易，如股票、期货、期权、加密货币等，还支持多种交易接口和协议，使得用户能够轻松进行多市场、多品种的交易策略开发和部署。
Python精选200Tips：171-175
AnFany
09-26 1090
Python深度学习的项目
ubuntu安装libtorch
meng_152634的博客
09-25 714
nouveau是由第三方为NVIDIA显卡开发的一个开源3D驱动，ubuntu默认集成了nouveau驱动，安装NVIDIA驱动前必须禁用系统自带的显卡驱动nouveau，否则安装NVIDIA驱动时会报错。，一定要确定好安装的CUDA版本是否支持显卡的算力，否则安装成功也无法使用GPU加速。如果cmake版本低于3.18，会出现下面的报错，这是由于低于3.18的cmake不支持CUDA17的编译，需要更新cmake版本。因为安装的CUDA版本为12.1，这里选择最新版的CUDNN 9.4.0进行安装。
Python 高阶内容：套娃式装饰器巧妙为函数增加功能
敲代码别忘了喝上一杯凉白开。
09-23 577
装饰器是 Python 中一种非常强大且灵活的工具，能够在不修改函数本身的情况下，为函数增加额外的功能。本文介绍了装饰器的基本概念及应用，通过实例演示如何在函数执行前后添加额外操作，如鉴权、数据验证等，类似“套娃”般层层嵌套。文章还通过代码示例展示了如何定义和使用装饰器，以及如何将装饰器与实际业务逻辑结合，实现灵活的功能扩展。这种设计模式不仅可以提升代码的可读性和可维护性，还可以有效减少代码的冗余。掌握装饰器的用法，将为你的 Python 编程技巧增添更多亮点。
numpy is not available
最新发布
xfsong2012的博客
09-27 227
在测试第一个程序的时候，出现Numpy is not available的错误，根据。安装的时候，安装的是最新版的numpy，检查numpy的版本为2.1.1版。我的pytorch版本为1.12.1，选择不高于1.21的版本即可。的办法知道是因为numpy与pytorch版本不一致造成的。2、安装需要的numpy版本，比如1.21版。
Java函数式接口日常使用
weng74的博客
09-24 472
Java 8 中函数接口使用到了业务开发中，方法灵活性和可复用性得到了很大的提升，方便业务的开发，下面来看看具体使用场景
cuda算子优化-transpose
weixin_46347213的博客
09-24 270
cache写策略：l1和l2之间采用write-through & not write-allocate；对于write-allocate要注意一点，如果某个来自l2 cache的store request刚好写一个sector那么就不需要把这个sector从HBM中先读到l2 cache（因为读了也是白读，这块sector全部要被写入），如果该request要写的sector中有些字节没写到，那么就需要先把该sector读到l2 cache再写l2 cache。- cache的读写策略。
python+oracle+sql+s,Python+SQLAlchemy+Oracle+sequences=无法插入n
05-23
如果你使用 Python, SQLAlchemy 和 Oracle，以及 sequences 生成 id，但是无法插入数据，可能是因为你没有正确地配置 sequences。 首先，确保你的表中有一个名为 id 的字段，并且它是一个自增长的主键。然后，在 SQLAlchemy 中，你需要使用 `Sequence` 类来定义一个 sequence，如下所示： ``` from sqlalchemy import Sequence id_seq = Sequence('id_seq') ``` 接下来，在你的表定义中，将 id 字段设置为从该 sequence 中获取下一个值，如下所示： ``` from sqlalchemy import Column, Integer class MyTable(Base): __tablename__ = 'my_table' id = Column(Integer, id_seq, primary_key=True) name = Column(String) ... ``` 然后，在插入数据时，你需要使用 `next_value()` 方法来获取下一个 sequence 值，并将其插入到表中，如下所示： ``` from sqlalchemy.orm import sessionmaker Session = sessionmaker(bind=engine) session = Session() next_id = session.execute(id_seq) data = { 'id': next_id, 'name': 'John Doe', ... } my_table = MyTable(**data) session.add(my_table) session.commit() ``` 这样就可以正确地插入数据了。注意，如果你在使用 Oracle 11g 或更低版本，则需要使用 `Sequence` 对象的 `execute()` 方法来获取下一个 sequence 值，而不是 `session.execute()`。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

写bug如流水

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值