Uploaded Files and Upload HandlersLink to this heading#

Uploaded filesLink to this heading#

class UploadedFileLink to this definition#

During file uploads, the actual file data is stored in request.FILES. Each entry in this dictionary is an UploadedFile object (or a subclass) -- a simple wrapper around an uploaded file. You'll usually use one of these methods to access the uploaded content:

UploadedFile.read()Link to this definition#

Read the entire uploaded data from the file. Be careful with this method: if the uploaded file is huge it can overwhelm your system if you try to read it into memory. You'll probably want to use chunks() instead; see below.

UploadedFile.multiple_chunks(chunk_size=None)Link to this definition#

Returns True if the uploaded file is big enough to require reading in multiple chunks. By default this will be any file larger than 2.5 megabytes, but that's configurable; see below.

UploadedFile.chunks(chunk_size=None)Link to this definition#

A generator returning chunks of the file. If multiple_chunks() is True, you should use this method in a loop instead of read().

In practice, it's often easiest simply to use chunks() all the time. Looping over chunks() instead of using read() ensures that large files don't overwhelm your system's memory.

Here are some useful attributes of UploadedFile:

UploadedFile.nameLink to this definition#

The name of the uploaded file (e.g. my_file.txt).

UploadedFile.sizeLink to this definition#

The size, in bytes, of the uploaded file.

UploadedFile.content_typeLink to this definition#

The content-type header uploaded with the file (e.g. text/plain or application/pdf). Like any data supplied by the user, you shouldn't trust that the uploaded file is actually this type. You'll still need to validate that the file contains the content that the content-type header claims -- "trust but verify."

UploadedFile.content_type_extraLink to this definition#

A dictionary containing extra parameters passed to the content-type header. This is typically provided by services, such as Google App Engine, that intercept and handle file uploads on your behalf. As a result your handler may not receive the uploaded file content, but instead a URL or other pointer to the file. (see RFC 2388 section 5.3).

UploadedFile.charsetLink to this definition#

For text/* content-types, the character set (i.e. utf8) supplied by the browser. Again, "trust but verify" is the best policy here.

Subclasses of UploadedFile include:

class TemporaryUploadedFileLink to this definition#

A file uploaded to a temporary location (i.e. stream-to-disk). This class is used by the TemporaryFileUploadHandler. In addition to the methods from UploadedFile, it has one additional method:

TemporaryUploadedFile.temporary_file_path()Link to this definition#

Returns the full path to the temporary uploaded file.

class InMemoryUploadedFileLink to this definition#

A file uploaded into memory (i.e. stream-to-memory). This class is used by the MemoryFileUploadHandler.

Built-in upload handlersLink to this heading#

Together the MemoryFileUploadHandler and TemporaryFileUploadHandler provide Django's default file upload behavior of reading small files into memory and large ones onto disk. They are located in django.core.files.uploadhandler.

class MemoryFileUploadHandlerLink to this definition#

File upload handler to stream uploads into memory (used for small files).

class TemporaryFileUploadHandlerLink to this definition#

Upload handler that streams data into a temporary file using TemporaryUploadedFile.

アップロードハンドラをカスタマイズするLink to this heading#

class FileUploadHandlerLink to this definition#

全てのファイルアップロードハンドラは、django.core.files.uploadhandler.FileUploadHandler のサブクラスとなります。アップロードハンドラはいつでも好きなときに定義できます。