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 wrapper around an uploaded file.
You'll usually use one of these methods to access the uploaded content:
chunks()instead; see below.
Trueif 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.
A generator returning chunks of the file. If
True, you should use this method in a loop instead of
In practice, it's often easiest to use
chunks() all the time. Looping
chunks() instead of using
read() ensures that large files
don't overwhelm your system's memory.
Here are some useful attributes of
content-typeheader. 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).
utf8) supplied by the browser. Again, "trust but verify" is the best policy here.
Like regular Python files, you can read the file line-by-line by iterating over the uploaded file:
for line in uploadedfile: do_something_with(line)
Lines are split using universal newlines. The following are recognized
as ending a line: the Unix end-of-line convention
'\n', the Windows
'\r\n', and the old Macintosh convention
TemporaryFileUploadHandler. In addition to the methods from
UploadedFile, it has one additional method:
TemporaryFileUploadHandler provide Django's default file upload
behavior of reading small files into memory and large ones onto disk. They
are located in
File upload handler to stream uploads into memory (used for small files).
Upload handler that streams data into a temporary file using
All file upload handlers should be subclasses of
django.core.files.uploadhandler.FileUploadHandler. You can define upload
handlers wherever you wish.
Custom file upload handlers must define the following methods:
Receives a "chunk" of data from the file upload.
raw_data is a bytestring containing the uploaded data.
start is the position in the file where this
The data you return will get fed into the subsequent upload handlers'
receive_data_chunk methods. In this way, one handler can be a
"filter" for other handlers.
receive_data_chunk to short-circuit remaining
upload handlers from getting this chunk. This is useful if you're
storing the uploaded data yourself and don't want future handlers to
store a copy of the data.
If you raise a
StopUpload or a
SkipFile exception, the upload
will abort or the file will be completely skipped.
Called when a file has finished uploading.
The handler should return an
UploadedFile object that will be stored
request.FILES. Handlers may also return
None to indicate that
UploadedFile object should come from subsequent upload handlers.
Custom upload handlers may also define any of the following optional methods or attributes:
Size, in bytes, of the "chunks" Django should store into memory and feed
into the handler. That is, this attribute controls the size of chunks
For maximum performance the chunk sizes should be divisible by
should not exceed 2 GB (231 bytes) in size. When there are
multiple chunk sizes provided by multiple handlers, Django will use the
smallest chunk size defined by any handler.
The default is 64*210 bytes, or 64 KB.
new_file(field_name, file_name, content_type, content_length, charset, content_type_extra)
Callback signaling that a new file upload is starting. This is called before any data has been fed to any upload handlers.
field_name is a string name of the file
file_name is the filename provided by the browser.
content_type is the MIME type provided by the browser -- E.g.
content_length is the length of the image given by the browser.
Sometimes this won't be provided and will be
charset is the character set (i.e.
utf8) given by the browser.
content_length, this sometimes won't be provided.
content_type_extra is extra information about the file from the
content-type header. See
This method may raise a
StopFutureHandlers exception to prevent
future handlers from handling this file.
handle_raw_input(input_data, META, content_length, boundary, encoding)
Allows the handler to completely override the parsing of the raw HTTP input.
input_data is a file-like object that supports
META is the same object as
content_length is the length of the data in
read more than
content_length bytes from
boundary is the MIME boundary for this request.
encoding is the encoding of the request.
None if you want upload handling to continue, or a tuple of
(POST, FILES) if you want to return the new data structures suitable
for the request directly.