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

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

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 в каталог STATIC_ROOT.

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

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

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