Как управлять статическими файлами (например, изображениями, JavaScript, CSS)

Веб-сайты обычно нуждаются в предоставлении дополнительных файлов, таких как изображения, JavaScript или CSS. В Django эти файлы называются «статическими файлами». Django предоставляет django.contrib.staticfiles, чтобы помочь вам с их управлением.

Эта страница описывает, как можно предоставлять эти статические файлы.

Настройка статических файлов

1. Убедитесь, что django.contrib.staticfiles включено в ваш INSTALLED_APPS.

2. В файле настроек определите STATIC_URL, например:

   STATIC_URL = "static/"
   

3. В шаблонах используйте тег шаблона static для построения URL для заданного относительного пути, используя настроенный staticfiles STORAGES псевдоним.

   {% load static %}
   <img src="{% static 'my_app/example.jpg' %}" alt="My image">
   

4. Сохраняйте статические файлы в папке, названной static в вашем приложении. Например, my_app/static/my_app/example.jpg.

Ваш проект, вероятно, также будет содержать статические ресурсы, которые не связаны с конкретным приложением. Помимо использования директории static/ внутри ваших приложений, вы можете определить список директорий (STATICFILES_DIRS) в вашем файле настроек, где Django также будет искать статические файлы. Например:

STATICFILES_DIRS = [
    BASE_DIR / "static",
    "/var/www/static/",
]

См. документацию по настройке STATICFILES_FINDERS для получения подробностей о том, как staticfiles находит ваши файлы.

Предоставление статических файлов во время разработки

Если вы используете django.contrib.staticfiles, как описано выше, runserver сделает это автоматически, когда DEBUG установлено в значение True. Если у вас нет django.contrib.staticfiles в INSTALLED_APPS, вы все равно можете вручную предоставить статические файлы, используя представление django.views.static.serve().

Это не подходит для использования в производстве! Для некоторых распространенных стратегий развертывания см. Как развернуть статические файлы.

Например, если ваш STATIC_URL определён как static/, вы можете сделать это, добавив следующий фрагмент в свой urls.py:

from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
    # ... the rest of your URLconf goes here ...
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

Предоставление загруженных файлов во время разработки

Во время разработки вы можете предоставлять загруженные пользователем медиафайлы из MEDIA_ROOT с помощью представления django.views.static.serve().

Это не подходит для использования в производстве! Для некоторых распространённых стратегий развертывания см. Как развернуть статические файлы.

Например, если ваш MEDIA_URL определён как media/, вы можете сделать это, добавив следующий фрагмент в свой ROOT_URLCONF:

from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
    # ... the rest of your URLconf goes here ...
] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

Поддержка тестирования

При запуске тестов, использующих реальные HTTP-запросы вместо встроенного тестового клиента (т.е. при использовании встроенного LiveServerTestCase), статические ресурсы должны предоставляться вместе с остальным содержимым, чтобы тестовая среда воспроизводила реальную как можно более точно, но LiveServerTestCase имеет только очень базовые функции предоставления статических файлов: Оно не знает о функции поиска в приложении staticfiles и предполагает, что статическое содержимое уже собрано в STATIC_ROOT.

Из-за этого staticfiles поставляется со своим собственным django.contrib.staticfiles.testing.StaticLiveServerTestCase, подклассом встроенного, который имеет возможность прозрачно предоставлять все ресурсы во время выполнения этих тестов аналогично тому, что мы получаем во время разработки с помощью DEBUG = True, т.е. без необходимости предварительно собирать их с помощью collectstatic.

Развёртывание

django.contrib.staticfiles предоставляет удобную команду управления для сбора статических файлов в одну директорию, чтобы вы могли легко их предоставить.

1. Установите настройку STATIC_ROOT в директорию, из которой вы хотите предоставлять эти файлы, например:

   STATIC_ROOT = "/var/www/example.com/static/"
   

2. Запустите команду управления collectstatic:

   $ python manage.py collectstatic
   

   Это скопирует все файлы из ваших статических папок в директорию STATIC_ROOT.

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

Дополнительная информация

В этом документе были рассмотрены основы и некоторые общие шаблоны использования. Для получения полной информации обо всех настройках, командах, тегах шаблонов и других компонентах, включённых в django.contrib.staticfiles, см. справочник по staticfiles.