Posted in Django

[Django] settings.py　基本設定の方法について

   Published Date: 2024年2月3日

Djangoのsettings.pyの内容の確認です。プロジェクトディレクトリのsettings.pyで主要な設定を行います。

BASE / SECURITY / HOST

import os

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = 'i(41d#kk(%^sjq4&cx(b&a4brf-m220)p9b3a9iof$r4c%a)om'

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

ALLOWED_HOSTS = []

BASE_DIR

「BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))」

__file__　は現在実行中のファイル名を取得するという意味です。settings.pyを読み込んでいます。

os.pathモジュールはパス・ファイル名などを操作するモジュールです。

os.path.abspathは絶対パスを返す。os.path.dirnameは引数に指定したパスの上の階層までのパスを返します。Pythonの流れでパスの操作は「os.path」と「pathlib」の２つがあり、新しいpathlibになっています。DjangoもPathlibの流れがあるので注意が必要です。

BASE_DIR =　がpathlib になっている場合はSTATIC_ROOTも「STATIC_ROOT = BASE_DIR / ‘static’」という記載にしたほうが良いです。

SECRET_KEY

暗号化（ハッシュ）で使われる秘密キーの指定でプロジェクトごとにことなる値が設定されます。

DEBUG

True / False　の値を設定できます。デバック機能の有効・無効が切り替わります。

デフォルトはTrueです。開発時はTrue、公開運用時はFalseにします。

ALLOWED_HOSTS

デフォルトは空です。本番運用時には値の設定が必須です。

Application definition

INSTALLED_APPS

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

Djangoはアプリケーション単位で管理する仕様になっています。新しくアプリケーションを追加したらここに追加します。上記には管理画面・認証・セッションなどが記載されています。

MIDDLEWARE

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

ここではミドルウエアの登録を行います。ミドルウエアは一般的にOSとアプリケーションの間に入って様々な機能を提供するソフトウェアを意味します。Djangoでのミドルウェアの認識はプログラムのある部分に処理を追加・実行するもので良いと思います。

上記の設定を見ると、セキュリティ、セッション、認証などのミドルウェアが登録されているのがわかります。

追加でミドルウェアを使う場合は　MIDDLEWARE = []　に登録します。ここに登録しないと動きません。ミドルウェアは自分でも作成することができます。

Root_URLCONF / TEMPLATES

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

ROOT_URLCONFにはルートのurls.pyが設定されています。プロジェクトを作るときにプロジェクト名をconfigにしたのでルートは config.urlsになっています。

Djangoでは config.urlsに各アプリの urls.pyを登録するようになっています。

TEMPLATES

プロジェクトのテンプレートを登録します。デフォルトではdebug , request , auth , messages が登録されています。

DIRS　→テンプレートを設置するフォルダを登録　　

　　　　例）[BASE_DIR / ‘templates’]　プロジェクトルートのtemplatesフォルダを指定

APP_DIRS　→　アプリケーションフォルダ配下を探すかどうかの設定

OPTIONS　→　オプションの設定

Database

Djangoで使用するデータベースの設定です。DefaultではSQLite3になっています。

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

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}

MySQLの接続設定

上記データベースの設定を下記に変更します。　__init__.py　にも追記が必要です。

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'database_name',
        'USER': 'root',
        'PASSWORD': 'password',
        'HOST': 'localhost',
        'PORT': '3306',
    }
}
# __init__.pyに下記を追記

import pymysql
pymysql.install_as_MySQLdb()
[Django] DBにMySQLを使う方法

AUTH_PASSWORD_VALIDATORS

# Password validation
# https://docs.djangoproject.com/en/3.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

# Internationalization
# https://docs.djangoproject.com/en/3.0/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True

言語やタイムゾーンを設定します。デフォルトは英語、タイムゾーンはUTCです。日本で使用する場合は下記の設定が良いでしょう。

LANGUAGE_CODE = 'ja'
TIME_ZONE = 'Asia/Tokyo'

Static files (CSS, JavaScript, Images)

Javascript , Css , Image などの静的ファイルを保存する場所です。

# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/3.0/howto/static-files/

STATIC_URL = '/static/'


Author: webmaster