Djangoの設定ファイルの基本を理解したい【株式会社ライトコード】

概要

Djangoのsettings.pyを毎回調べながら使っているので、もう少し仲良くなるためにドキュメントを読み直してみます。

ゴール

Djangoがデフォルトで生成する設定ファイル「settings.py」を読み解き、よく使う設定値がいつ・どこで・どのように参照されるのか
概要を復習することを目指します。

構成

settings.pyの中身を最初に見ておき、ブロック単位に何が書かれているか見ていきます。
すべて触れると長くなってしまうので、よく使うものに絞っておきます。

環境

Django: 5.2.8

settings.py

まずはデフォルト設定から、概観を掴んでおきます。

"""

Django settings for config project.



Generated by 'django-admin startproject' using Django 5.2.8.



For more information on this file, see

https://docs.djangoproject.com/en/5.2/topics/settings/



For the full list of settings and their values, see

https://docs.djangoproject.com/en/5.2/ref/settings/

"""



from pathlib import Path



# Build paths inside the project like this: BASE_DIR / 'subdir'.

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





# Quick-start development settings - unsuitable for production

# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/



# SECURITY WARNING: keep the secret key used in production secret!

SECRET_KEY = 'django-insecure-zip##yovun391-2h05iwc=tx7z$w!al^n-l2#xlw%t8%kr-d#_'



# SECURITY WARNING: don't run with debug turned on in production!

DEBUG = True



ALLOWED_HOSTS = []





# Application definition



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 = 'config.urls'



TEMPLATES = [

    {

        'BACKEND': 'django.template.backends.django.DjangoTemplates',

        'DIRS': [],

        'APP_DIRS': True,

        'OPTIONS': {

            'context_processors': [

                'django.template.context_processors.request',

                'django.contrib.auth.context_processors.auth',

                'django.contrib.messages.context_processors.messages',

            ],

        },

    },

]



WSGI_APPLICATION = 'config.wsgi.application'





# Database

# https://docs.djangoproject.com/en/5.2/ref/settings/#databases



DATABASES = {

    'default': {

        'ENGINE': 'django.db.backends.sqlite3',

        'NAME': BASE_DIR / 'db.sqlite3',

    }

}





# Password validation

# https://docs.djangoproject.com/en/5.2/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.2/topics/i18n/



LANGUAGE_CODE = 'en-us'



TIME_ZONE = 'UTC'



USE_I18N = True



USE_TZ = True





# Static files (CSS, JavaScript, Images)

# https://docs.djangoproject.com/en/5.2/howto/static-files/



STATIC_URL = 'static/'



# Default primary key field type

# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field



DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

ベース

BASE_DIR

from pathlib import Path



# settings.pyのparent.parentなので、settings.pyの親ディレクトリ。つまりプロジェクトディレクトリがBASE_DIRとなる

# Build paths inside the project like this: BASE_DIR / 'subdir'.

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

Djangoプロジェクトの基準となるディレクトリを指します。

SECRET_KEY

When you create a new Django project using startproject, the settings.py file is generated automatically and gets a random SECRET_KEY value. This value is the key to securing signed data

SECRETKEYは、署名済みデータのキーとなる値です。
例えば、SECRETKEYがあることで、パスワードリセットURLがDjango側で発行されたものである。つまり不正に書き換えられていない正規のものであることを保証できるようです。

もしSECRET_KEYが漏洩すると、攻撃者に書き換えられた値もDjangoで安全なデータと扱われてしまうので、秘密の値として秘匿する必要があります。

参考

ALLOWED_HOSTS

Djangoアプリケーションを配信できるホスト名を配列形式で格納します。

ホスト名を限定することで、HTTPヘッダインジェクション攻撃を防げるようにしています。

…