Django项目中如何将外部SQL文件导入Python代码？

当然有靠谱的实现方式，而且直接读取外部.sql文件其实比把它改成.py文件更合理——尤其是当SQL代码量较大时，这种方式能让你用专业的SQL编辑器编写维护代码，还能避免字符串转义的麻烦。

1. 直接读取外部SQL文件（推荐） #

你可以用Python的文件读取功能，直接把.sql文件的内容读入Python字符串中。为了路径的可靠性，建议结合Django的BASE_DIR来构建文件路径，避免因项目结构变化导致路径错误。

具体实现代码（code.py） #

from django.conf import settings
import os

# 构建SQL文件的绝对路径，这里假设example.sql放在项目根目录下
# 如果你的SQL文件在其他目录，比如project/app/sql/example.sql，就调整路径拼接
sql_file_path = os.path.join(settings.BASE_DIR, 'example.sql')

# 读取SQL文件内容
with open(sql_file_path, 'r', encoding='utf-8') as sql_file:
    raw_sql = sql_file.read().strip()  # strip()去除首尾的空白、换行符，避免执行时出现问题

user_ids = RowSqlManager(raw_sql).execute()

注意事项 #

• 路径配置：如果SQL文件放在app的子目录中（比如myapp/sql/），可以用os.path.join(settings.BASE_DIR, 'myapp', 'sql', 'example.sql')来构建路径。
• 编码问题：指定encoding='utf-8'可以避免中文或特殊字符出现乱码。
• SQL格式：确保.sql文件里的SQL语句不需要额外转义（比如不需要处理Python字符串的引号冲突），因为直接读取的是原始内容。

2. 对比：将.sql改为.py文件的方式 #

如果把example.sql改成example.py，然后在里面定义字符串变量：

# example.py
raw_sql = "SELECT id FROM users_user"

再在code.py里导入：

from .example import raw_sql

user_ids = RowSqlManager(raw_sql).execute()

这种方式虽然简单，但只适合SQL代码非常短的场景：

• 缺点1：当SQL内容复杂（包含多行、引号、注释）时，你需要手动转义字符串里的引号，或者用三引号包裹，编辑起来很麻烦。
• 缺点2：没有SQL语法高亮，用Python编辑器写SQL体验很差，容易出错。
• 缺点3：SQL文件失去了独立性，无法直接用数据库工具（比如Navicat、DBeaver）打开测试。

总结 #

优先选择直接读取外部SQL文件的方案，它既保持了SQL代码的专业性和可维护性，又能在Django代码中方便调用，完全没必要把.sql改成.py文件。

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