Как управлять статическими файлами (например, изображениями, 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_STORAGE.

   {% 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.