Docs for FileUploadParser

This commit is contained in:
Tom Christie 2013-05-07 13:27:27 +01:00
parent 642970a1b8
commit 3353889ae8
4 changed files with 17 additions and 7 deletions

View File

@ -104,13 +104,18 @@ You will typically want to use both `FormParser` and `MultiPartParser` together
## FileUploadParser
Parses raw file upload content. Returns a `DataAndFiles` object. Since we expect the whole request body to be a file content `request.DATA` will be None, and `request.FILES` will contain the only one key `'file'` matching the uploaded file.
Parses raw file upload content. The `request.DATA` property will be an empty `QueryDict`, and `request.FILES` will be a dictionary with a single key `'file'` containing the uploaded file.
The `filename` property of uploaded file would be set to the result of `.get_filename()` method. By default it tries first to take it's value from the `filename` URL kwarg, and then from `Content-Disposition` HTTP header. You can implement other behaviour be overriding this method.
If the view used with `FileUploadParser` is called with a `filename` URL keyword argument, then that argument will be used as the filename. If it is called without a `filename` URL keyword argument, then the client must set the filename in the `Content-Disposition` HTTP header. For example `Content-Disposition: attachment; filename=upload.jpg`.
Note that since this parser's `media_type` matches every HTTP request it imposes restrictions on usage in combination with other parsers for the same API view.
**.media_type**: `*/*`
Basic usage expamle:
##### Notes:
* The `FileUploadParser` is for usage with native clients that can upload the file as a raw data request. For web-based uploads, or for native clients with multipart upload support, you should use the `MultiPartParser` parser instead.
* Since this parser's `media_type` matches any content type, `FileUploadParser` should generally be the only parser set on an API view.
##### Basic usage example:
class FileUploadView(views.APIView):
parser_classes = (FileUploadParser,)
@ -122,7 +127,6 @@ Basic usage expamle:
# ...
return Response(status=204)
**.media_type**: `*/*`
---

View File

@ -187,6 +187,10 @@ For example, you might have a field that references it's relationship by a hyper
Usage of the old-style attributes continues to be supported, but will raise a `PendingDeprecationWarning`.
## FileUploadParser
2.3 adds a `FileUploadParser` parser class, that supports raw file uploads, in addition to the existing multipart upload support.
## DecimalField
2.3 introduces a `DecimalField` serializer field, which returns `Decimal` instances.

View File

@ -47,6 +47,7 @@ You can determine your currently installed version using `pip freeze`:
* HyperLinkedModelSerializers support 'id' field in 'fields' option.
* Cleaner generic views.
* Support for multiple filter classes.
* FileUploadParser support for raw file uploads.
* DecimalField support.
* Bugfix: Fix issue with depth>1 on ModelSerializer.

View File

@ -246,7 +246,7 @@ class FileUploadParser(BaseParser):
return DataAndFiles(None, {'file': result[1]})
possible_sizes = [x.chunk_size for x in upload_handlers if x.chunk_size]
chunk_size = min([2**31-4] + possible_sizes)
chunk_size = min([2 ** 31 - 4] + possible_sizes)
chunks = ChunkIter(stream, chunk_size)
counters = [0] * len(upload_handlers)
@ -280,9 +280,10 @@ class FileUploadParser(BaseParser):
return parser_context['kwargs']['filename']
except KeyError:
pass
try:
meta = parser_context['request'].META
disposition = parse_header(meta['HTTP_CONTENT_DISPOSITION'])
return disposition[1]['filename']
except (AttributeError, KeyError):
pass
raise ParseError("Filename must be set in Content-Disposition header.")