diff options
| author | Tom Christie | 2012-10-17 22:07:56 +0100 | 
|---|---|---|
| committer | Tom Christie | 2012-10-17 22:07:56 +0100 | 
| commit | 99d48f90030d174ef80498b48f56af6489865f0d (patch) | |
| tree | 4c4181d708fc6733c3f4459af7235fe1a17f0632 /docs/api-guide/parsers.md | |
| parent | 6717d654d0bbfdfca4aaea84a5b4814c4e5f7567 (diff) | |
| download | django-rest-framework-99d48f90030d174ef80498b48f56af6489865f0d.tar.bz2 | |
Drop .parse_string_or_stream() - keep API minimal.
Diffstat (limited to 'docs/api-guide/parsers.md')
| -rw-r--r-- | docs/api-guide/parsers.md | 10 | 
1 files changed, 5 insertions, 5 deletions
| diff --git a/docs/api-guide/parsers.md b/docs/api-guide/parsers.md index 4f145ba3..a950c0e0 100644 --- a/docs/api-guide/parsers.md +++ b/docs/api-guide/parsers.md @@ -91,11 +91,11 @@ You will typically want to use both `FormParser` and `MultiPartParser` together  # Custom parsers -To implement a custom parser, you should override `BaseParser`, set the `.media_type` property, and implement the `.parse_stream(self, stream, parser_context)` method. +To implement a custom parser, you should override `BaseParser`, set the `.media_type` property, and implement the `.parse(self, stream, parser_context)` method.  The method should return the data that will be used to populate the `request.DATA` property. -The arguments passed to `.parse_stream()` are: +The arguments passed to `.parse()` are:  ### stream @@ -116,7 +116,7 @@ The following is an example plaintext parser that will populate the `request.DAT      media_type = 'text/plain' -    def parse_stream(self, stream, parser_context=None): +    def parse(self, stream, parser_context=None):          """          Simply return a string representing the body of the request.          """ @@ -124,7 +124,7 @@ The following is an example plaintext parser that will populate the `request.DAT  ## Uploading file content -If your custom parser needs to support file uploads, you may return a `DataAndFiles` object from the `.parse_stream()` method.  `DataAndFiles` should be instantiated with two arguments.  The first argument will be used to populate the `request.DATA` property, and the second argument will be used to populate the `request.FILES` property. +If your custom parser needs to support file uploads, you may return a `DataAndFiles` object from the `.parse()` method.  `DataAndFiles` should be instantiated with two arguments.  The first argument will be used to populate the `request.DATA` property, and the second argument will be used to populate the `request.FILES` property.  For example: @@ -133,7 +133,7 @@ For example:          A naive raw file upload parser.          """ -        def parse_stream(self, stream, parser_context): +        def parse(self, stream, parser_context):              content = stream.read()              name = 'example.dat'              content_type = 'application/octet-stream' | 
