如何在Python类中为SQLite连接与游标正确添加类型注解？

问题根源 #

你遇到的mypy警告，是因为self.conn初始值为None，mypy默认认为它始终可能是None，所以访问self.conn.cursor()时会提示"None类型对象无法拥有cursor属性"。解决核心是明确标注实例变量的类型，并让mypy知道连接成功后conn不再是None。

基础解决方案：添加类型注解+断言 #

首先给类的实例变量标注Optional类型（因为初始化时为None，连接后变为实际的SQLite对象），再用assert告诉mypy连接成功后conn非空：

import sqlite3
from typing import Optional

class DBConn:
    # 明确标注实例变量的类型
    conn: Optional[sqlite3.Connection]
    cursor: Optional[sqlite3.Cursor]
    db_path: str

    def __init__(self, db_path: str) -> None:
        self.db_path = db_path
        self.conn = None
        self.cursor = None

    def connect(self) -> bool:
        try:
            self.conn = sqlite3.connect(self.db_path)
            # 用assert确认conn非空，mypy会认可这个判断
            assert self.conn is not None, "数据库连接初始化失败"
            self.cursor = self.conn.cursor()
            return True
        except sqlite3.Error as e:
            print(f"连接数据库出错: {e}")
            return False

为什么这样有效？ #

• Optional[sqlite3.Connection]告诉mypy：self.conn要么是sqlite3.Connection对象，要么是None。
• sqlite3.connect()失败时会直接抛出sqlite3.Error，被except捕获，所以走到self.conn.cursor()时，self.conn必然是有效的连接对象，assert能让mypy消除这个位置的类型疑虑。

你也可以用typing.cast替代assert，但assert更直观，还能在运行时做额外校验：

from typing import cast

# ...
self.conn = sqlite3.connect(self.db_path)
self.cursor = cast(sqlite3.Connection, self.conn).cursor()

更Pythonic的写法：用上下文管理器管理连接 #

上面的写法需要手动管理连接的关闭，容易出现资源泄漏。更符合Python习惯的方式是用上下文管理器，自动处理连接的开启和关闭：

import sqlite3
from typing import Optional
from contextlib import contextmanager

class DBConn:
    def __init__(self, db_path: str) -> None:
        self.db_path = db_path
        self.conn: Optional[sqlite3.Connection] = None
        self.cursor: Optional[sqlite3.Cursor] = None

    @contextmanager
    def session(self):
        """提供数据库会话的上下文管理器"""
        try:
            self.conn = sqlite3.connect(self.db_path)
            self.cursor = self.conn.cursor()
            yield self.cursor  # 把游标交给外部使用
        except sqlite3.Error as e:
            print(f"数据库操作出错: {e}")
            if self.conn:
                self.conn.rollback()  # 出错时回滚
            raise
        finally:
            # 无论成功失败，都关闭连接
            if self.conn:
                self.conn.close()
                self.conn = None
                self.cursor = None

使用方式 #

# 用with语句自动管理连接生命周期
with DBConn("my_database.db").session() as cursor:
    cursor.execute("SELECT * FROM users")
    results = cursor.fetchall()
    # 处理查询结果

这种写法的优势：

1. 自动关闭连接，避免资源泄漏；
2. 出错时自动回滚事务（如果开启了事务）；
3. 代码更简洁，符合Python的"资源获取即初始化"（RAII）思想。

内容的提问来源于stack exchange，提问作者waslow