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

При обработке 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 FileFieldFormView(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

from django.utils.decorators import method_decorator
from django.views import View
from django.views.decorators.csrf import csrf_exempt, csrf_protect

@method_decorator(csrf_exempt, name='dispatch')
class UploadFileView(View):

    def setup(self, request, *args, **kwargs):
        request.upload_handlers.insert(0, ProgressBarUploadHandler(request))
        super().setup(request, *args, **kwargs)

    @method_decorator(csrf_protect)
    def post(self, request, *args, **kwargs):
        ... # Process request