From 60e266fe993eeaee75ade5b1c4d25fe990e8459c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cristi=20V=C3=AEjdea?= Date: Wed, 27 Dec 2017 20:14:12 +0100 Subject: [PATCH] Make sphinx document CamelCaseJSONFilter --- requirements/dev.txt | 1 + requirements/docs.txt | 1 + src/drf_yasg/inspectors/field.py | 3 +++ 3 files changed, 5 insertions(+) diff --git a/requirements/dev.txt b/requirements/dev.txt index 054c412..8779d94 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -1,6 +1,7 @@ # requirements for local development tox>=2.9.1 tox-battery>=0.5 +detox>=0.11 # do not unpin this (see setup.py) setuptools_scm==1.15.6 diff --git a/requirements/docs.txt b/requirements/docs.txt index 4ec8f91..44e0953 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -4,3 +4,4 @@ Pillow==4.3.0 readme_renderer==17.2 Django==2.0 +djangorestframework_camel_case>=0.2.0 diff --git a/src/drf_yasg/inspectors/field.py b/src/drf_yasg/inspectors/field.py index 7ada538..be6ab49 100644 --- a/src/drf_yasg/inspectors/field.py +++ b/src/drf_yasg/inspectors/field.py @@ -430,6 +430,7 @@ try: from djangorestframework_camel_case.render import camelize except ImportError: # pragma: no cover class CamelCaseJSONFilter(FieldInspector): + """Converts property names to camelCase if ``djangorestframework_camel_case`` is used.""" pass else: def camelize_string(s): @@ -451,6 +452,8 @@ else: return schema_or_ref class CamelCaseJSONFilter(FieldInspector): + """Converts property names to camelCase if ``CamelCaseJSONParser`` or ``CamelCaseJSONRenderer`` are used.""" + def is_camel_case(self): return any(issubclass(parser, CamelCaseJSONParser) for parser in self.view.parser_classes) \ or any(issubclass(renderer, CamelCaseJSONRenderer) for renderer in self.view.renderer_classes)