文件上传

当Django在处理文件上传的时候，文件数据被保存request.FILES 。这篇文档阐述文件如何上传到内存和硬盘，以及如何自定义默认的行为。

基本的文件上传

假设一个表达中有一个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，并且发送请求的

拥有enctype="multipart/form-data"属性时，才会包含数据。否则request.FILES为空。

from django.http import HttpResponseRedirect
from django.shortcuts import render
from .forms import UploadFileForm
from somewhere import handle_uploaded_file  #处理上传文件的函数
def upload_file(request):
    if request.method == 'POST':
        form = UploadFileForm(request.POST, request.FILES)  #注意我们必须向表单的构造器中传递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})

下面是通常处理上传文件的方法

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()，能确保大文件并不会占用系统过多的内存。

使用模型处理上传文件

如果你Model上使用FileField保存文件，使用ModelForm可以让这个操作更加容易。调用form.save()的时候，文件对象会保存在相应的FileField的upload_to参数指定的地方。

class MyModel(models.Model):  #用模型处理上传文件
    # file will be uploaded to MEDIA_ROOT/uploads
    upload = models.FileField(upload_to='uploads/')
    # file will be saved to MEDIA_ROOT/uploads/2015/01/30
    upload = models.FileField(upload_to='uploads/%Y/%m/%d/')

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) #表单对象 与相应的model绑定
        if form.is_valid():
            # file is saved
            form.save()
            return HttpResponseRedirect('/success/url/')
    else:
        form = ModelFormWithFileField()
    return render(request, 'upload.html', {'form': form})

如果你手动构造一个对象，你可以简单地把文件对象从request.FILE赋值给模型：

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)  #表单对象，可能没有与model绑定
        if form.is_valid():
            instance = ModelWithFileField(file_field=request.FILES['file']) #文件model。与普通的从form中取出数据不同，form.cleaned_data['字段']
            instance.save()
            return HttpResponseRedirect('/success/url/')
    else:
        form = UploadFileForm()
    return render(request, 'upload.html', {'form': form})

上传多份文件

用一个form field上传多个文件，则需要在相应的form的field中设置multiple属性

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

继承内置View
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.5MB，Django会把整个内容存到内存。这意味着，文件的保存仅仅涉及到从内存读取和写到磁盘，所以非常快。但是,如果上传的文件很大，Django会把它写入一个临时文件，储存在你系统的临时目录中。在类Unix的平台下，你可以认为Django生成了一个文件，名称类似于/tmp/tmpzfp6I6.upload。如果上传的文件足够大，你可以观察到文件大小的增长，由于Django向磁盘写入数据。这些特定值 – 2.5 MB，/tmp，以及其它 -- 都仅仅是"合理的默值"。

更改上传处理器的行为

Django的文件上传处理器的行为由一些设置控制。详见文件上传设置

DEFAULT_FILE_STORAGE
FILE_CHARSET
FILE_UPLOAD_HANDLERS
FILE_UPLOAD_MAX_MEMORY_SIZE
FILE_UPLOAD_PERMISSIONS
FILE_UPLOAD_TEMP_DIR
MEDIA_ROOT
MEDIA_URL

在运行中更改上传处理器

有时候一些特定的视图需要不同的上传处理器。在这种情况下，你可以通过修改request.upload_handlers，为每个请求覆盖上传处理器。通常，这个列表会包含FILE_UPLOAD_HANDLERS提供的上传处理器，但是你可以把它修改为其它列表。例如，假设你编写了ProgressBarUploadHandler，它会在上传过程中向某类AJAX控件提供反馈。你可以像这样将它添加到你的上传处理器中：

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

在这种情况下你可能想要使用list.insert()（而不是append()），因为进度条处理器需要在任何其他处理器 之前执行。要记住，多个上传处理器是按顺序执行的。
如果你想要完全替换上传处理器，你可以赋值一个新的列表：

request.upload_handlers = [ProgressBarUploadHandler()]

你只可以在访问request.POST或者request.FILES之前修改上传处理器-- 在上传处理工作执行之后再修改上传处理就毫无意义了。
如果你在读取request.FILES之后尝试修request.upload_handlers，Django会抛出异常。所以，你应该在你的视图中尽早修改上传处理器。CsrfViewMiddleware也会访问request.POST，它是默认开启的。这意味着你需要在你的视图中使用csrf_exempt()来允许你修改上传处理器。然后你需要在真正处理请求的函数上使用csrf_protect()注意这意味着处理器可能会在CSRF验证完成之前开始接收上传文件。例如：

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

---

上传文件与上传文件处理过程

class UploadedFile
在文件上传期间，实际文件数据存储在request.FILES中。此字典中的每个条目都是UploadedFile对象（或子类） - 上传文件的简单包装器。您通常会使用以下方法之一访问上传的内容：

UploadedFile.read()
从文件中读取整个上传的数据。如果上传的文件是巨大的，如果你尝试读取它到内存中，它可以压倒你的系统。

UploadedFile.multiple_chunks(chunk_size=None)
如果上传的文件足够大，需要在多个块中读取，则返回True。默认情况下，这将是任何大于2.5兆字节的文件，但这是可配置的

UploadedFile.chunks(chunk_size=None)
一个生成器返回文件的块。如果multiple_chunks()是True，您应该在循环中使用此方法，而不是read()。在实践中，通常最简单的是使用chunks()。在chunks()上循环，而不是使用read()确保大文件不会超过系统内存

UploadedFile.name
已上传文件的名称（例如my_file.txt）

UploadedFile.size
上传文件的大小（以字节为单位）

UploadedFile.content_type
随文件上传的内容类型标题（例如text / plain或application / pdf）。与用户提供的任何数据一样，您不应该相信上传的文件实际上是此类型。您仍然需要验证该文件包含内容类型标题声明的内容 - “信任但验证”。

UploadedFile.content_type_extra
包含传递到content-type标头的额外参数的字典。这通常由服务（例如Google App Engine）提供，代表您拦截和处理文件上传。因此，您的处理程序可能不会收到上传的文件内容，而是一个URL或其他指向文件的指针。

UploadedFile.charset
对于text / *内容类型，字符集（即，utf8）。再次，“信任，但验证”是这里的最好的政策

UploadedFile的子类

*class *TemporaryUploadedFile()
上传到临时位置的文件流到磁盘）。此类由TemporaryFileUploadHandler使用。除了来自UploadedFile的方法,它还有一个额外的方法：

TemporaryUploadedFile.temporary_file_path()
返回临时上传文件的完整路径。

*class *InMemoryUploadedFile
上传到存储器中的文件（即，流到存储器）。此类MemoryFileUploadHandler使用。

内置上传处理器

MemoryFileUploadHandler和TemporaryFileUploadHandler一起提供Django的默认文件上传行为，将小文件读入内存，大文件读入磁盘。它们位于django.core.files.uploadhandler中。
*class *MemoryFileUploadHandler
文件上传处理程序将流上传到内存（用于小文件）。
*class *TemporaryFileUploadHandler
使用TemporaryUploadedFile将数据流传输到临时文件的上传处理程序。

编写自定义上传处理器

*class *FileUploadHandler所有文件上传处理程序应该是django.core.files.uploadhandler.FileUploadHandler的子类。你可以定义上传处理程序，无论你想要什么。

必须实现的方法

FileUploadHandler.receive_data_chunk(raw_data, start)
从文件上传接收一个“数据块”的数据。
raw_data是包含上传数据的字节字符串。
start是文件中raw_data块开始的位置。
您返回的数据将送入后续的上传处理程序的receive_data_chunk方法。这样，一个处理程序可以是用于其他处理程序的“过滤器”。
从receive_data_chunk返回None，以便让剩余的上传处理程序获取此块。如果您自己存储上传的数据，并且不希望未来的处理程序存储数据副本，那么此功能非常有用。如果您产生StopUpload或SkipFile异常，上传将中止或文件将被完全跳过。

FileUploadHandler.file_complete(file_size)
文件完成上传时调用。处理程序应返回将存储在request.FILES中的UploadedFile对象。处理程序也可以返回None以指示UploadedFile
对象应来自后续的上传处理程序。

可选方法

自定义上传处理程序还可以定义以下任何可选方法或属性：

FileUploadHandler.chunk_size
Django应该存储到内存并馈入处理程序的“块”的大小（以字节为单位）。也就是说，此属性控制送入FileUploadHandler.receive_data_chunk的块的大小。
为了获得最佳性能，块大小应可由4整除，且大小不应超过2 GB（2 31字节）。当有多个处理程序提供多个块大小时，Django将使用任何处理程序定义的最小块大小。默认值为64 * 2 10字节，或64 KB。

FileUploadHandler.new_file(field_name, file_name, content_type, content_length, charset, content_type_extra)
回调信号表示新文件上传正在开始。这在任何数据被馈送到任何上传处理程序之前被调用。

field_name是文件字段的字符串名称。

file_name是浏览器提供的unicode文件名。

content_type是浏览器提供的MIME类型，例如'image/jpeg'。

content_length是浏览器给出的图像的长度。有时这将不提供，将None。

charset是字符集（即utf8）。像content_length，有时不会提供。

content_type_extra是来自content-type标头的有关文件的额外信息。

FileUploadHandler.upload_complete()
回调信号表示整个上传（所有文件）已完成。

FileUploadHandler.handle_raw_input
(input_data, META, content_length, boundary, encoding)允许处理程序完全覆盖原始HTTP输入的解析。
input_data是支持read()的类文件对象。
META与request.META具有相同的对象。
content_length是input_data中数据的长度。不要从input_data读取超过content_length个字节。
boundary是此请求的MIME边界。
encoding是请求的编码。
如果您想要继续上传处理，或返回（POST， FILES）的元组，请返回None以直接返回适合该请求的新数据结构。