File Uploads

When Django handles a file upload, the file data ends up placed in request.FILES (for more on the request object see the documentation for request and response objects). This document explains how files are stored on disk and in memory, and how to customize the default behavior.

Warning

There are security risks if you are accepting uploaded content from untrusted users! See the security guide’s topic on User-uploaded content for mitigation details.

Basic file uploads

Consider a form containing a FileField:

forms.py

  1. from django import forms
  3. class UploadFileForm(forms.Form):
  4.     title = forms.CharField(max_length=50)
  5.     file = forms.FileField()

A view handling this form will receive the file data in request.FILES, which is a dictionary containing a key for each FileField (or ImageField, or other FileField subclass) in the form. So the data from the above form would be accessible as request.FILES['file'].

Note that request.FILES will only contain data if the request method was POST, at least one file field was actually posted, and the <form> that posted the request has the attribute enctype="multipart/form-data". Otherwise, request.FILES will be empty.

Most of the time, you’ll pass the file data from request into the form as described in Binding uploaded files to a form. This would look something like:

views.py

  1. from django.http import HttpResponseRedirect
  2. from django.shortcuts import render
  3. from .forms import UploadFileForm
  5. # Imaginary function to handle an uploaded file.
  6. from somewhere import handle_uploaded_file
  8. def upload_file(request):
  9.     if request.method == 'POST':
  10.         form = UploadFileForm(request.POST, request.FILES)
  11.         if form.is_valid():
  12.             handle_uploaded_file(request.FILES['file'])
  13.             return HttpResponseRedirect('/success/url/')
  14.     else:
  15.         form = UploadFileForm()
  16.     return render(request, 'upload.html', {'form': form})

Notice that we have to pass request.FILES into the form’s constructor; this is how file data gets bound into a form.

Here’s a common way you might handle an uploaded file:

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

Looping over UploadedFile.chunks() instead of using read() ensures that large files don’t overwhelm your system’s memory.

There are a few other methods and attributes available on UploadedFile objects; see UploadedFile for a complete reference.

Handling uploaded files with a model

If you’re saving a file on a Model with a FileField, using a ModelForm makes this process much easier. The file object will be saved to the location specified by the upload_to argument of the corresponding FileField when calling form.save():

  1. from django.http import HttpResponseRedirect
  2. from django.shortcuts import render
  3. from .forms import ModelFormWithFileField
  5. def upload_file(request):
  6.     if request.method == 'POST':
  7.         form = ModelFormWithFileField(request.POST, request.FILES)
  8.         if form.is_valid():
  9.             # file is saved
  10.             form.save()
  11.             return HttpResponseRedirect('/success/url/')
  12.     else:
  13.         form = ModelFormWithFileField()
  14.     return render(request, 'upload.html', {'form': form})

If you are constructing an object manually, you can assign the file object from request.FILES to the file field in the model:

  1. from django.http import HttpResponseRedirect
  2. from django.shortcuts import render
  3. from .forms import UploadFileForm
  4. from .models import ModelWithFileField
  6. def upload_file(request):
  7.     if request.method == 'POST':
  8.         form = UploadFileForm(request.POST, request.FILES)
  9.         if form.is_valid():
  10.             instance = ModelWithFileField(file_field=request.FILES['file'])
  11.             instance.save()
  12.             return HttpResponseRedirect('/success/url/')
  13.     else:
  14.         form = UploadFileForm()
  15.     return render(request, 'upload.html', {'form': form})

If you are constructing an object manually outside of a request, you can assign a File like object to the FileField:

  1. from django.core.management.base import BaseCommand
  2. from django.core.files.base import ContentFile
  4. class MyCommand(BaseCommand):
  5.     def handle(self, *args, **options):
  6.         content_file = ContentFile(b'Hello world!', name='hello-world.txt')
  7.         instance = ModelWithFileField(file_field=content_file)
  8.         instance.save()

Uploading multiple files

If you want to upload multiple files using one form field, set the multiple HTML attribute of field’s widget:

forms.py

  1. from django import forms
  3. class FileFieldForm(forms.Form):
  4.     file_field = forms.FileField(widget=forms.ClearableFileInput(attrs={'multiple': True}))

Then override the post method of your FormView subclass to handle multiple file uploads:

views.py

  1. from django.views.generic.edit import FormView
  2. from .forms import FileFieldForm
  4. class FileFieldFormView(FormView):
  5.     form_class = FileFieldForm
  6.     template_name = 'upload.html'  # Replace with your template.
  7.     success_url = '...'  # Replace with your URL or reverse().
  9.     def post(self, request, *args, **kwargs):
  10.         form_class = self.get_form_class()
  11.         form = self.get_form(form_class)
  12.         files = request.FILES.getlist('file_field')
  13.         if form.is_valid():
  14.             for f in files:
  15.                 ...  # Do something with each file.
  16.             return self.form_valid(form)
  17.         else:
  18.             return self.form_invalid(form)

Upload Handlers

When a user uploads a file, Django passes off the file data to an upload handler – a small class that handles file data as it gets uploaded. Upload handlers are initially defined in the FILE_UPLOAD_HANDLERS setting, which defaults to:

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

Together MemoryFileUploadHandler and TemporaryFileUploadHandler provide Django’s default file upload behavior of reading small files into memory and large ones onto disk.

You can write custom handlers that customize how Django handles files. You could, for example, use custom handlers to enforce user-level quotas, compress data on the fly, render progress bars, and even send data to another storage location directly without storing it locally. See Writing custom upload handlers for details on how you can customize or completely replace upload behavior.

Where uploaded data is stored

Before you save uploaded files, the data needs to be stored somewhere.

By default, if an uploaded file is smaller than 2.5 megabytes, Django will hold the entire contents of the upload in memory. This means that saving the file involves only a read from memory and a write to disk and thus is very fast.

However, if an uploaded file is too large, Django will write the uploaded file to a temporary file stored in your system’s temporary directory. On a Unix-like platform this means you can expect Django to generate a file called something like /tmp/tmpzfp6I6.upload. If an upload is large enough, you can watch this file grow in size as Django streams the data onto disk.

These specifics – 2.5 megabytes; /tmp; etc. – are “reasonable defaults” which can be customized as described in the next section.

Changing upload handler behavior

There are a few settings which control Django’s file upload behavior. See File Upload Settings for details.

Modifying upload handlers on the fly

Sometimes particular views require different upload behavior. In these cases, you can override upload handlers on a per-request basis by modifying request.upload_handlers. By default, this list will contain the upload handlers given by FILE_UPLOAD_HANDLERS, but you can modify the list as you would any other list.

For instance, suppose you’ve written a ProgressBarUploadHandler that provides feedback on upload progress to some sort of AJAX widget. You’d add this handler to your upload handlers like this:

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

You’d probably want to use list.insert() in this case (instead of append()) because a progress bar handler would need to run before any other handlers. Remember, the upload handlers are processed in order.

If you want to replace the upload handlers completely, you can assign a new list:

  1. request.upload_handlers = [ProgressBarUploadHandler(request)]

Note

You can only modify upload handlers before accessing request.POST or request.FILES – it doesn’t make sense to change upload handlers after upload handling has already started. If you try to modify request.upload_handlers after reading from request.POST or request.FILES Django will throw an error.

Thus, you should always modify uploading handlers as early in your view as possible.

Also, request.POST is accessed by CsrfViewMiddleware which is enabled by default. This means you will need to use csrf_exempt() on your view to allow you to change the upload handlers. You will then need to use csrf_protect() on the function that actually processes the request. Note that this means that the handlers may start receiving the file upload before the CSRF checks have been done. Example code:

  1. from django.views.decorators.csrf import csrf_exempt, csrf_protect
  3. @csrf_exempt
  4. def upload_file_view(request):
  5.     request.upload_handlers.insert(0, ProgressBarUploadHandler(request))
  6.     return _upload_file_view(request)
  8. @csrf_protect
  9. def _upload_file_view(request):
  10.     ... # Process request

If you are using a class-based view, you will need to use csrf_exempt() on its dispatch() method and csrf_protect() on the method that actually processes the request. Example code:

  1. from django.utils.decorators import method_decorator
  2. from django.views import View
  3. from django.views.decorators.csrf import csrf_exempt, csrf_protect
  5. @method_decorator(csrf_exempt, name='dispatch')
  6. class UploadFileView(View):
  8.     def setup(self, request, *args, **kwargs):
  9.         request.upload_handlers.insert(0, ProgressBarUploadHandler(request))
  10.         super().setup(request, *args, **kwargs)
  12.     @method_decorator(csrf_protect)
  13.     def post(self, request, *args, **kwargs):
  14.         ... # Process request