interpret drfdocs_exclude field

Author: Dan Schien

rest_framework_docs/api_docs.py

@@ -27,7 +27,8 @@ def get_all_view_names(self, urlpatterns, parent_pattern=None):
                 self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_pattern=parent_pattern)
             elif isinstance(pattern, RegexURLPattern) and self._is_drf_view(pattern) and not self._is_format_endpoint(pattern):
                 api_endpoint = ApiEndpoint(pattern, parent_pattern)
-                self.endpoints.append(api_endpoint)
+                if not api_endpoint.exclude:
+                    self.endpoints.append(api_endpoint)
 
     def _is_drf_view(self, pattern):
         """

rest_framework_docs/api_endpoint.py

@@ -5,7 +5,6 @@
 
 
 class ApiEndpoint(object):
-
     def __init__(self, pattern, parent_pattern=None):
         self.pattern = pattern
         self.callback = pattern.callback
@@ -19,6 +18,7 @@ def __init__(self, pattern, parent_pattern=None):
         self.fields = self.__get_serializer_fields__()
         self.fields_json = self.__get_serializer_fields_json__()
         self.permissions = self.__get_permissions_class__()
+        self.exclude = getattr(self.callback.cls, 'drfdocs_exclude', False)
 
     def __get_path__(self, parent_pattern):
         if parent_pattern:
@@ -42,17 +42,16 @@ def __get_serializer_fields__(self):
             serializer = self.callback.cls.serializer_class
             if hasattr(serializer, 'get_fields'):
                 try:
-                    fields = [{
-                        "name": key,
-                        "type": str(field.__class__.__name__),
-                        "required": field.required
-                    } for key, field in serializer().get_fields().items()]
+                    fields = [{"name": key,
+                               "type": str(field.__class__.__name__),
+                               "required": field.required
+                               } for key, field in serializer().get_fields().items()]
                 except KeyError as e:
                     self.errors = e
                     fields = []
 
-                # FIXME:
-                # Show more attibutes of `field`?
+                    # FIXME:
+                    # Show more attibutes of `field`?
 
         return fields
 

tests/tests.py

@@ -4,7 +4,6 @@
 
 
 class DRFDocsViewTests(TestCase):
-
     SETTINGS_HIDE_DOCS = {
         'HIDE_DOCS': True  # Default: False
     }
@@ -13,7 +12,6 @@ def setUp(self):
         super(DRFDocsViewTests, self).setUp()
 
     def test_settings_module(self):
-
         settings = DRFSettings()
 
         self.assertEqual(settings.get_setting("HIDE_DOCS"), False)
@@ -33,7 +31,8 @@ def test_index_view_with_endpoints(self):
         self.assertEqual(response.context["endpoints"][0].name_parent, "accounts")
         self.assertEqual(response.context["endpoints"][0].allowed_methods, ['POST', 'OPTIONS'])
         self.assertEqual(response.context["endpoints"][0].path, "/accounts/login/")
-        self.assertEqual(response.context["endpoints"][0].docstring, "A view that allows users to login providing their username and password.")
+        self.assertEqual(response.context["endpoints"][0].docstring,
+                         "A view that allows users to login providing their username and password.")
         self.assertEqual(len(response.context["endpoints"][0].fields), 2)
         self.assertEqual(response.context["endpoints"][0].fields[0]["type"], "CharField")
         self.assertTrue(response.context["endpoints"][0].fields[0]["required"])

tests/urls.py

@@ -13,6 +13,7 @@
     url(r'^user/profile/$', views.UserProfileView.as_view(), name="profile"),
 
     url(r'^test/$', views.TestView.as_view(), name="test-view"),
+    url(r'^exclude/$', views.ExcludedTestView.as_view(), name="test-exclude"),
 ]
 
 organisations_urls = [

tests/views.py

@@ -19,11 +19,18 @@ class TestView(TemplateView):
     template_name = "a_test.html"
 
 
+class ExcludedTestView(APIView):
+    """
+    This view should not be included in DRF Docs.
+    """
+    drfdocs_exclude = True
+
+
 class LoginView(APIView):
     """
     A view that allows users to login providing their username and password.
     """
-
+    drfdocs_exclude = False
     throttle_classes = ()
     permission_classes = ()
     parser_classes = (parsers.FormParser, parsers.MultiPartParser, parsers.JSONParser,)
@@ -39,7 +46,6 @@ def post(self, request):
 
 
 class UserRegistrationView(generics.CreateAPIView):
-
     permission_classes = (AllowAny,)
     serializer_class = serializers.UserRegistrationSerializer
 
@@ -56,7 +62,6 @@ def get_object(self):
 
 
 class PasswordResetView(APIView):
-
     permission_classes = (AllowAny,)
     queryset = User.objects.all()
 
@@ -72,7 +77,6 @@ def post(self, request, *args, **kwargs):
 
 
 class PasswordResetConfirmView(APIView):
-
     permission_classes = (AllowAny,)
     serializer_class = serializers.ResetPasswordSerializer
 
@@ -84,12 +88,10 @@ def post(self, request, *args, **kwargs):
 
 
 class CreateOrganisationView(generics.CreateAPIView):
-
     serializer_class = serializers.CreateOrganisationSerializer
 
 
 class OrganisationMembersView(generics.ListAPIView):
-
     serializer_class = serializers.OrganisationMembersSerializer
 
     def get_queryset(self):
@@ -98,7 +100,6 @@ def get_queryset(self):
 
 
 class LeaveOrganisationView(generics.DestroyAPIView):
-
     def get_object(self):
         return Membership.objects.order_by('?').first()
 
@@ -109,5 +110,4 @@ def delete(self, request, *args, **kwargs):
 
 
 class OrganisationErroredView(generics.ListAPIView):
-
     serializer_class = serializers.OrganisationErroredSerializer