SQLAlchemy 2.0 类型注解指南之Mapped与mapped_column详解

 更新时间:2025年12月30日 10:12:25   作者:nvd11  
SQLAlchemy 1.4和2.0引入了新的声明式映射系统,核心组件是Mapped类型注解和mapped_column构造函数,旨在提供更好的Python类型提示支持,本文介绍SQLAlchemy 2.0 类型注解指南之Mapped与mapped_column,感兴趣的朋友跟随小编一起看看吧

简介

在 SQLAlchemy 1.4 和 2.0 中,ORM(对象关系映射)引入了一种新的声明式映射系统,核心组件是 Mapped 类型注解和 mapped_column 构造函数。这种新风格旨在提供更好的 Python 类型提示(Type Hinting)支持,解决旧版 Column 写法在静态代码分析(如 Pyright, MyPy)和 IDE 自动补全方面的问题。

解决的问题

1. 静态类型检查报错

这是最常见的问题。在旧版写法中,模型属性被定义为 Column 对象,例如:

id = Column(Integer, primary_key=True)

对于静态分析工具(如 Pyright),id 的类型是 Column[Integer]。然而,当你实例化模型对象访问 user.id 时,其实际值是 int 类型。

当你尝试将 user.id 传递给一个期望 int 的函数时,Pyright 会报错:

Argument of type “Column[Integer]” cannot be assigned to parameter of type “int”

Mapped 解决了这个问题。它明确告诉类型检查器,虽然我们在类定义中使用了描述符,但在实例中该属性表现为指定的 Python 类型。

2. IDE 智能感知

由于类型明确,现代 IDE(如 VS Code, PyCharm)能更准确地提供代码补全和错误提示。例如,定义为 Mapped[str | None] 的字段,IDE 会提示你该字段可能为 None。

用法对比

1. 基本字段

旧写法 (Legacy):

from sqlalchemy import Column, Integer, String
class User(Base):
    __tablename__ = "user"
    id = Column(Integer, primary_key=True)
    name = Column(String(50), nullable=False)
    email = Column(String(100))

新写法 (Modern - SQLAlchemy 2.0+):

from sqlalchemy.orm import Mapped, mapped_column
from sqlalchemy import String
from typing import Optional
class User(Base):
    __tablename__ = "user"
    # Mapped[int] 告诉类型检查器:实例中的 id 是 int 类型
    # mapped_column(...) 定义了数据库列的属性
    id: Mapped[int] = mapped_column(primary_key=True)
    # nullable=False 是默认的,对应 Mapped[str]
    name: Mapped[str] = mapped_column(String(50))
    # Optional[str] 或 str | None 对应 nullable=True
    email: Mapped[Optional[str]] = mapped_column(String(100))

2. 复杂类型 (UUID, DateTime)

旧写法:

import uuid
from sqlalchemy.dialects.postgresql import UUID
from sqlalchemy import Column, DateTime, func
class Document(Base):
    id = Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
    created_at = Column(DateTime(timezone=True), server_default=func.now())

新写法:

import uuid
from datetime import datetime
from sqlalchemy.orm import Mapped, mapped_column
from sqlalchemy.dialects.postgresql import UUID
from sqlalchemy import DateTime, func
class Document(Base):
    # 明确指定 id 是 uuid.UUID 类型
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
    # 明确指定 created_at 是 datetime 类型
    created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())

3. 外键与关系

旧写法:

from sqlalchemy import ForeignKey
from sqlalchemy.orm import relationship
class Post(Base):
    user_id = Column(Integer, ForeignKey("user.id"))
    user = relationship("User")

新写法:

from sqlalchemy import ForeignKey
from sqlalchemy.orm import Mapped, mapped_column, relationship
class Post(Base):
    user_id: Mapped[int] = mapped_column(ForeignKey("user.id"))
    # 这里的 relationship 也支持 Mapped 类型
    user: Mapped["User"] = relationship()

关键点总结

  1. 导入: 使用 from sqlalchemy.orm import Mapped, mapped_column
  2. 类型注解: 必须为每个列添加 Python 类型注解(如 : Mapped[int])。
  3. Nullable:
    • Mapped[str] 隐含 nullable=False
    • Mapped[Optional[str]]Mapped[str | None] 隐含 nullable=True
  4. SQL 类型: 在 mapped_column() 中通过第一个参数指定 SQL 类型(如 String(50)),如果类型可以从 Python 类型推断(如 int -> Integer),则可以省略。但对于 String(需要长度)或 UUID 等特殊类型,通常还是需要指定。

通过采用这种新写法,你的代码将更加健壮,更易于维护,并且能通过严格的静态类型检查。

到此这篇关于SQLAlchemy 2.0 类型注解指南:`Mapped` 与 `mapped_column`的文章就介绍到这了,更多相关SQLAlchemy 2.0 类型注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • jupyternotebook 撤销删除的操作方式

    jupyternotebook 撤销删除的操作方式

    这篇文章主要介绍了jupyternotebook 撤销删除的操作方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-04-04
  • Python Django 通用视图和错误视图的使用代码

    Python Django 通用视图和错误视图的使用代码

    这篇文章主要介绍了Python Django 通用视图和错误视图的使用,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-04-04
  • python读取excel文件的方法

    python读取excel文件的方法

    文章介绍了在Python中读取Excel文件的两种方法:使用pandas库和使用openpyxl库,pandas适合数据分析和处理,而openpyxl提供了更多的Excel文件操作功能,感兴趣的朋友跟随小编一起看看吧
    2024-11-11
  • python的scikit-learn将特征转成one-hot特征的方法

    python的scikit-learn将特征转成one-hot特征的方法

    今天小编就为大家分享一篇python的scikit-learn将特征转成one-hot特征的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07
  • python进程间数据交互的几种实现方式

    python进程间数据交互的几种实现方式

    本文主要介绍了python进程数据交互的几种实现方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-05-05
  • Python个人博客程序开发实例框架设计

    Python个人博客程序开发实例框架设计

    这篇文章主要介绍了怎样用Java来实现一个完整的个人博客系统,我们通过实操上手的方式可以高效的巩固所学的基础知识,感兴趣的朋友一起来看看吧
    2022-12-12
  • 详解python 内存优化

    详解python 内存优化

    这篇文章主要介绍了python 内存优化的相关资料,帮助大家更好的理解和学习python,感兴趣的朋友可以了解下
    2020-08-08
  • 使用python+whoosh实现全文检索

    使用python+whoosh实现全文检索

    今天小编就为大家分享一篇使用python+whoosh实现全文检索,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-12-12
  • Python时间和日期库的实现

    Python时间和日期库的实现

    这篇文章主要介绍了Python时间和日期库的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • Opencv+Python 色彩通道拆分及合并的示例

    Opencv+Python 色彩通道拆分及合并的示例

    今天小编就为大家分享一篇Opencv+Python 色彩通道拆分及合并的示例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-12-12

最新评论