🖱️

Djangoのsettings.py

2024/03/25に公開

django

Python

env

tech

この記事は前回の続きの記事です。
前回の記事はこちら。

前提

settings.pyを編集する

前回の記事では、すでにトップ画面が日本語表示になっていましたが、このような設定のほか、プロジェクトの設定に必要な設定をしていきます。

環境変数を読み込む

今回は、データベースにPostgresQLを使用します。
データベースの設定については、環境変数を使用しますので、この環境変数を読み込むための設定をしていきます。
まずは、compose.ymlに追記します。

compose.yml

services:
  backend:
    container_name: backend
    build:
      context: ./backend
      dockerfile: Dockerfile
    volumes:
      - ./backend/:/backend/
      - static:/backend/static_root
      - media:/backend/media
    command: >
      bash -c "python manage.py migrate
      && python manage.py runserver 0.0.0.0:8000"
+   env_file:
+     - .env
    tty: true
    environment:
      TZ: Asia/Tokyo
    ports:
      - 8000:8000
+   depends_on:
+     - db
    
+ db:
+   container_name: backend_db
+   image: postgres:latest
+   environment:
+     POSTGRES_DB: postgres
+     POSTGRES_USER: postgres
+     POSTGRES_PASSWORD: postgres
+     TZ: Asia/Tokyo
+     PGTZ: Asia/Tokyo

volumes:
  static:
  media:
  postgres:

backendコンテナの中で「env_file」を設定しています。
この後作成する「.env」ファイルはこのディレクトリに配置します（今回はcompose.ymlと同じ階層に配置）。

また、ついでにデータベースの設定も追記しています。

.envファイルの作成と環境変数

上述のとおり、compose.ymlと同じディレクトリに.envファイルを作成します。
作成した.envファイルには、以下のように記述しています。

.env

SECRET_KEY=あなたのDjangoプロジェクトのSECRET_KEY
NAME=postgres
USER=postgres
PASSWORD=postgres
HOST=db
PORT=5432

settings.pyで環境変数を読み込む

Djangoプロジェクトのsettings.pyで設定した環境変数を読み込みます。
コード全文は以下のとおりです（コメント部分は今回の記事に必要な箇所以外は消しています）。

backend/project/settings.py

+import os
from pathlib import Path
+from dotenv import load_dotenv # add

+load_dotenv()

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

+SECRET_KEY = os.environ['SECRET_KEY']

DEBUG = True

# change(開発環境のため全てを許可)
+ALLOWED_HOSTS = ['*']

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',
]

# add
+CORS_ORIGIN_WHITELIST = [
+    "http://localhost:3000"
+]

ROOT_URLCONF = 'project.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 = 'project.wsgi.application'

# メモとしてコメントアウトしている
-# DATABASES = {
-#     'default': {
-#         'ENGINE': 'django.db.backends.sqlite3',
-#         'NAME': BASE_DIR / 'db.sqlite3',
-#     }
-# }

# change
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': os.environ['NAME'],
+        'USER': os.environ['USER'],
+        'PASSWORD': os.environ['PASSWORD'],
+        'HOST': os.environ['HOST'], 
+        'PORT': os.environ['PORT'],
+    }
+}

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',
    },
]

+LANGUAGE_CODE = 'ja'

+TIME_ZONE = 'Asia/Tokyo'

USE_I18N = True

USE_TZ = True

STATIC_URL = 'static/'
+STATIC_ROOT = BASE_DIR / 'static_root' # add

# add
+MEDIA_URL = '/media/'
+MEDIA_ROOT = BASE_DIR / 'media'

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

# add
+CSRF_TRUSTED_ORIGINS = ["http://localhost", "http://127.0.0.1"]

※この他にも「os.getenv()」や「os.environ.get()」のような方法で環境変数を読み込むことは可能ですが、個人的には存在しないキーを使用した場合にエラーを出してくれる上記の方法が好みです。
どれを使用するかは設定の時に個人で検討することになります。
また、環境変数の読み込み方法の違いについては、以下の記事にまとまっていましたので、参考にしました。

以上が、Djangoで設定するsettings.pyの個人的に必要な設定だと考えています。