Python-Decouple 詳細解説: 設定とコードを賢く分離しよう！

pip install python-decouple

# .env ファイルの例
SECRET_KEY=your_super_secret_key_here_!@#$%^
DEBUG=True
DATABASE_URL=postgres://user:password@host:port/database_name
EMAIL_HOST=smtp.example.com
EMAIL_PORT=587
ALLOWED_HOSTS=.example.com,.localhost

from decouple import config
import os # osモジュールもよく使われます

# 設定値の取得
SECRET_KEY = config('SECRET_KEY')
DATABASE_URL = config('DATABASE_URL')
EMAIL_HOST = config('EMAIL_HOST')

print(f"Secret Key: {SECRET_KEY}")
print(f"Database URL: {DATABASE_URL}")
print(f"Email Host: {EMAIL_HOST}")

from decouple import config, Csv

# 文字列として読み込まれる (デフォルト)
SECRET_KEY = config('SECRET_KEY') # str

# 真偽値にキャスト
DEBUG = config('DEBUG', cast=bool) # bool

# 整数にキャスト
EMAIL_PORT = config('EMAIL_PORT', cast=int) # int

# カンマ区切りの文字列をリストにキャスト (Csvヘルパーを使用)
# .env ファイル: ALLOWED_HOSTS=.example.com,.localhost
ALLOWED_HOSTS = config('ALLOWED_HOSTS', cast=Csv()) # list

# 独自関数でキャストも可能
def parse_complex_setting(value):
    # 何らかの複雑なパース処理
    parts = value.split(':')
    return {'part1': parts[0], 'part2': parts[1]}

# COMPLEX_SETTING=value1:value2
COMPLEX_DATA = config('COMPLEX_SETTING', cast=parse_complex_setting) # dict

print(f"DEBUG is {DEBUG} (type: {type(DEBUG)})")
print(f"EMAIL_PORT is {EMAIL_PORT} (type: {type(EMAIL_PORT)})")
print(f"ALLOWED_HOSTS is {ALLOWED_HOSTS} (type: {type(ALLOWED_HOSTS)})")

from decouple import config

# DEBUGが未定義の場合、Falseを使用する
DEBUG = config('DEBUG', default=False, cast=bool)

# TIMEOUTが未定義の場合、30を使用する
TIMEOUT = config('TIMEOUT', default=30, cast=int)

# ADMIN_EMAILが未定義の場合、Noneを使用する (デフォルトのデフォルト値はUndefinedValueError)
ADMIN_EMAIL = config('ADMIN_EMAIL', default=None)

print(f"DEBUG: {DEBUG}")
print(f"TIMEOUT: {TIMEOUT}")
print(f"Admin Email: {ADMIN_EMAIL}")

# .env ファイルで DEBUG=True になっていても、
# 以下のコマンドを実行すると DEBUG=False として実行される
DEBUG=False python manage.py runserver

# settings.ini ファイルの例
[settings]
SECRET_KEY=your_super_secret_key_here_!@#$%^
DEBUG=True
DATABASE_URL=postgres://user:password@host:port/database_name
EMAIL_PORT=587
PERCENTILE=90%% ; %文字自体を使いたい場合は %% とエスケープする

from decouple import config

# .env: ENVIRONMENT=production
# ENVIRONMENT は 'development', 'staging', 'production' のいずれかである必要がある
ENVIRONMENT = config('ENVIRONMENT', choices=['development', 'staging', 'production'])

# .env: LOG_LEVEL=WARN
# choices は cast と併用可能
LOG_LEVEL = config('LOG_LEVEL', default='INFO', choices=['DEBUG', 'INFO', 'WARN', 'ERROR'])

# .env: DB_TYPE=mysql (これはエラーになる)
# DB_TYPE = config('DB_TYPE', choices=['postgres', 'sqlite']) # -> ValueError

print(f"Environment: {ENVIRONMENT}")
print(f"Log Level: {LOG_LEVEL}")

from decouple import config, Csv, Json

# .env: ALLOWED_HOSTS=host1.com,host2.net,localhost
ALLOWED_HOSTS = config('ALLOWED_HOSTS', cast=Csv())
# -> ['host1.com', 'host2.net', 'localhost']

# .env: ADMIN_IDS=1, 2, 10, 35
ADMIN_IDS = config('ADMIN_IDS', cast=Csv(cast=int))
# -> [1, 2, 10, 35] (各要素を整数にキャスト)

# .env: CORS_ORIGINS='["http://localhost:3000", "https://*.example.com"]'
CORS_ORIGINS = config('CORS_ORIGINS', cast=Json())
# -> ['http://localhost:3000', 'https://*.example.com']

# .env: FEATURE_FLAGS='{"new_dashboard": true, "beta_feature": false}'
FEATURE_FLAGS = config('FEATURE_FLAGS', cast=Json())
# -> {'new_dashboard': True, 'beta_feature': False}

print(f"Allowed Hosts: {ALLOWED_HOSTS}")
print(f"Admin IDs: {ADMIN_IDS}")
print(f"CORS Origins: {CORS_ORIGINS}")
print(f"Feature Flags: {FEATURE_FLAGS}")

# my_django_project/.env
SECRET_KEY=django_insecure_very_secret_key
DEBUG=True
DATABASE_URL=sqlite:///db.sqlite3
# または PostgreSQL の場合
# DATABASE_URL=postgres://user:password@localhost:5432/mydatabase
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=587
EMAIL_USE_TLS=True
EMAIL_HOST_USER=your_email@gmail.com
EMAIL_HOST_PASSWORD=your_app_password # Gmailならアプリパスワード
ALLOWED_HOSTS=127.0.0.1,localhost

# my_django_project/my_django_project/settings.py
import os
from pathlib import Path
from decouple import config, Csv
import dj_database_url # データベースURLをパースするために別途インストール (pip install dj-database-url)

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

# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/stable/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = config('SECRET_KEY') # default を設定しないことで必須項目とする

# SECURITY WARNING: don't run with debug turned on in production!
# 環境変数や .env に DEBUG がなければ False になる
DEBUG = config('DEBUG', default=False, cast=bool)

ALLOWED_HOSTS = config('ALLOWED_HOSTS', cast=Csv())

# Application definition
INSTALLED_APPS = [
    # ... default apps
]

MIDDLEWARE = [
    # ... default middleware
]

ROOT_URLCONF = 'my_django_project.urls'

TEMPLATES = [
    # ... template settings
]

WSGI_APPLICATION = 'my_django_project.wsgi.application'


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

# DATABASE_URL から Django の DATABASES 設定を生成
DATABASES = {
    'default': config(
        'DATABASE_URL',
        default=f'sqlite:///{BASE_DIR / "db.sqlite3"}', # デフォルトは SQLite
        cast=dj_database_url.parse # dj-database-url でパース
    )
}


# Password validation
# https://docs.djangoproject.com/en/stable/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    # ... default validators
]


# Internationalization
# https://docs.djangoproject.com/en/stable/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/stable/howto/static-files/

STATIC_URL = 'static/'

# Default primary key field type
# https://docs.djangoproject.com/en/stable/ref/settings/#default-auto-field

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

# Email settings
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = config('EMAIL_HOST', default='localhost')
EMAIL_PORT = config('EMAIL_PORT', default=25, cast=int)
EMAIL_USE_TLS = config('EMAIL_USE_TLS', default=False, cast=bool)
EMAIL_HOST_USER = config('EMAIL_HOST_USER', default='')
EMAIL_HOST_PASSWORD = config('EMAIL_HOST_PASSWORD', default='')