環境から設定を取得する

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

サイトをデプロイしてインターネット上のサーバーにコピーしたら、3つの設定を変更する必要があります。DEBUG = Trueにすると、誰でもコードとすべてのURLパターンを見られるようになります。SECRET_KEYは、パスワードリセットリンクや署名付きCookieなど、サイトが信頼する必要のある値に署名するため、他人に読まれるコード内に置いてはいけません。ALLOWED_HOSTSには、サイトが配信するドメインを指定します。

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

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

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

チャレンジ

中級

環境から3つの設定を読み込みます。

mysite/settings.pyの先頭に、import osを追加します。
最初からあるSECRET_KEY、DEBUG、ALLOWED_HOSTSの各行を置き換えます。SECRET_KEYにはDJANGO_SECRET_KEYの値を使用し、デフォルト値は"django-insecure-change-me"です。DEBUGがTrueになるのは、DJANGO_DEBUGの値がテキスト"True"の場合だけです。ALLOWED_HOSTSにはDJANGO_ALLOWED_HOSTSをカンマで分割した値を使用し、デフォルト値はlocalhost,127.0.0.1です。

/nope/を開くと、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/"