Настройки Django¶

Основы¶

Файл настроек - это просто модуль Python с переменными на уровне модуля.

Вот несколько примеров настроек:

ALLOWED_HOSTS = ['www.example.com']
DEBUG = False
DEFAULT_FROM_EMAIL = 'webmaster@example.com'

Поскольку файл настроек является модулем Python, применяются следующие правила:

• Он не допускает синтаксических ошибок Python.

• Он может назначать параметры динамически, используя обычный синтаксис Python. Например:

  MY_SETTING = [str(i) for i in range(30)]
  

• Он может импортировать значения из других файлов настроек.

Назначение настроек¶

DJANGO_SETTINGS_MODULE¶

Когда вы используете Django, вы должны сообщить ему, какие настройки вы используете. Для этого используется переменная окружения DJANGO_SETTINGS_MODULE.

Значение DJANGO_SETTINGS_MODULE должно быть в синтаксисе пути Python, например, mysite.settings. Обратите внимание, что модуль настроек должен находиться на Python import search path.

export DJANGO_SETTINGS_MODULE=mysite.settings
django-admin runserver

set DJANGO_SETTINGS_MODULE=mysite.settings
django-admin runserver

django-admin runserver --settings=mysite.settings

import os

os.environ['DJANGO_SETTINGS_MODULE'] = 'mysite.settings'

Настройки по умолчанию¶

A Django settings file doesn’t have to define any settings if it doesn’t need to. Each setting has a sensible default value. These defaults live in the module django/conf/global_settings.py.

Вот алгоритм, который Django использует при компиляции настроек:

• Загрузите настройки из global_settings.py.
• Загрузка настроек из указанного файла настроек, при необходимости переопределяя глобальные настройки.

Обратите внимание, что файл настроек не должен не импортировать из global_settings, потому что это избыточно.

Использование настроек в коде Python¶

В ваших приложениях Django используйте настройки, импортируя объект django.conf.settings. Пример:

from django.conf import settings

if settings.DEBUG:
    # Do something

Обратите внимание, что django.conf.settings не является модулем - это объект. Поэтому импорт отдельных настроек невозможен:

from django.conf.settings import DEBUG  # This won't work.

Также обратите внимание, что ваш код не должен не импортировать ни из global_settings, ни из вашего собственного файла настроек. django.conf.settings абстрагирует понятия настроек по умолчанию и настроек конкретного сайта; он представляет единый интерфейс. Он также отделяет код, использующий настройки, от местоположения ваших настроек.

Изменение настроек во время выполнения¶

Вы не должны изменять настройки в своих приложениях во время выполнения. Например, не делайте этого в представлении:

from django.conf import settings

settings.DEBUG = True   # Don't do this!

Единственное место, куда следует назначать настройки, - это файл настроек.

Безопасность¶

Because a settings file contains sensitive information, such as the database password, you should make every attempt to limit access to it. For example, change its file permissions so that only you and your web server’s user can read it. This is especially important in a shared-hosting environment.

Доступные настройки¶

Полный список доступных настроек см. в разделе settings reference.

Создание собственных настроек¶

Ничто не мешает вам создавать свои собственные настройки для своих Django-приложений, но следуйте этим рекомендациям:

• Имена настроек должны быть прописными.
• Не изобретайте заново уже существующую обстановку.

Для параметров, которые являются последовательностями, Django сам использует списки, но это лишь условность.

Использование настроек без установки DJANGO_SETTINGS_MODULE¶

В некоторых случаях вы можете обойтись без переменной окружения DJANGO_SETTINGS_MODULE. Например, если вы используете систему шаблонов самостоятельно, вам, скорее всего, не понадобится устанавливать переменную окружения, указывающую на модуль настроек.

В этих случаях вы можете настроить параметры Django вручную. Сделайте это, вызвав:

django.conf.settings.configure(default_settings, **settings)¶

Пример:

from django.conf import settings

settings.configure(DEBUG=True)

Передайте configure() столько аргументов с ключевыми словами, сколько пожелаете, причем каждый аргумент с ключевым словом представляет собой настройку и ее значение. Имя каждого аргумента должно быть полностью заглавным, с тем же именем, что и настройки, описанные выше. Если конкретная настройка не была передана в configure() и понадобится позже, Django будет использовать значение настройки по умолчанию.

Конфигурирование Django таким образом в основном необходимо - и, более того, рекомендуется - когда вы используете часть фреймворка внутри более крупного приложения.

Следовательно, при настройке через settings.configure(), Django не будет вносить никаких изменений в переменные окружения процесса (см. документацию TIME_ZONE о том, почему это обычно происходит). Предполагается, что в этих случаях вы уже полностью контролируете свое окружение.

from django.conf import settings
from myapp import myapp_defaults

settings.configure(default_settings=myapp_defaults, DEBUG=True)

settings.configure(myapp_defaults, DEBUG=True)

from django.conf import settings
if not settings.configured:
    settings.configure(myapp_defaults, DEBUG=True)

import django
from django.conf import settings
from myapp import myapp_defaults

settings.configure(default_settings=myapp_defaults, DEBUG=True)
django.setup()

# Now this script or any imported module can use any part of Django it needs.
from myapp import models

if __name__ == '__main__':
    import django
    django.setup()