Настройки 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. Обратите внимание, что модуль настроек должен находиться в sys.path Python.

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"

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

Файл настроек Django не обязан определять какие-либо настройки, если в этом нет необходимости. Для каждой настройки предусмотрено разумное значение по умолчанию. Эти значения по умолчанию находятся в модуле 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!

Назначать значения настройкам следует только в файле настроек.

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

Поскольку файл настроек содержит конфиденциальную информацию, например пароль базы данных, постарайтесь максимально ограничить доступ к нему. Например, измените права доступа к файлу так, чтобы его могли читать только вы и пользователь веб-сервера. Это особенно важно в среде виртуального хостинга с общим доступом.

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

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

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

Ничто не мешает вам создавать собственные настройки для своих приложений 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()