encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-01-24 08:14:16 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update accepted_media_type argument in Renderer docs (#8364)

Browse Source
This commit is contained in:
Josh 2022-02-12 10:21:59 -06:00 committed by GitHub
parent 5bea22f321
commit efc7c1d664
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api-guide/renderers.md
View File

@ -257,7 +257,7 @@ This renderer is used for rendering HTML multipart form data. **It is not suita
# Custom renderers # Custom renderers
To implement a custom renderer, you should override `BaseRenderer`, set the `.media_type` and `.format` properties, and implement the `.render(self, data, media_type=None, renderer_context=None)` method. To implement a custom renderer, you should override `BaseRenderer`, set the `.media_type` and `.format` properties, and implement the `.render(self, data, accepted_media_type=None, renderer_context=None)` method.
The method should return a bytestring, which will be used as the body of the HTTP response. The method should return a bytestring, which will be used as the body of the HTTP response.
@ -267,7 +267,7 @@ The arguments passed to the `.render()` method are:
The request data, as set by the `Response()` instantiation. The request data, as set by the `Response()` instantiation.
### `media_type=None` ### `accepted_media_type=None`
Optional. If provided, this is the accepted media type, as determined by the content negotiation stage. Optional. If provided, this is the accepted media type, as determined by the content negotiation stage.
@ -291,7 +291,7 @@ The following is an example plaintext renderer that will return a response with
media_type = 'text/plain' media_type = 'text/plain'
format = 'txt' format = 'txt'
def render(self, data, media_type=None, renderer_context=None): def render(self, data, accepted_media_type=None, renderer_context=None):
return smart_text(data, encoding=self.charset) return smart_text(data, encoding=self.charset)
## Setting the character set ## Setting the character set
@ -303,7 +303,7 @@ By default renderer classes are assumed to be using the `UTF-8` encoding. To us
format = 'txt' format = 'txt'
charset = 'iso-8859-1' charset = 'iso-8859-1'
def render(self, data, media_type=None, renderer_context=None): def render(self, data, accepted_media_type=None, renderer_context=None):
return data.encode(self.charset) return data.encode(self.charset)
Note that if a renderer class returns a unicode string, then the response content will be coerced into a bytestring by the `Response` class, with the `charset` attribute set on the renderer used to determine the encoding. Note that if a renderer class returns a unicode string, then the response content will be coerced into a bytestring by the `Response` class, with the `charset` attribute set on the renderer used to determine the encoding.
@ -318,7 +318,7 @@ In some cases you may also want to set the `render_style` attribute to `'binary'
charset = None charset = None
render_style = 'binary' render_style = 'binary'
def render(self, data, media_type=None, renderer_context=None): def render(self, data, accepted_media_type=None, renderer_context=None):
return data return data
--- ---