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

Когда 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