장고 튜토리얼) settings.py 분리하기

(06.15) 수정됨.

settings.py를 분리하는 이유

필요성을 느끼지 않는다면 settings.py를 분리할 필요는 없다.

내 경우에는 장고 프로젝트의 설정을 분리할 때마다 긴 코드를 한줄한줄 들여다보는 것이 번거롭기 때문에 분리해서 사용한다.

트리 구조 전후비교

settings.py 분리 전 트리 구조는 다음과 같다.

...
|- manage.py
|- db.sqlite3
|- config
    |- __init__.py
    |- asgi.py
    |- settings.py
    |- urls.py
    |- wsgi.py

분리 후에는 다음과 같이 변경된다.

...
|- manage.py
|- db.sqlite3
|- config
    |- __init__.py
    |- asgi.py
    |- urls.py
    |- wsgi.py
    |- settings
        |- __init__.py
        |- local
            |- __init__.py
            |- apps.py
            |- auth.py
            |- base.py
            |- databases.py
            |- middlewares.py
            |- templates.py

base.py

기초적인 설정 정보를 저장한다.

LANGUAGE_CODE와 TIME_ZONE을 대한민국 기준으로 변경한다.

SECRET_KEY는 본래 외부에 노출하면 안되지만, 테스트용 프로젝트이므로 그대로 뒀다.

from pathlib import Path

# manage.py가 위치한 폴더 경로가 되어야 함
BASE_DIR = Path(__file__).resolve().parent.parent.parent.parent

# 본래는 외부에 노출하면 안됨
SECRET_KEY = 'django-insecure-ev1g6&rd@(r&y62ye8*tvg@s&&ce)4i&w)m^!ua062u*lq2%m8'

DEBUG = True

ALLOWED_HOSTS = []

WSGI_APPLICATION = 'config.wsgi.application'

# 언어 변경
LANGUAGE_CODE = 'ko-kr'

# 타임존 변경
TIME_ZONE = 'Asia/Seoul'

USE_I18N = True

USE_TZ = True

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

STATIC_URL = 'static/'

databases.py

데이터베이스 위치와 이름을 설정한다.

from .base import *


DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}

apps.py

장고 프로젝트에서 사용할 app들이다.

app을 생성하거나 마이그레이션이 적용되있더라도 여기에 등록하지 않으면 app을 사용할 수 없다.

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

auth.py

로그인을 할 때 사용되는 설정이다.

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

middlewares.py

페이지 구현 전에 작동할 미들웨어들을 설정한다.

리스트 0 index부터 -1 index까지 순서대로 작동한다. 따라서 임의로 미들웨어를 추가하는 경우 순서에 유의해서 추가해야 한다.

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

templates.py

템플릿이 위치한 폴더를 설정한다.

임의의 템플릿 작성시 여기에 등록해야 템플릿을 호출할 수 있다.

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

__init__.py

config/settings/local/__init__.py의 내용을 다음과 같이 설정한다.

from .base import *
from .apps import *
from .middlewares import *
from .templates import *
from .auth import *
from .databases import *

__init__.py

config/settings/__init__.py의 내용을 다음과 같이 설정한다.

from .local import *