Docker Compose调试Django项目时Constance包报KeyError求助

问题场景 #

在使用Docker Compose通过容器调试Django项目时，遇到以下KeyError错误，且无法在网络上找到AUTO_END_TIMEDELTA_MINS的相关信息：

Traceback (most recent call last):
2023-08-21T18:03:17.443221106Z File "/usr/local/lib/python3.8/site-packages/constance/base.py", line 14, in getattr
2023-08-21T18:03:17.443224978Z if not len(settings.CONFIG[key]) in (2, 3):
2023-08-21T18:03:17.443227740Z KeyError: 'AUTO_END_TIMEDELTA_MINS'

项目settings.py的关键配置片段：

# 第三方应用已包含Constance
THIRD_PARTY_APPS = [
    "constance",
    "simple_history",
    "debug_toolbar",
    "django_tables2",
    "widget_tweaks",
    "constance.backends.database",
    "cacheops",
]

# 未配置CONSTANCE_CONFIG相关内容

问题根源 #

这个错误来自Django Constance（动态配置管理工具）：代码中尝试读取AUTO_END_TIMEDELTA_MINS这个动态配置项，但项目的Django设置里既没在CONSTANCE_CONFIG中定义该键，也没在Constance的数据库后端初始化这个配置。

解决方案 #

1. 在settings.py中补充Constance配置 #

在settings.py末尾添加CONSTANCE_CONFIG配置块，定义AUTO_END_TIMEDELTA_MINS项。格式为键名对应元组，包含默认值、配置描述，可选指定字段类型：

# Constance 动态配置项
CONSTANCE_CONFIG = {
    'AUTO_END_TIMEDELTA_MINS': (30, '自动结束任务的时间间隔（分钟）', int),
    # 其他需要的Constance配置项可在此添加
}

# 指定使用数据库存储后端（你已安装对应依赖）
CONSTANCE_BACKEND = 'constance.backends.database.DatabaseBackend'

根据实际业务需求调整默认值和描述文本。

2. 容器内执行数据库迁移 #

因为使用了Constance的数据库后端，添加配置后需在Docker容器内执行迁移，确保Constance的配置表被正确初始化：

# 进入Django服务容器（替换为你的服务名）
docker-compose exec web bash
# 执行迁移命令
python manage.py migrate

3. 检查配置引用与依赖 #

• 确认项目中哪里调用了该配置：通常是通过from constance import config后使用config.AUTO_END_TIMEDELTA_MINS，如果是第三方库引用，需确认是否遗漏了依赖配置。
• 如果该配置原本应从环境变量或其他配置文件（如constants.py/env.py）导入，检查：
  • Docker Compose的environment块是否正确设置了对应环境变量
  • settings.py是否正确导入了包含该配置的模块

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