Skip to content

Commit a8bdf10

Browse files
author
Oliver Sauder
committed
Preserve values from being formatted
Introduce `JSON_API_FORMAT_FIELD_NAMES` which preserves keys of values. `JSON_API_FORMAT_KEYS` still exists but is deprecated.
1 parent 028f191 commit a8bdf10

File tree

13 files changed

+133
-28
lines changed

13 files changed

+133
-28
lines changed

‎example/api/resources/identity.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def posts(self, request):
3737
encoding.force_text('identities'): IdentitySerializer(identities, many=True).data,
3838
encoding.force_text('posts'): PostSerializer(posts, many=True).data,
3939
}
40-
return Response(utils.format_keys(data, format_type='camelize'))
40+
return Response(utils.format_field_names(data, format_type='camelize'))
4141

4242
@detail_route()
4343
def manual_resource_name(self, request, *args, **kwargs):

‎example/settings/dev.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565

6666
INTERNAL_IPS = ('127.0.0.1', )
6767

68-
JSON_API_FORMAT_KEYS = 'camelize'
68+
JSON_API_FORMAT_FIELD_NAMES = 'camelize'
6969
JSON_API_FORMAT_TYPES = 'camelize'
7070
REST_FRAMEWORK = {
7171
'PAGE_SIZE': 5,

‎example/settings/test.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
ROOT_URLCONF = 'example.urls_test'
1111

12-
JSON_API_FORMAT_KEYS = 'camelize'
12+
JSON_API_FIELD_NAMES = 'camelize'
1313
JSON_API_FORMAT_TYPES = 'camelize'
1414
JSON_API_PLURALIZE_TYPES = True
1515
REST_FRAMEWORK.update({

‎example/tests/test_generic_viewset.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from example.tests import TestBase
55

66

7-
@override_settings(JSON_API_FORMAT_KEYS='dasherize')
7+
@override_settings(JSON_API_FORMAT_FIELD_NAMES='dasherize')
88
class GenericViewSet(TestBase):
99
"""
1010
Test expected responses coming from a Generic ViewSet

‎example/tests/test_model_viewsets.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from example.tests import TestBase
88

99

10-
@override_settings(JSON_API_FORMAT_KEYS='dasherize')
10+
@override_settings(JSON_API_FORMAT_FIELD_NAMES='dasherize')
1111
class ModelViewSetTests(TestBase):
1212
"""
1313
Test usage with ModelViewSets, also tests pluralization, camelization,

‎example/tests/test_parsers.py

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import json
22
from io import BytesIO
33

4-
from django.test import TestCase
4+
from django.test import TestCase, override_settings
55
from rest_framework.exceptions import ParseError
66

77
from rest_framework_json_api.parsers import JSONParser
@@ -22,7 +22,10 @@ def __init__(self):
2222
data = {
2323
'data': {
2424
'id': 123,
25-
'type': 'Blog'
25+
'type': 'Blog',
26+
'attributes': {
27+
'json-value': {'JsonKey': 'JsonValue'}
28+
},
2629
},
2730
'meta': {
2831
'random_key': 'random_value'
@@ -31,13 +34,25 @@ def __init__(self):
3134

3235
self.string = json.dumps(data)
3336

34-
def test_parse_include_metadata(self):
37+
@override_settings(JSON_API_FORMAT_KEYS='camelize')
38+
def test_parse_include_metadata_format_keys(self):
3539
parser = JSONParser()
3640

3741
stream = BytesIO(self.string.encode('utf-8'))
3842
data = parser.parse(stream, None, self.parser_context)
3943

4044
self.assertEqual(data['_meta'], {'random_key': 'random_value'})
45+
self.assertEqual(data['json_value'], {'json_key': 'JsonValue'})
46+
47+
@override_settings(JSON_API_FORMAT_FIELD_NAMES='dasherize')
48+
def test_parse_include_metadata_format_field_names(self):
49+
parser = JSONParser()
50+
51+
stream = BytesIO(self.string.encode('utf-8'))
52+
data = parser.parse(stream, None, self.parser_context)
53+
54+
self.assertEqual(data['_meta'], {'random_key': 'random_value'})
55+
self.assertEqual(data['json_value'], {'JsonKey': 'JsonValue'})
4156

4257
def test_parse_invalid_data(self):
4358
parser = JSONParser()

‎example/tests/unit/test_renderers.py

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import json
2+
13
from rest_framework_json_api import serializers, views
24
from rest_framework_json_api.renderers import JSONRenderer
35

@@ -19,9 +21,14 @@ class DummyTestSerializer(serializers.ModelSerializer):
1921
related_models = RelatedModelSerializer(
2022
source='comments', many=True, read_only=True)
2123

24+
json_field = serializers.SerializerMethodField()
25+
26+
def get_json_field(self, entry):
27+
return {'JsonKey': 'JsonValue'}
28+
2229
class Meta:
2330
model = Entry
24-
fields = ('related_models',)
31+
fields = ('related_models', 'json_field')
2532

2633
class JSONAPIMeta:
2734
included_resources = ('related_models',)
@@ -61,3 +68,22 @@ def test_simple_reverse_relation_included_read_only_viewset():
6168
ReadOnlyDummyTestViewSet)
6269

6370
assert rendered
71+
72+
73+
def test_render_format_field_names(settings):
74+
"""Test that json field is kept untouched."""
75+
settings.JSON_API_FORMAT_FIELD_NAMES = 'dasherize'
76+
rendered = render_dummy_test_serialized_view(DummyTestViewSet)
77+
78+
result = json.loads(rendered.decode())
79+
assert result['data']['attributes']['json-field'] == {'JsonKey': 'JsonValue'}
80+
81+
82+
def test_render_format_keys(settings):
83+
"""Test that json field value keys are formated."""
84+
delattr(settings, 'JSON_API_FORMAT_FILED_NAMES')
85+
settings.JSON_API_FORMAT_KEYS = 'dasherize'
86+
rendered = render_dummy_test_serialized_view(DummyTestViewSet)
87+
88+
result = json.loads(rendered.decode())
89+
assert result['data']['attributes']['json-field'] == {'json-key': 'JsonValue'}

‎example/tests/unit/test_settings.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ def test_settings_default():
1313

1414

1515
def test_settings_override(settings):
16-
settings.JSON_API_FORMAT_KEYS = 'dasherize'
17-
assert json_api_settings.FORMAT_KEYS == 'dasherize'
16+
settings.JSON_API_FORMAT_FIELD_NAMES = 'dasherize'
17+
assert json_api_settings.FORMAT_FIELD_NAMES == 'dasherize'

‎example/tests/unit/test_utils.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,19 @@ def test_format_keys():
8484
assert utils.format_keys([underscored], 'dasherize') == output
8585

8686

87+
@pytest.mark.parametrize("format_type,output", [
88+
('camelize', {'fullName': {'last-name': 'a', 'first-name': 'b'}}),
89+
('capitalize', {'FullName': {'last-name': 'a', 'first-name': 'b'}}),
90+
('dasherize', {'full-name': {'last-name': 'a', 'first-name': 'b'}}),
91+
('underscore', {'full_name': {'last-name': 'a', 'first-name': 'b'}}),
92+
])
93+
def test_format_field_names(settings, format_type, output):
94+
settings.JSON_API_FORMAT_FIELD_NAMES = format_type
95+
96+
value = {'full_name': {'last-name': 'a', 'first-name': 'b'}}
97+
assert utils.format_field_names(value, format_type) == output
98+
99+
87100
def test_format_value():
88101
assert utils.format_value('first_name', 'camelize') == 'firstName'
89102
assert utils.format_value('first_name', 'capitalize') == 'FirstName'

‎rest_framework_json_api/parsers.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,26 @@ class JSONParser(parsers.JSONParser):
3232
@staticmethod
3333
def parse_attributes(data):
3434
attributes = data.get('attributes')
35-
uses_format_translation = json_api_settings.FORMAT_KEYS
35+
uses_format_translation = json_api_settings.format_type
3636

3737
if not attributes:
3838
return dict()
3939
elif uses_format_translation:
4040
# convert back to python/rest_framework's preferred underscore format
41-
return utils.format_keys(attributes, 'underscore')
41+
return utils._format_object(attributes, 'underscore')
4242
else:
4343
return attributes
4444

4545
@staticmethod
4646
def parse_relationships(data):
47-
uses_format_translation = json_api_settings.FORMAT_KEYS
47+
uses_format_translation = json_api_settings.format_type
4848
relationships = data.get('relationships')
4949

5050
if not relationships:
5151
relationships = dict()
5252
elif uses_format_translation:
5353
# convert back to python/rest_framework's preferred underscore format
54-
relationships = utils.format_keys(relationships, 'underscore')
54+
relationships = utils._format_object(relationships, 'underscore')
5555

5656
# Parse the relationships
5757
parsed_relationships = dict()

‎rest_framework_json_api/renderers.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def extract_attributes(cls, fields, resource):
6868
field_name: resource.get(field_name)
6969
})
7070

71-
return utils.format_keys(data)
71+
return utils._format_object(data)
7272

7373
@classmethod
7474
def extract_relationships(cls, fields, resource, resource_instance):
@@ -281,7 +281,7 @@ def extract_relationships(cls, fields, resource, resource_instance):
281281
})
282282
continue
283283

284-
return utils.format_keys(data)
284+
return utils._format_object(data)
285285

286286
@classmethod
287287
def extract_relation_instance(cls, field_name, field, resource_instance, serializer):
@@ -405,7 +405,7 @@ def extract_included(cls, fields, resource, resource_instance, included_resource
405405
getattr(serializer, '_poly_force_type_resolution', False)
406406
)
407407
included_cache[new_item['type']][new_item['id']] = \
408-
utils.format_keys(new_item)
408+
utils._format_object(new_item)
409409
cls.extract_included(
410410
serializer_fields,
411411
serializer_resource,
@@ -427,7 +427,9 @@ def extract_included(cls, fields, resource, resource_instance, included_resource
427427
relation_type,
428428
getattr(field, '_poly_force_type_resolution', False)
429429
)
430-
included_cache[new_item['type']][new_item['id']] = utils.format_keys(new_item)
430+
included_cache[new_item['type']][new_item['id']] = utils._format_object(
431+
new_item
432+
)
431433
cls.extract_included(
432434
serializer_fields,
433435
serializer_data,
@@ -577,7 +579,7 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
577579
)
578580
meta = self.extract_meta(serializer, resource)
579581
if meta:
580-
json_resource_obj.update({'meta': utils.format_keys(meta)})
582+
json_resource_obj.update({'meta': utils._format_object(meta)})
581583
json_api_data.append(json_resource_obj)
582584

583585
self.extract_included(
@@ -594,7 +596,7 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
594596

595597
meta = self.extract_meta(serializer, serializer_data)
596598
if meta:
597-
json_api_data.update({'meta': utils.format_keys(meta)})
599+
json_api_data.update({'meta': utils._format_object(meta)})
598600

599601
self.extract_included(
600602
fields, serializer_data, resource_instance, included_resources, included_cache
@@ -620,7 +622,7 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
620622
render_data['included'].append(included_cache[included_type][included_id])
621623

622624
if json_api_meta:
623-
render_data['meta'] = utils.format_keys(json_api_meta)
625+
render_data['meta'] = utils._format_object(json_api_meta)
624626

625627
return super(JSONRenderer, self).render(
626628
render_data, accepted_media_type, renderer_context

‎rest_framework_json_api/settings.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,15 @@
1010
JSON_API_SETTINGS_PREFIX = 'JSON_API_'
1111

1212
DEFAULTS = {
13-
'FORMAT_KEYS': False,
14-
'FORMAT_RELATION_KEYS': None,
13+
'FORMAT_FIELD_NAMES': False,
1514
'FORMAT_TYPES': False,
16-
'PLURALIZE_RELATION_TYPE': None,
1715
'PLURALIZE_TYPES': False,
1816
'UNIFORM_EXCEPTIONS': False,
17+
18+
# deprecated settings to be removed in the future
19+
'FORMAT_KEYS': None,
20+
'FORMAT_RELATION_KEYS': None,
21+
'PLURALIZE_RELATION_TYPE': None,
1922
}
2023

2124

@@ -39,6 +42,13 @@ def __getattr__(self, attr):
3942
setattr(self, attr, value)
4043
return value
4144

45+
@property
46+
def format_type(self):
47+
if self.FORMAT_KEYS is not None:
48+
return self.FORMAT_KEYS
49+
50+
return self.FORMAT_FIELD_NAMES
51+
4252

4353
json_api_settings = JSONAPISettings()
4454

‎rest_framework_json_api/utils.py

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,50 @@ def get_serializer_fields(serializer):
9898
return fields
9999

100100

101+
def format_field_names(obj, format_type=None):
102+
"""
103+
Takes a dict and returns it with formatted keys as set in `format_type`
104+
or `JSON_API_FORMAT_FIELD_NAMES`
105+
106+
:format_type: Either 'dasherize', 'camelize', 'capitalize' or 'underscore'
107+
"""
108+
if format_type is None:
109+
format_type = json_api_settings.FORMAT_FIELD_NAMES
110+
111+
if isinstance(obj, dict):
112+
formatted = OrderedDict()
113+
for key, value in obj.items():
114+
key = format_value(key, format_type)
115+
formatted[key] = value
116+
return formatted
117+
118+
return obj
119+
120+
121+
def _format_object(obj, format_type=None):
122+
"""Depending on settings calls either `format_keys` or `format_field_names`"""
123+
124+
if json_api_settings.FORMAT_KEYS is not None:
125+
return format_keys(obj, format_type)
126+
127+
return format_field_names(obj, format_type)
128+
129+
101130
def format_keys(obj, format_type=None):
102131
"""
103132
Takes either a dict or list and returns it with camelized keys only if
104133
JSON_API_FORMAT_KEYS is set.
105134
106-
:format_type: Either 'dasherize', 'camelize' or 'underscore'
135+
:format_type: Either 'dasherize', 'camelize', 'capitalize' or 'underscore'
107136
"""
137+
warnings.warn(
138+
"`format_keys` function and `JSON_API_FORMAT_KEYS` setting are deprecated and will be "
139+
"removed in the future. "
140+
"Use `format_field_names` and `JSON_API_FIELD_NAMES` instead. Be aware that "
141+
"`format_field_names` only formats keys and preserves value.",
142+
DeprecationWarning
143+
)
144+
108145
if format_type is None:
109146
format_type = json_api_settings.FORMAT_KEYS
110147

@@ -138,7 +175,7 @@ def format_keys(obj, format_type=None):
138175

139176
def format_value(value, format_type=None):
140177
if format_type is None:
141-
format_type = json_api_settings.FORMAT_KEYS
178+
format_type = json_api_settings.format_type
142179
if format_type == 'dasherize':
143180
# inflection can't dasherize camelCase
144181
value = inflection.underscore(value)
@@ -155,7 +192,9 @@ def format_value(value, format_type=None):
155192
def format_relation_name(value, format_type=None):
156193
warnings.warn(
157194
"The 'format_relation_name' function has been renamed 'format_resource_type' and the "
158-
"settings are now 'JSON_API_FORMAT_TYPES' and 'JSON_API_PLURALIZE_TYPES'"
195+
"settings are now 'JSON_API_FORMAT_TYPES' and 'JSON_API_PLURALIZE_TYPES' instead of "
196+
"'JSON_API_FORMAT_RELATION_KEYS' and 'JSON_API_PLURALIZE_RELATION_TYPE'",
197+
DeprecationWarning
159198
)
160199
if format_type is None:
161200
format_type = json_api_settings.FORMAT_RELATION_KEYS

0 commit comments

Comments
 (0)