【settings.py】Django の設定ファイルのベストプラクティス

2024年5月30日2024年7月15日

settings.pyのベストプラクティスが知りたい！

このような疑問にお答えします。

Django のsettings.pyは様々な内容が混在していて、さらに開発環境と本番環境で設定を切り替える必要があったりで煩雑になりがちですよね。

設定ファイル内で条件分岐させて環境ごとに設定を切り替えることもできますが、これだと可読性が落ちたりメンテナンスがしにくくなります。

そこで、それらの問題を解決するためのベストプラクティス的な設定ファイルの書き方をご紹介します。

僕が個人開発で行なっている書き方になりますので、ぜひ一つの参考にしていただければと思います。

Contents

【Django】設定ファイルのベストプラクティス

【Django】設定ファイルのベストプラクティス

次のようにsettingsディレクトリを作成します。

project_root/
├── core/
│   ├── __init__.py
│   ├── settings
│   │   ├── __init__.py
│   │   ├── base.py
│   │   ├── development.py
│   │   └── production.py
│   └── ...
├── myapp/
│   ├── __init__.py
│   └── ...
└── manage.py

配下には、すべての環境で共通の設定を書き込んだbase.py、開発環境の設定を書き込んだdevelopment.py、本番環境の設定を書き込んだproduction.pyを用意する形です。

また__init__.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になります。

この環境変数をキーワードとして本番環境ならproduction.pyを、開発環境ならdevelopment.pyを採用するように条件分岐を行いました。

`base.py`

本番環境、開発環境を問わず共通の設定をbase.pyに書きます。

from pathlib import Path

SECRET_KEY = ""

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

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
]

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"

# Database
# https://docs.djangoproject.com/en/5.0/ref/settings/#databases
DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.sqlite3",
        "NAME": BASE_DIR / "db.sqlite3",
    }
}


# 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として指定するPATHオブジェクトには.parentを3つ必要なことに注意しましょう。settingsディレクトリとして一つ深い階層に設定ファイルがあるためです。

`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に切り替えるなどをして、本番用の設定を行いましょう。