- settings.pyのベストプラクティスが知りたい！
このような疑問にお答えします。
Django のsettings.pyは内容盛りだくさんで、どんな構成で組むのがベストか迷いがちですよね。
色々な考え方があるとは思いますが、僕が個人開発でやっている書き方をご紹介します。
ぜひ参考にしてみてください。
Contents
【Django】settings.pyの僕的ベストプラクティスをご紹介
最初は細かい解説は抜きにして、結論からお伝えします。
settingsディレクトリの構成
僕はsettingsディレクトリを作って、その配下は以下のようにしています。
project_root/
├── core/
│ ├── __init__.py
│ ├── settings
│ │ ├── __init__.py
│ │ ├── base.py
│ │ ├── development.py
│ │ └── production.py
│ └── ...
├── myapp/
│ ├── __init__.py
│ └── ...
└── manage.pysettings配下にあるモジュールは、それぞれ以下のような使い分けです。
| モジュール名 | 役割 |
|---|---|
| __init__.py | 本番・開発環境ごとに参照するモジュールを条件分岐しておく |
| base.py | 本番・開発環境で共通の設定 |
| production.py | 本番環境用の設定 |
| development.py | 開発環境用の設定 |
このように役割ごとに分割しておくことで、メンテナンス性が向上します。
__init__.py
Django がディレクトリを認識するために必要なのが__init__.pyです。
内容に何も書かずに空のファイルを配置することもありますが、今回は本番環境と開発環境で異なるモジュールを読み込むロジックを描きました。
import os
from .base import *
environment = os.getenv("DJANGO_ENV", "development")
if environment == "production":
from .production import *
else:
from .development import *本番環境で環境変数DJANGO_ENVをproductionとしておくことで、どちらの設定ファイルを読み込むかを指定するように組んであります。
DJANGO_ENV=="production"の場合production.pyを採用
DJANGO_ENV=="production"以外の場合development.pyを採用
この設定を有効にするには、本番環境の環境変数としてDJANGO_ENV=productionを設定します。
base.py
本番環境、開発環境を問わず共通の設定をbase.pyに書きます。
from pathlib import Path
SECRET_KEY = ""
BASE_DIR = Path(__file__).resolve().parent.parent.parent
# アプリは標準アプリ、3rdParty、自作アプリに分ける
DJANGO_APPS = [
"django.contrib.admin",
"django.contrib.auth",
"django.contrib.contenttypes",
"django.contrib.sessions",
"django.contrib.messages",
"django.contrib.staticfiles",
]
THIRD_PARTY_APPS = [
"rest_framework",
]
LOCAL_APPS = [
"myapp",
]
INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS
MIDDLEWARE = [
"django.middleware.security.SecurityMiddleware",
"django.contrib.sessions.middleware.SessionMiddleware",
"django.middleware.common.CommonMiddleware",
"django.middleware.csrf.CsrfViewMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware",
"django.contrib.messages.middleware.MessageMiddleware",
"django.middleware.clickjacking.XFrameOptionsMiddleware",
]
ROOT_URLCONF = "core.urls"
TEMPLATES = [
{
"BACKEND": "django.template.backends.django.DjangoTemplates",
"DIRS": [],
"APP_DIRS": True,
"OPTIONS": {
"context_processors": [
"django.template.context_processors.debug",
"django.template.context_processors.request",
"django.contrib.auth.context_processors.auth",
"django.contrib.messages.context_processors.messages",
],
},
},
]
WSGI_APPLICATION = "core.wsgi.application"
# Password validation
# https://docs.djangoproject.com/en/5.0/ref/settings/#auth-password-validators
AUTH_PASSWORD_VALIDATORS = [
{
"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
},
{
"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
},
{
"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
},
{
"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
},
]
# Internationalization
# https://docs.djangoproject.com/en/5.0/topics/i18n/
LANGUAGE_CODE = "ja"
TIME_ZONE = "Asia/Tokyo"
USE_I18N = True
USE_TZ = True
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/5.0/howto/static-files/
STATIC_URL = "static/"
# Default primary key field type
# https://docs.djangoproject.com/en/5.0/ref/settings/#default-auto-field
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"BASE_DIRでは.parentを3つ書きます。
settingsディレクトリを作った分、settingsのディレクトリが1階層深くなったためです。
development.py
ここでは開発環境特有の設定を書き込んでいきます。
from .base import BASE_DIR
DEBUG = True
ALLOWED_HOSTS = []
DATABASES = {
"default": {
"ENGINE": "django.db.backends.sqlite3",
"NAME": BASE_DIR / "db.sqlite3",
}
}開発用データベースを設定し、デバックモードをTrueにします。
production.py
こちらでは本番環境特有の設定を書き込みます。
SECRET_KEY = ""
DEBUG = False
ALLOWED_HOSTS = ["your-production-domain.com"]
DATABASES = {
"default": {
"ENGINE": "django.db.backends.postgresql",
"NAME": "your_production_db",
"USER": "your_db_user",
"PASSWORD": "your_db_password",
"HOST": "your_db_host",
"PORT": "your_db_port",
}
}
# Security settings
SECURE_SSL_REDIRECT = True
CSRF_COOKIE_SECURE = True
SESSION_COOKIE_SECURE = True本番用データベースの設定、ホスト名の設定、デバックモードをFalseに切り替えるなどをします。
本番用の設定を行いましょう。
まとめ
僕のベストプラクティスは以下の通りです。
- settingsディレクトリを用意
- 役割ごとにモジュールを分ける
- __init__.pyで環境ごとに参照するモジュールを分岐
このようにすることで環境ごとに管理が簡単になり、メンテナンス性が向上するはずです。
ぜひ、開発の参考にしてみてください。
コメント