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