encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-27 08:29:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added support for the sort_keys argument to JSONRenderer

Browse Source
This commit is contained in:
Daniel Bradburn 2021-09-14 15:22:52 +02:00
parent f0a5b958a1
commit cd11bb4637
4 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api-guide/settings.md
View File

@ -348,6 +348,14 @@ When set to `False`, JSON rendering and parsing will be permissive. However, the
Default: `True` Default: `True`
#### SORT_KEYS_JSON
When set to `True`, Keys will be sorted before JSON rendering (see json.dumps sort_keys)
When set to `False`, Keys will be sorted before JSON rendering (see json.dumps sort_keys)
Default: `False`
#### COERCE_DECIMAL_TO_STRING #### COERCE_DECIMAL_TO_STRING
When returning decimal objects in API representations that do not support a native decimal type, it is normally best to return the value as a string. This avoids the loss of precision that occurs with binary floating point implementations. When returning decimal objects in API representations that do not support a native decimal type, it is normally best to return the value as a string. This avoids the loss of precision that occurs with binary floating point implementations.

3
rest_framework/renderers.py
View File

@ -60,6 +60,7 @@ class JSONRenderer(BaseRenderer):
ensure_ascii = not api_settings.UNICODE_JSON ensure_ascii = not api_settings.UNICODE_JSON
compact = api_settings.COMPACT_JSON compact = api_settings.COMPACT_JSON
strict = api_settings.STRICT_JSON strict = api_settings.STRICT_JSON
sort_keys = api_settings.SORT_KEYS_JSON
# We don't set a charset because JSON is a binary encoding, # We don't set a charset because JSON is a binary encoding,
# that can be encoded as utf-8, utf-16 or utf-32. # that can be encoded as utf-8, utf-16 or utf-32.
@ -100,7 +101,7 @@ class JSONRenderer(BaseRenderer):
ret = json.dumps( ret = json.dumps(
data, cls=self.encoder_class, data, cls=self.encoder_class,
indent=indent, ensure_ascii=self.ensure_ascii, indent=indent, ensure_ascii=self.ensure_ascii,
allow_nan=not self.strict, separators=separators allow_nan=not self.strict, separators=separators, sort_keys=self.sort_keys
) )
# We always fully escape \u2028 and \u2029 to ensure we output JSON # We always fully escape \u2028 and \u2029 to ensure we output JSON

1
rest_framework/settings.py
View File

@ -111,6 +111,7 @@ DEFAULTS = {
'UNICODE_JSON': True, 'UNICODE_JSON': True,
'COMPACT_JSON': True, 'COMPACT_JSON': True,
'STRICT_JSON': True, 'STRICT_JSON': True,
'SORT_KEYS_JSON': False,
'COERCE_DECIMAL_TO_STRING': True, 'COERCE_DECIMAL_TO_STRING': True,
'UPLOADED_FILES_USE_URL': True, 'UPLOADED_FILES_USE_URL': True,

7
tests/test_renderers.py
View File

@ -391,6 +391,13 @@ class JSONRendererTests(TestCase):
content = renderer.render(obj, 'application/json; indent=2') content = renderer.render(obj, 'application/json; indent=2')
self.assertEqual(strip_trailing_whitespace(content.decode()), _indented_repr) self.assertEqual(strip_trailing_whitespace(content.decode()), _indented_repr)
@override_settings(REST_FRAMEWORK={'SORT_KEYS_JSON': True})
def test_sort_keys_json(self):
obj = {'2': {'c': 1, 'b': 2, 'a': 3 }, '1': None}
renderer = JSONRenderer()
content = renderer.render(obj, 'application/json')
self.assertEqual(content.decode(), '{"1": null, "2": {"a": 3, "b": 2, "c": 1}}')
class UnicodeJSONRendererTests(TestCase): class UnicodeJSONRendererTests(TestCase):
""" """