Python csv.writer写入数据库结果引号问题解决

理解 csv.writer 的行为

csv 模块是 Python 标准库中用于处理 CSV（Comma Separated Values）文件的强大工具。csv.writer 对象提供了 writerow() 和 writerows() 方法，分别用于写入单行和多行数据。通常，writerows() 方法期望接收一个可迭代对象，其中每个元素代表一行数据，而每行数据本身又是一个可迭代对象（如列表或元组），其内部元素代表该行的各个字段。

例如，如果我们有以下数据：

data = [
    ['item1', 'item2', 'item3'],
    ['item4', 'item5', 'item6']
]

使用 csv.writer 写入时，会得到期望的 CSV 格式：

item1,item2,item3
item4,item5,item6

问题分析：数据结构与意外引用

然而，当数据来源于某些数据库查询（例如使用 cursor.fetchall()）时，返回的 result_set 可能具有一种特殊的结构，导致 csv.writer 产生非预期的引用。具体来说，如果数据库的查询结果集中的每一行被封装成一个只包含一个元素的元组，而这个元素本身是一个已经包含逗号分隔值的字符串，例如：

# 模拟从数据库获取的 result_set
result_set = [
    ('item1,item2,item3',),
    ('item4,item5,item6',)
]

在这种情况下，csv.writer 在处理 ('item1,item2,item3',) 这一行时，会将其识别为一个只包含一个字段的行。由于这个字段 ('item1,item2,item3') 内部包含了 CSV 分隔符（逗号），根据 csv 模块的默认引用规则 (QUOTE_MINIMAL)，它会将整个字段用引号括起来，从而导致输出变为：

"item1,item2,item3"
"item4,item5,item6"

这与我们期望的 item1,item2,item3 格式不符。

解决方案：预处理数据

解决此问题的关键在于，在将数据传递给 csv.writer 之前，对其进行适当的预处理，使其符合 writerows() 期望的“每行是字段列表”的结构。由于原始数据中每个元组只包含一个字符串元素，我们可以通过解包该元组并使用字符串的 split(',') 方法将该字符串拆分成多个字段。

以下是具体的实现代码：

import csv
import os

def write_data_to_csv(filename, result_set):
    """
    将预处理后的数据写入CSV文件。

    Args:
        filename (str): 要写入的CSV文件路径。
        result_set (list): 从数据库查询得到的原始结果集，
                           例如：[('item1,item2,item3',), ('item4,item5,item6',)]
    """
    try:
        # 使用 'w' 模式清空并写入，如果希望追加，请使用 'a'
        with open(filename, 'w', newline='', encoding='utf-8') as csvfile:
            datafile = csv.writer(csvfile)

            # 预处理数据：
            # 对于result_set中的每个元组(col,)，解包出col，然后用split(',')将其拆分为字段列表。
            # 使用生成器表达式以提高内存效率。
            processed_rows = (col.split(",") for (col,) in result_set)

            # 将处理后的行写入CSV文件
            datafile.writerows(processed_rows)
        print(f"数据已成功写入到 {filename}")
    except IOError as e:
        print(f"写入文件时发生错误: {e}")

# 示例数据（模拟从数据库获取）
mock_result_set = [
    ('apple,banana,cherry',),
    ('date,elderberry,fig',),
    ('grape,honeydew,kiwi',)
]

# 定义输出文件名
output_filename = 'output_correct.csv'

# 调用函数写入数据
write_data_to_csv(output_filename, mock_result_set)

# 验证输出内容 (可选)
print("\n--- 验证输出文件内容 ---")
if os.path.exists(output_filename):
    with open(output_filename, 'r', encoding='utf-8') as f:
        print(f.read())
else:
    print("文件未生成或路径错误。")

# 错误示例（不进行预处理）
print("\n--- 错误示例输出 ---")
error_output_filename = 'output_quoted.csv'
try:
    with open(error_output_filename, 'w', newline='', encoding='utf-8') as csvfile:
        datafile = csv.writer(csvfile)
        datafile.writerows(mock_result_set) # 直接写入未处理的数据
    print(f"错误示例数据已写入到 {error_output_filename}")
except IOError as e:
    print(f"写入文件时发生错误: {e}")

print("\n--- 错误示例文件内容 ---")
if os.path.exists(error_output_filename):
    with open(error_output_filename, 'r', encoding='utf-8') as f:
        print(f.read())

代码解析：

1. for (col,) in result_set: 这是一个关键的元组解包操作。由于 result_set 中的每个元素都是一个单元素元组（例如 ('item1,item2,item3',)），(col,) 语法可以将其内部的字符串直接解包到 col 变量中。
2. col.split(","): 对解包出的字符串 col 使用 split(",") 方法，将其按逗号分隔成一个字符串列表。例如，'item1,item2,item3' 会变成 ['item1', 'item2', 'item3']。
3. ( ... for ... in ... ): 这是一个生成器表达式，它会逐个生成处理后的行，而不是一次性在内存中构建整个列表。这对于处理大量数据时非常高效。
4. datafile.writerows(processed_rows): 将生成器表达式产生的正确格式的行数据传递给 writerows() 方法，确保每个字段都被正确识别并写入，而不会被额外引用。

注意事项

• 数据源的结构： 在处理来自数据库或其他外部源的数据时，务必首先检查其返回的数据结构。使用 print(result_set) 或 print(result_set[0]) 可以帮助你理解数据的实际形态。
• newline='' 参数： 在 open() 函数中使用 newline='' 是写入 CSV 文件的最佳实践。这可以防止在某些操作系统上出现额外的空行。
• 编码： 始终明确指定文件编码，例如 encoding='utf-8'，以避免字符编码问题。
• csv.writer 的 quoting 参数： csv.writer 默认的 quoting 行为是 csv.QUOTE_MINIMAL，这意味着只有当字段包含分隔符、引用字符或换行符时才会被引用。如果你的数据本身就包含逗号，但你不希望它们被引用，那么你需要重新考虑你的 CSV 格式设计，或者将 quoting 参数设置为 csv.QUOTE_NONE（但这可能会导致数据损坏，如果字段内容本身包含分隔符）。
• 错误处理： 在实际应用中，应加入适当的错误处理机制，例如 try-except 块来捕获文件操作可能出现的异常。

总结

当使用 csv.writer 将数据库查询结果写入 CSV 文件时，意外的引号通常是由于源数据结构不符合 writerows() 期望的“每行是字段列表”格式所致。通过在写入前对数据进行预处理，特别是利用元组解包和字符串 split() 方法将单字符串字段转换为多字段列表，可以有效地解决这一问题。理解数据源的实际结构是解决此类问题的关键，并能帮助你更好地利用 csv 模块的强大功能。