Make sphinx document CamelCaseJSONFilter

openapi3
Cristi Vîjdea 2017-12-27 20:14:12 +01:00
parent 1f190744cd
commit 60e266fe99
3 changed files with 5 additions and 0 deletions

View File

@ -1,6 +1,7 @@
# requirements for local development # requirements for local development
tox>=2.9.1 tox>=2.9.1
tox-battery>=0.5 tox-battery>=0.5
detox>=0.11
# do not unpin this (see setup.py) # do not unpin this (see setup.py)
setuptools_scm==1.15.6 setuptools_scm==1.15.6

View File

@ -4,3 +4,4 @@ Pillow==4.3.0
readme_renderer==17.2 readme_renderer==17.2
Django==2.0 Django==2.0
djangorestframework_camel_case>=0.2.0

View File

@ -430,6 +430,7 @@ try:
from djangorestframework_camel_case.render import camelize from djangorestframework_camel_case.render import camelize
except ImportError: # pragma: no cover except ImportError: # pragma: no cover
class CamelCaseJSONFilter(FieldInspector): class CamelCaseJSONFilter(FieldInspector):
"""Converts property names to camelCase if ``djangorestframework_camel_case`` is used."""
pass pass
else: else:
def camelize_string(s): def camelize_string(s):
@ -451,6 +452,8 @@ else:
return schema_or_ref return schema_or_ref
class CamelCaseJSONFilter(FieldInspector): class CamelCaseJSONFilter(FieldInspector):
"""Converts property names to camelCase if ``CamelCaseJSONParser`` or ``CamelCaseJSONRenderer`` are used."""
def is_camel_case(self): def is_camel_case(self):
return any(issubclass(parser, CamelCaseJSONParser) for parser in self.view.parser_classes) \ return any(issubclass(parser, CamelCaseJSONParser) for parser in self.view.parser_classes) \
or any(issubclass(renderer, CamelCaseJSONRenderer) for renderer in self.view.renderer_classes) or any(issubclass(renderer, CamelCaseJSONRenderer) for renderer in self.view.renderer_classes)