Настройки 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 sys.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"

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

Файл настроек 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()