Rename setting and add documentation

This commit is contained in:
Jonathan Kim 2019-06-25 09:59:39 +01:00
parent e2e496f505
commit cc44dd849b
5 changed files with 21 additions and 10 deletions

View File

@ -101,3 +101,18 @@ Default: ``100``
GRAPHENE = {
'RELAY_CONNECTION_MAX_LIMIT': 100,
}
``CAMELCASE_ERRORS``
------------------------------------
When set to ``True`` field names in the ``errors`` object will be camel case.
By default they will be snake case.
Default: ``False``
.. code:: python
GRAPHENE = {
'CAMELCASE_ERRORS': False,
}

View File

@ -53,10 +53,10 @@ def test_mutation_error_camelcased():
result = PetMutation.mutate_and_get_payload(None, None)
assert {f.field for f in result.errors} == {"name", "age", "test_field"}
graphene_settings.DJANGO_GRAPHENE_CAMELCASE_ERRORS = True
graphene_settings.CAMELCASE_ERRORS = True
result = PetMutation.mutate_and_get_payload(None, None)
assert {f.field for f in result.errors} == {"name", "age", "testField"}
graphene_settings.DJANGO_GRAPHENE_CAMELCASE_ERRORS = False
graphene_settings.CAMELCASE_ERRORS = False
class ModelFormMutationTests(TestCase):

View File

@ -215,10 +215,10 @@ def test_model_mutate_and_get_payload_error():
def test_mutation_error_camelcased():
graphene_settings.DJANGO_GRAPHENE_CAMELCASE_ERRORS = True
graphene_settings.CAMELCASE_ERRORS = True
result = MyModelMutation.mutate_and_get_payload(None, mock_info(), **{})
assert result.errors[0].field == "coolName"
graphene_settings.DJANGO_GRAPHENE_CAMELCASE_ERRORS = False
graphene_settings.CAMELCASE_ERRORS = False
def test_invalid_serializer_operations():

View File

@ -35,7 +35,7 @@ DEFAULTS = {
"RELAY_CONNECTION_ENFORCE_FIRST_OR_LAST": False,
# Max items returned in ConnectionFields / FilterConnectionFields
"RELAY_CONNECTION_MAX_LIMIT": 100,
"DJANGO_GRAPHENE_CAMELCASE_ERRORS": False,
"CAMELCASE_ERRORS": False,
}
if settings.DEBUG:

View File

@ -191,9 +191,5 @@ class ErrorType(ObjectType):
@classmethod
def from_errors(cls, errors):
data = (
camelize(errors)
if graphene_settings.DJANGO_GRAPHENE_CAMELCASE_ERRORS
else errors
)
data = camelize(errors) if graphene_settings.CAMELCASE_ERRORS else errors
return [ErrorType(field=key, messages=value) for key, value in data.items()]