Test docstring

Author: Emmanouil Konstantinidis

rest_framework_docs/api_endpoint.py

@@ -1,3 +1,4 @@
+import inspect
 from django.contrib.admindocs.views import simplify_regex
 
 
@@ -24,7 +25,7 @@ def __get_allowed_methods__(self):
         return [m.upper() for m in self.callback.cls.http_method_names if hasattr(self.callback.cls, m)]
 
     def __get_docstring__(self):
-        return self.callback.cls.__doc__
+        return inspect.getdoc(self.callback)
 
     def __get_serializer_fields__(self):
         fields = []

tests/tests.py

@@ -33,6 +33,7 @@ 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(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/views.py

@@ -20,6 +20,9 @@ class TestView(TemplateView):
 
 
 class LoginView(APIView):
+    """
+    A view that allows users to login providing their username and password.
+    """
 
     throttle_classes = ()
     permission_classes = ()
@@ -42,6 +45,9 @@ class UserRegistrationView(generics.CreateAPIView):
 
 
 class UserProfileView(generics.RetrieveUpdateAPIView):
+    """
+    An endpoint for users to view and update their profile information.
+    """
 
     serializer_class = serializers.UserProfileSerializer