Seraphonogram

颜色主题

管理 Django Settings ​

发布于2023-12-21 11:48
保质期2026-12
新鲜度
64%
标签
开发
测试
Django

下文约定

项目所在目录为 ./ ，Django Settings 所在目录为 ./{service}/ ，项目名称为 service 。

原生方法 ​

  • ./manage.py
  • ./{service}/wsgi.py
  • ./{service}/asgi.py

三个启动文件中都有一个名为 DJANGO_SETTINGS_MODULE 的环境变量，变量值实际上是一个 Python 包的路径，默认是 "{service}.settings" ，对应 ./{service}/settings.py 这个文件。

Django 就是在启动时通过这个包路径导入对应的配置代码，构造 django.conf.settings 对象。

注意

settings 不是一个包，而是一个对象，所以

python
django.conf.settings import DEBUG  # 不能这样导入

if DEBUG is True:
    pass

当需要配置不同环境的 settings 时，一般建立多个不受版本控制的 ./{service}/settings_*.py 文件，并在不同的环境下将环境变量 DJANGO_SETTINGS_MODULE 指向所需的文件。

这个文件可以配置如下：

python
from service.settings import *

DEBUG = True
SECRET_KEY = "He110, me0w."
ALLOWED_HOSTS = [
    '*',
]
DATABASES['default'] = dict(
    ENGINE='django.db.backends.postgresql',
    NAME='db_name',
    USER='meow',
    PASSWORD='meowpassword',
    HOST='127.0.0.1',
    PORT='5432',
)

对于不是直接赋值的变量，可以通过 IDE 跳转到 settings.py 对应的变量。

django-environ 包 ​

django-environ 是一个第三方包，需要通过 pip install 或其它方式安装。它遵循十二因素方法论，关于这个的解读可以参考这里。

使用方法为在 settings.py 中导入包：

python
from environ import Env

BASE_DIR = Path(__file__).parent.parent

env = Env()
env.read_env(BASE_DIR / '.env')

DEBUG = env.bool('DEBUG')
SECRET_KEY = env.str('SECRET_KEY')
ALLOWED_HOSTS = env.list('ALLOWED_HOSTS')
DATABASES = {
    'default': env.db('DEFAULT_DATABASE'),
}

而 ./.env 文件的写法为：

ini
DEBUG=true
SECRET_KEY="He110, me0w."
ALLOWED_HOSTS=127.0.0.1,::1
DEFAULT_DATABASE=postgresql://meow:meowpassword@127.0.0.1:5432/db_name

但这个文件不能含有中文，否则会报编码错误。虽然可以将环境变量 PYTHONUTF8 设为 1 来缓解，但在多设备多环境的情况下治标不治本，最好的办法还是全英输入。

在多环境下，包的做法是只将 ./.env 载入环境变量并由 Env 读取，换句话说，相当于一个环境只能拥有一份配置。这一点可以参阅它的Quick Start。

在这种情况下，不应该将 ./.env 纳入版本控制，而应该编写不同环境的模板，命名为 ./.env.prod 、./env.dev 之类，然后纳入版本管理；而后在新的环境中，开发人员（或运维人员）根据模板重新编写 ./.env ，最后再启动。

附注1 - BASE_DIR ​

说明

以下是对比 Django 3.0 和 3.1 的《模板覆写指南》得到的结论。

从 3.1 版本开始，Django 默认 settings 模板的 BASE_DIR 的值改为

python
from pathlib import Path

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

旧版本是

python
import os

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

附注2 - SECRET_KEY ​

以下代码可以生成十个不定长的随机 SECRET_KEY 用作备选（适用于 Python 3.4+）。

python
from base64 import b85encode
from random import getrandbits

for _ in range(10):
    soup = getrandbits(64 * 8).to_bytes(64, 'big')
    key = b85encode(soup).decode('ASCII')
    print(key)

以下代码可以生成十个定长的随机 SECRET_KEY 用作备选（适用于 Python 3.0+）。

python
import string
import random

charset = string.digits + string.ascii_letters + string.punctuation
for _ in range(10):
    key = ''.join(random.choice(charset) for _ in range(64))
    print(key)