使用pyodbc上下文管理器连接SQL Server导入Pandas DataFrame遇错求助

问题描述 #

我对如何使用上下文管理器管理pyodbc连接感到困惑。据我所知，通常需要关闭数据库连接，使用上下文管理器是很好的实践（针对pyodbc，我见过一些仅关闭游标的示例）。我正在开发一个Python应用程序，从SQL Server拉取数据并导入到Pandas DataFrame中。

我用contextlib编写了连接脚本：

import pyodbc
import contextlib

@contextlib.contextmanager
def open_db_connection(server, database):
    """
    Context manager to automatically close DB connection. 
    """
    conn = pyodbc.connect('DRIVER={SQL Server};SERVER='+server+';DATABASE='+database+';Trusted_Connection=yes;')
    try:
        yield
    except pyodbc.Error as e:
        print(e)
    finally:
        conn.close()

调用时：

from sql_server_connection import open_db_connection
with open_db_connection(server, database) as conn:
    df = pd.read_sql_query(query_string, conn)

触发错误：

File "C:\ProgramData\Anaconda3\lib\site-packages\pandas\io\sql.py", line 436, in read_sql_query
    return pandas_sql.read_query(
  File "C:\ProgramData\Anaconda3\lib\site-packages\pandas\io\sql.py", line 2116, in read_query
    cursor = self.execute(*args)
  File "C:\ProgramData\Anaconda3\lib\site-packages\pandas\io\sql.py", line 2054, in execute
    cur = self.con.cursor()
AttributeError: 'NoneType' object has no attribute 'cursor'

我没定义游标，因为期望Pandas自动处理。想知道这个方法错在哪里，该如何正确关闭连接，或者pyodbc会自动处理吗？

问题原因与解决方法 #

错误根源 #

你的上下文管理器没有返回连接对象——yield语句后没有传递conn实例，导致with...as conn中的conn变量是None，Pandas调用cursor()方法时自然触发AttributeError。

修正后的自定义上下文管理器 #

修改yield语句，将创建好的连接对象返回：

import pyodbc
import contextlib

@contextlib.contextmanager
def open_db_connection(server, database):
    """
    Context manager to automatically close DB connection. 
    """
    # 改用f-string格式化连接字符串，避免拼接错误
    conn_str = f'DRIVER={{SQL Server}};SERVER={server};DATABASE={database};Trusted_Connection=yes;'
    conn = pyodbc.connect(conn_str)
    try:
        yield conn  # 返回连接对象供外部使用
    except pyodbc.Error as e:
        print(f"数据库错误: {e}")
        raise  # 重新抛出异常，让上层逻辑处理错误，避免静默失败
    finally:
        conn.close()

更简洁的替代方案：直接使用pyodbc内置上下文管理器 #

pyodbc的Connection对象本身已经实现了上下文管理器接口，无需手动编写，直接使用即可：

import pyodbc
import pandas as pd

conn_str = f'DRIVER={{SQL Server}};SERVER={server};DATABASE={database};Trusted_Connection=yes;'
with pyodbc.connect(conn_str) as conn:
    df = pd.read_sql_query(query_string, conn)
# 离开with代码块后，连接会自动关闭

补充说明 #

• Pandas的read_sql_query会自动创建并关闭游标，你不需要手动处理游标生命周期。
• 无论使用自定义还是内置上下文管理器，核心都是确保连接在使用完毕后被自动关闭，避免资源泄漏。

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