Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit b529776

Browse files
Merge pull request #92 from EmadMokhtar/use-get_serialzier_class
Use get_serializer_class for Views without serlaizer_class attribute
2 parents e68b968 + 9155175 commit b529776

File tree

4 files changed

+51
-16
lines changed

4 files changed

+51
-16
lines changed

‎rest_framework_docs/api_endpoint.py‎

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,27 @@ def __get_permissions_class__(self):
3737

3838
def __get_serializer_fields__(self):
3939
fields = []
40+
serializer = None
4041

41-
if hasattr(self.callback.cls, 'serializer_get_fields'):
42+
if hasattr(self.callback.cls, 'serializer_class'):
4243
serializer = self.callback.cls.serializer_class
43-
if hasattr(serializer, 'get_fields'):
44-
try:
45-
fields = [{
46-
"name": key,
47-
"type": str(field.__class__.__name__),
48-
"required": field.required
49-
} for key, field in serializer().get_fields().items()]
50-
except KeyError as e:
51-
self.errors = e
52-
fields = []
53-
54-
# FIXME:
55-
# Show more attibutes of `field`?
44+
45+
elif hasattr(self.callback.cls, 'get_serializer_class'):
46+
serializer = self.callback.cls.get_serializer_class(self.pattern.callback.cls())
47+
48+
if hasattr(serializer, 'get_fields'):
49+
try:
50+
fields = [{
51+
"name": key,
52+
"type": str(field.__class__.__name__),
53+
"required": field.required
54+
} for key, field in serializer().get_fields().items()]
55+
except KeyError as e:
56+
self.errors = e
57+
fields = []
58+
59+
# FIXME:
60+
# Show more attibutes of `field`?
5661

5762
return fields
5863

‎tests/tests.py‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def test_index_view_with_endpoints(self):
2727
response = self.client.get(reverse('drfdocs'))
2828

2929
self.assertEqual(response.status_code, 200)
30-
self.assertEqual(len(response.context["endpoints"]), 10)
30+
self.assertEqual(len(response.context["endpoints"]), 11)
3131

3232
# Test the login view
3333
self.assertEqual(response.context["endpoints"][0].name_parent, "accounts")
@@ -38,8 +38,16 @@ def test_index_view_with_endpoints(self):
3838
self.assertEqual(response.context["endpoints"][0].fields[0]["type"], "CharField")
3939
self.assertTrue(response.context["endpoints"][0].fields[0]["required"])
4040

41+
self.assertEqual(response.context["endpoints"][1].name_parent, "accounts")
42+
self.assertEqual(response.context["endpoints"][1].allowed_methods, ['POST', 'OPTIONS'])
43+
self.assertEqual(response.context["endpoints"][1].path, "/accounts/login2/")
44+
self.assertEqual(response.context["endpoints"][1].docstring, "A view that allows users to login providing their username and password. Without serializer_class")
45+
self.assertEqual(len(response.context["endpoints"][1].fields), 2)
46+
self.assertEqual(response.context["endpoints"][1].fields[0]["type"], "CharField")
47+
self.assertTrue(response.context["endpoints"][1].fields[0]["required"])
48+
4149
# The view "OrganisationErroredView" (organisations/(?P<slug>[\w-]+)/errored/) should contain an error.
42-
self.assertEqual(str(response.context["endpoints"][8].errors), "'test_value'")
50+
self.assertEqual(str(response.context["endpoints"][9].errors), "'test_value'")
4351

4452
def test_index_search_with_endpoints(self):
4553
response = self.client.get("%s?search=reset-password" % reverse("drfdocs"))

‎tests/urls.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
accounts_urls = [
88
url(r'^login/$', views.LoginView.as_view(), name="login"),
9+
url(r'^login2/$', views.LoginWithSerilaizerClassView.as_view(), name="login2"),
910
url(r'^register/$', views.UserRegistrationView.as_view(), name="register"),
1011
url(r'^reset-password/$', view=views.PasswordResetView.as_view(), name="reset-password"),
1112
url(r'^reset-password/confirm/$', views.PasswordResetConfirmView.as_view(), name="reset-password-confirm"),

‎tests/views.py‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,24 @@ def delete(self, request, *args, **kwargs):
111111
class OrganisationErroredView(generics.ListAPIView):
112112

113113
serializer_class = serializers.OrganisationErroredSerializer
114+
115+
116+
class LoginWithSerilaizerClassView(APIView):
117+
"""
118+
A view that allows users to login providing their username and password. Without serializer_class
119+
"""
120+
121+
throttle_classes = ()
122+
permission_classes = ()
123+
parser_classes = (parsers.FormParser, parsers.MultiPartParser, parsers.JSONParser,)
124+
renderer_classes = (renderers.JSONRenderer,)
125+
126+
def post(self, request):
127+
serializer = self.serializer_class(data=request.data)
128+
serializer.is_valid(raise_exception=True)
129+
user = serializer.validated_data['user']
130+
token, created = Token.objects.get_or_create(user=user)
131+
return Response({'token': token.key})
132+
133+
def get_serializer_class(self):
134+
return AuthTokenSerializer

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /