如何在版本控制中妥善管理Django的settings.py文件？

针对你的问题，核心思路是分离通用配置与敏感/环境专属配置，既保留可复用的技术细节在版本控制中，又把敏感内容排除在外。下面是两种常用的落地方案，附具体示例：

方案1：拆分Settings目录（适合配置复杂的项目） #

把配置拆分为通用基础配置、环境配置和本地敏感配置，同时提供配置模板供开发者快速复用。

项目结构调整 #

your_project/
├── your_project/
│   ├── settings/
│   │   ├── __init__.py
│   │   ├── base.py       # 通用配置（纳入版本控制）
│   │   ├── local.py      # 敏感/本地配置（不纳入版本控制）
│   │   ├── local.example.py  # 配置模板（纳入版本控制）
│   │   ├── development.py    # 开发环境专属配置（可选，纳入版本控制）
│   │   └── production.py     # 生产环境专属配置（可选，纳入版本控制）
└── .gitignore

具体配置示例 #

1. base.py：存放所有通用配置，比如INSTALLED_APPS、MIDDLEWARE、BASE_DIR等：

# base.py
import os
from pathlib import Path

BASE_DIR = Path(__file__).resolve().parent.parent.parent

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    # ... 其他通用APP
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    # ... 其他通用中间件
]

# 通用配置结束后，导入本地敏感配置
try:
    from .local import *
except ImportError:
    raise Exception("请复制 settings/local.example.py 为 local.py 并填写实际配置值")

2. local.example.py：作为配置模板，保留所有敏感/环境专属配置的键，值用占位符标注：

# local.example.py - 复制为local.py后修改实际值
SECRET_KEY = '请替换为你的实际密钥'
DEBUG = True

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': '你的数据库名',
        'USER': '数据库用户名',
        'PASSWORD': '数据库密码',
        'HOST': 'localhost',
        'PORT': '3306',
    }
}

# 环境专属配置示例
LOGIN_REDIRECT_URL = '/dashboard/'
EMAIL_HOST_USER = '你的邮箱账号'
EMAIL_HOST_PASSWORD = '邮箱授权码'

3. .gitignore 添加排除规则：

your_project/settings/local.py

开发者部署时，只需要复制local.example.py为local.py，替换占位符即可快速完成配置，无需从头编写整个settings文件。

方案2：使用环境变量（适合云部署/CI/CD场景） #

通过环境变量存储敏感信息，settings.py直接读取环境变量，同时提供环境变量模板文件。

具体配置示例 #

1. settings.py：保留通用配置，敏感信息从环境变量读取（可借助python-dotenv库加载本地.env文件）：

# settings.py
import os
from pathlib import Path
from dotenv import load_dotenv

BASE_DIR = Path(__file__).resolve().parent.parent

# 加载本地.env文件（仅开发环境生效，生产环境直接用服务器环境变量）
load_dotenv(os.path.join(BASE_DIR, '.env'))

# 通用配置
INSTALLED_APPS = [
    'django.contrib.admin',
    # ... 其他通用APP
]

# 敏感/环境配置从环境变量读取
SECRET_KEY = os.environ.get('DJANGO_SECRET_KEY')
DEBUG = os.environ.get('DJANGO_DEBUG', 'False') == 'True'

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': os.environ.get('DJANGO_DB_NAME'),
        'USER': os.environ.get('DJANGO_DB_USER'),
        'PASSWORD': os.environ.get('DJANGO_DB_PASSWORD'),
        'HOST': os.environ.get('DJANGO_DB_HOST', 'localhost'),
        'PORT': os.environ.get('DJANGO_DB_PORT', '5432'),
    }
}

LOGIN_REDIRECT_URL = os.environ.get('DJANGO_LOGIN_REDIRECT_URL', '/')

2. .env.example：作为环境变量模板，提交到版本控制：

# .env.example - 复制为.env并修改实际值
DJANGO_SECRET_KEY=请替换为你的实际密钥
DJANGO_DEBUG=True
DJANGO_DB_NAME=你的数据库名
DJANGO_DB_USER=数据库用户名
DJANGO_DB_PASSWORD=数据库密码
DJANGO_LOGIN_REDIRECT_URL=/dashboard/

3. .gitignore 添加排除规则：

.env

开发者部署时，复制.env.example为.env，替换占位符即可；生产环境可直接在服务器设置环境变量，无需本地.env文件。

内容的提问来源于stack exchange，提问作者Erel Segal-Halevi