Загрузка файлов

Когда Django обрабатывает загрузку файла, данные файла размещаются в request.FILES (подробнее об объекте request см. документацию по объектам запроса и ответа). Этот документ объясняет, как файлы хранятся на диске и в памяти, а также как настроить поведение по умолчанию.

Базовая загрузка файлов

Рассмотрим форму, содержащую FileField:

from django import forms

class UploadFileForm(forms.Form):
    title = forms.CharField(max_length=50)
    file = forms.FileField()

Вид, обрабатывающий эту форму, получит данные файла в request.FILES, который представляет собой словарь, содержащий ключ для каждого FileField (или ImageField, или другого FileField подкласса) в форме. Итак, данные из вышеприведенной формы будут доступны как request.FILES['file'].

Обратите внимание, что request.FILES будет содержать данные только в том случае, если метод запроса был POST, по крайней мере одно поле файла было фактически отправлено, и <form>, который отправил запрос, имеет атрибут enctype="multipart/form-data". В противном случае request.FILES будет пустым.

В большинстве случаев вы передадите данные файла из request в форму, как описано в Привязка загруженных файлов к форме. Это будет выглядеть примерно так:

from django.http import HttpResponseRedirect
from django.shortcuts import render
from .forms import UploadFileForm

# Imaginary function to handle an uploaded file.
from somewhere import handle_uploaded_file

def upload_file(request):
    if request.method == 'POST':
        form = UploadFileForm(request.POST, request.FILES)
        if form.is_valid():
            handle_uploaded_file(request.FILES['file'])
            return HttpResponseRedirect('/success/url/')
    else:
        form = UploadFileForm()
    return render(request, 'upload.html', {'form': form})

Обратите внимание, что мы должны передать request.FILES в конструктор формы; именно так данные файлов привязываются к форме.

Вот распространенный способ обработки загруженного файла:

def handle_uploaded_file(f):
    with open('some/file/name.txt', 'wb+') as destination:
        for chunk in f.chunks():
            destination.write(chunk)

Итерация по UploadedFile.chunks() вместо использования read() гарантирует, что большие файлы не перегружают память вашей системы.

Для объектов UploadedFile доступны несколько других методов и атрибутов; см. UploadedFile для полного справочника.

Обработка загруженных файлов с помощью модели

Если вы сохраняете файл в Model с FileField, использование ModelForm значительно упрощает этот процесс. Объект файла будет сохранен в местоположении, указанном параметром upload_to соответствующего FileField при вызове form.save():

from django.http import HttpResponseRedirect
from django.shortcuts import render
from .forms import ModelFormWithFileField

def upload_file(request):
    if request.method == 'POST':
        form = ModelFormWithFileField(request.POST, request.FILES)
        if form.is_valid():
            # file is saved
            form.save()
            return HttpResponseRedirect('/success/url/')
    else:
        form = ModelFormWithFileField()
    return render(request, 'upload.html', {'form': form})

Если вы создаете объект вручную, вы можете назначить объект файла из request.FILES полю файла в модели:

from django.http import HttpResponseRedirect
from django.shortcuts import render
from .forms import UploadFileForm
from .models import ModelWithFileField

def upload_file(request):
    if request.method == 'POST':
        form = UploadFileForm(request.POST, request.FILES)
        if form.is_valid():
            instance = ModelWithFileField(file_field=request.FILES['file'])
            instance.save()
            return HttpResponseRedirect('/success/url/')
    else:
        form = UploadFileForm()
    return render(request, 'upload.html', {'form': form})

Загрузка нескольких файлов

Если вы хотите загрузить несколько файлов с помощью одного поля формы, установите атрибут multiple виджета поля:

from django import forms

class FileFieldForm(forms.Form):
    file_field = forms.FileField(widget=forms.ClearableFileInput(attrs={'multiple': True}))

Затем переопределите метод post вашего подкласса FormView для обработки многократной загрузки файлов:

from django.views.generic.edit import FormView
from .forms import FileFieldForm

class FileFieldView(FormView):
    form_class = FileFieldForm
    template_name = 'upload.html'  # Replace with your template.
    success_url = '...'  # Replace with your URL or reverse().

    def post(self, request, *args, **kwargs):
        form_class = self.get_form_class()
        form = self.get_form(form_class)
        files = request.FILES.getlist('file_field')
        if form.is_valid():
            for f in files:
                ...  # Do something with each file.
            return self.form_valid(form)
        else:
            return self.form_invalid(form)

Обработчики загрузки

Когда пользователь загружает файл, Django передает данные файла обработчику загрузки — небольшому классу, который обрабатывает данные файла по мере их загрузки. Обработчики загрузки изначально определены в настройке FILE_UPLOAD_HANDLERS, которая по умолчанию:

["django.core.files.uploadhandler.MemoryFileUploadHandler",
 "django.core.files.uploadhandler.TemporaryFileUploadHandler"]

Вместе MemoryFileUploadHandler и TemporaryFileUploadHandler обеспечивают стандартное поведение Django по загрузке файлов: чтение небольших файлов в память, а больших — на диск.

Вы можете написать пользовательские обработчики, которые настроят способ обработки файлов Django. Например, вы можете использовать пользовательские обработчики для применения квот на уровне пользователя, сжатия данных в реальном времени, отображения полос прогресса и даже отправки данных в другое место хранения непосредственно без сохранения их локально. См. Написание пользовательских обработчиков загрузки для получения подробной информации о настройке или полном изменении поведения загрузки.

Где хранятся загруженные данные

Прежде чем сохранять загруженные файлы, данные должны быть сохранены где-нибудь.

По умолчанию, если загруженный файл меньше 2,5 мегабайт, Django будет хранить все содержимое загрузки в памяти. Это означает, что сохранение файла включает только чтение из памяти и запись на диск, поэтому происходит очень быстро.

Однако, если загруженный файл слишком большой, Django запишет загруженный файл во временный файл, хранящийся в временном каталоге вашей системы. В Unix-подобной платформе это означает, что Django может создать файл с именем, похожим на /tmp/tmpzfp6I6.upload. Если загрузка достаточно большая, вы можете наблюдать, как размер этого файла увеличивается по мере потоковой передачи данных Django на диск.

Эти детали — 2,5 мегабайта; /tmp; и т.д. — являются «разумными значениями по умолчанию», которые можно настроить, как описано в следующем разделе.

Изменение поведения обработчика загрузки

Существует несколько настроек, которые контролируют поведение загрузки файлов в Django. См. Настройки загрузки файлов для получения подробной информации.

Модификация обработчиков загрузки в реальном времени

Иногда определенные виды требуют различного поведения загрузки. В таких случаях вы можете переопределить обработчики загрузки на основе запроса, изменив request.upload_handlers. По умолчанию этот список будет содержать обработчики загрузки, заданные в FILE_UPLOAD_HANDLERS, но вы можете изменять список, как и любой другой список.

Например, предположим, что вы написали ProgressBarUploadHandler для предоставления обратной связи о прогрессе загрузки в какой-либо виджет AJAX. Вы добавите этот обработчик в ваши обработчики загрузки следующим образом:

request.upload_handlers.insert(0, ProgressBarUploadHandler(request))

В этом случае вам, вероятно, понадобится использовать list.insert() (а не append()), так как обработчику прогресса загрузки необходимо выполнить до любых других обработчиков. Помните, что обработчики загрузки обрабатываются в порядке.

Если вы хотите полностью заменить обработчики загрузки, вы можете назначить новый список:

request.upload_handlers = [ProgressBarUploadHandler(request)]

from django.views.decorators.csrf import csrf_exempt, csrf_protect

@csrf_exempt
def upload_file_view(request):
    request.upload_handlers.insert(0, ProgressBarUploadHandler(request))
    return _upload_file_view(request)

@csrf_protect
def _upload_file_view(request):
    ... # Process request