環境から設定を取得する

CoddyのDjangoジャーニー「JSON API」セクションの一部。レッスン 18/19。

サイトをデプロイしてインターネット上のサーバーにコピーしたら、3つの設定を変更する必要があります。DEBUG = True は、誰にでもコードとすべてのURLパターンを表示します。SECRET_KEY はセッションに署名するため、他人が読めるコード内に置くことはできません。ALLOWED_HOSTS には、サイトが応答するドメインを列挙します。

一般的な方法は、環境変数から値を読み取ることです。環境変数とは、サーバーがプログラムの起動時に渡す値です。os.environ.get(name, default) で値を読み取ります。既定値は、自分のコンピューターで使われる値です。

PAGE_SIZE = int(os.environ.get("PAGE_SIZE", "20"))
MAINTENANCE = os.environ.get("MAINTENANCE", "no") == "yes"

環境変数は常に文字列なので、必要な型に変換します。数値にはint()、真偽値には比較、リストにはsplit(",")を使います。安全な既定値を選びましょう。変数を設定し忘れても、DEBUGはオフのままになります。

チャレンジ

中級

mysite/settings.pyで、環境変数から値を読み込みます：

DJANGO_SECRET_KEYからSECRET_KEYを読み込み、既定値は"django-insecure-change-me"です。
DEBUG：DJANGO_DEBUGが"True"の場合にのみTrueになります。
DJANGO_ALLOWED_HOSTSからALLOWED_HOSTSを読み込みます。カンマ区切りで、既定値はlocalhost,127.0.0.1です。

Runを押してから/nope/を開きます：DEBUGがオフの場合、404ページにはURLパターンが表示されません。

自分で試してみよう

from pathlib import Path

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

SECRET_KEY = "django-insecure-change-me"
DEBUG = True
ALLOWED_HOSTS = []

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

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 = "mysite.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",
            ],
        },
    },
]

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

LANGUAGE_CODE = "en-us"
TIME_ZONE = "UTC"
USE_I18N = True
USE_TZ = True

STATIC_URL = "static/"