Merge from upstream + allow list of drf_routers

Author: Maxence

demo/project/accounts/urls.py

@@ -1,15 +1,23 @@
+import django
 from django.conf.urls import url
 from project.accounts import views
 
+from rest_framework.routers import SimpleRouter
 
-urlpatterns = [
- url(r'^test/$', views.TestView.as_view(), name="test-view"),
+account_router = SimpleRouter()
+account_router.register('user-model-viewsets', views.UserModelViewset, base_name='account')
 
+account_urlpatterns = [
+ url(r'^test/$', views.TestView.as_view(), name="test-view"),
  url(r'^login/$', views.LoginView.as_view(), name="login"),
  url(r'^register/$', views.UserRegistrationView.as_view(), name="register"),
  url(r'^reset-password/$', view=views.PasswordResetView.as_view(), name="reset-password"),
  url(r'^reset-password/confirm/$', views.PasswordResetConfirmView.as_view(), name="reset-password-confirm"),
-
  url(r'^user/profile/$', views.UserProfileView.as_view(), name="profile"),
+] + account_router.urls
 
-]
+# Django 1.9 Support for the app_name argument is deprecated
+# https://docs.djangoproject.com/en/1.9/ref/urls/#include
+django_version = django.VERSION
+if django.VERSION[:2] >= (1, 9, ):
+ account_urlpatterns = (account_urlpatterns, 'accounts', )

demo/project/accounts/views.py

@@ -5,6 +5,7 @@
 from rest_framework.permissions import AllowAny
 from rest_framework.response import Response
 from rest_framework.views import APIView
+from rest_framework.viewsets import ModelViewSet
 from project.accounts.models import User
 from project.accounts.serializers import (
  UserRegistrationSerializer, UserProfileSerializer, ResetPasswordSerializer, CustomAuthTokenSerializer
@@ -80,3 +81,8 @@ def post(self, request, *args, **kwargs):
  if not serializer.is_valid():
  return Response({'errors': serializer.errors}, status=status.HTTP_400_BAD_REQUEST)
  return Response({"msg": "Password updated successfully."}, status=status.HTTP_200_OK)
+
+
+class UserModelViewset(ModelViewSet):
+ queryset = User.objects.all()
+ serializer_class = UserProfileSerializer

demo/project/organisations/urls.py

@@ -2,13 +2,18 @@
 from django.conf.urls import url
 from project.organisations import views
 
+from rest_framework.routers import SimpleRouter
+from .views import OrganisationModelViewset
+
+organisation_router = SimpleRouter()
+organisation_router.register('organisation-model-viewsets', OrganisationModelViewset, base_name='organisation')
 
 organisations_urlpatterns = [
  url(r'^create/$', view=views.CreateOrganisationView.as_view(), name="create"),
  url(r'^(?P<slug>[\w-]+)/$', view=views.RetrieveOrganisationView.as_view(), name="organisation"),
  url(r'^(?P<slug>[\w-]+)/members/$', view=views.OrganisationMembersView.as_view(), name="members"),
  url(r'^(?P<slug>[\w-]+)/leave/$', view=views.LeaveOrganisationView.as_view(), name="leave")
-]
+] + organisation_router.urls
 
 members_urlpatterns = [
  url(r'^(?P<slug>[\w-]+)/members/$', view=views.OrganisationMembersView.as_view(), name="members"),
@@ -18,5 +23,5 @@
 # https://docs.djangoproject.com/en/1.9/ref/urls/#include
 django_version = django.VERSION
 if django.VERSION[:2] >= (1, 9, ):
- organisations_urlpatterns = (organisations_urlpatterns, 'organisations_app', )
- members_urlpatterns = (members_urlpatterns, 'organisations_app', )
+ organisations_urlpatterns = (organisations_urlpatterns, 'organisations', )
+ members_urlpatterns = (members_urlpatterns, 'organisations', )

demo/project/organisations/views.py

@@ -1,5 +1,6 @@
 from rest_framework import generics, status
 from rest_framework.response import Response
+from rest_framework.viewsets import ModelViewSet
 from project.organisations.models import Organisation, Membership
 from project.organisations.serializers import (
  CreateOrganisationSerializer, OrganisationMembersSerializer, RetrieveOrganisationSerializer
@@ -34,3 +35,8 @@ def delete(self, request, *args, **kwargs):
  instance = self.get_object()
  self.perform_destroy(instance)
  return Response(status=status.HTTP_204_NO_CONTENT)
+
+
+class OrganisationModelViewset(ModelViewSet):
+ queryset = Organisation.objects.all()
+ serializer_class = OrganisationMembersSerializer

demo/project/urls.py

@@ -16,26 +16,35 @@
 import django
 from django.conf.urls import include, url
 from django.contrib import admin
-from .organisations.urls import organisations_urlpatterns, members_urlpatterns
+from rest_framework_docs.views import DRFDocsView
+from .accounts.urls import account_urlpatterns, account_router
+from .organisations.urls import organisations_urlpatterns, members_urlpatterns, organisation_router
 
 urlpatterns = [
  url(r'^admin/', include(admin.site.urls)),
- url(r'^docs/', include('rest_framework_docs.urls')),
-
- # API
- url(r'^accounts/', view=include('project.accounts.urls', namespace='accounts')),
 ]
 
 # Django 1.9 Support for the app_name argument is deprecated
 # https://docs.djangoproject.com/en/1.9/ref/urls/#include
 django_version = django.VERSION
 if django.VERSION[:2] >= (1, 9, ):
  urlpatterns.extend([
+ url(r'^accounts/', view=include(account_urlpatterns, namespace='accounts')),
  url(r'^organisations/', view=include(organisations_urlpatterns, namespace='organisations')),
  url(r'^members/', view=include(members_urlpatterns, namespace='members')),
  ])
 else:
  urlpatterns.extend([
+ url(r'^accounts/', view=include(account_urlpatterns, namespace='accounts', app_name='account_app')),
  url(r'^organisations/', view=include(organisations_urlpatterns, namespace='organisations', app_name='organisations_app')),
  url(r'^members/', view=include(members_urlpatterns, namespace='members', app_name='organisations_app')),
  ])
+
+
+from tests.views import LoginView
+routers = [account_router, organisation_router]
+urlpatterns.extend([
+ url(r'^docs/(?P<filter_param>[\w-]+)/$', DRFDocsView.as_view(drf_router=routers), name='drfdocs-filter'),
+ url(r'^docs/$', DRFDocsView.as_view(drf_router=routers), name='drfdocs'),
+ url(r'^another-login/$', LoginView.as_view(), name="login"),
+])

rest_framework_docs/api_docs.py

@@ -30,11 +30,12 @@ def __init__(self, drf_router=None, filter_param=None):
  def get_all_view_names(self, urlpatterns, parent_pattern=None, filter_param=None):
  for pattern in urlpatterns:
  if isinstance(pattern, RegexURLResolver) and (not filter_param or filter_param in [pattern.app_name, pattern.namespace]):
- parent_pattern = None if pattern._regex == "^" else pattern
- self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_pattern=pattern, filter_param=filter_param)
+ # parent_pattern = None if pattern._regex == "^" else pattern
+ self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_pattern=None if pattern._regex == "^" else pattern, filter_param=filter_param)
  elif isinstance(pattern, RegexURLPattern) and self._is_drf_view(pattern) and not self._is_format_endpoint(pattern):
- api_endpoint = ApiEndpoint(pattern, parent_pattern, self.drf_router)
- self.endpoints.append(api_endpoint)
+ if not filter_param or parent_pattern:
+ api_endpoint = ApiEndpoint(pattern, parent_pattern, self.drf_router)
+ self.endpoints.append(api_endpoint)
 
  def _is_drf_view(self, pattern):
  """

rest_framework_docs/api_endpoint.py

@@ -2,24 +2,17 @@
 import inspect
 from django.contrib.admindocs.views import simplify_regex
 from django.utils.encoding import force_str
-from rest_framework.serializers import BaseSerializer
-
 from rest_framework import serializers
 from rest_framework.viewsets import ModelViewSet
 from rest_framework_docs import SERIALIZER_FIELDS
 
 
-METHODS_ORDER = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS']
-VIEWSET_METHODS = {
- 'List': ['get', 'post'],
- 'Instance': ['get', 'put', 'patch', 'delete'],
-}
-
-
 class ApiEndpoint(object):
 
  def __init__(self, pattern, parent_pattern=None, drf_router=None):
- self.drf_router = drf_router
+ self.drf_router = drf_router or []
+ if not isinstance(self.drf_router, (list, tuple)):
+ self.drf_router = [self.drf_router]
  self.pattern = pattern
  self.callback = pattern.callback
  self.docstring = self.__get_docstring__()
@@ -40,9 +33,8 @@ def __init__(self, pattern, parent_pattern=None, drf_router=None):
  self.serializer_class = self.__get_serializer_class__()
  if self.serializer_class:
  self.serializer = self.__get_serializer__()
- self.fields = self.__get_serializer_fields__(self.serializer)
+ self.fields = self.__get_serializer_fields__()
  self.fields_json = self.__get_serializer_fields_json__()
-
  self.permissions = self.__get_permissions_class__()
 
  def __get_path__(self, parent_pattern):
@@ -51,38 +43,28 @@ def __get_path__(self, parent_pattern):
  return simplify_regex(self.pattern.regex.pattern)
 
  def __get_allowed_methods__(self):
- callback_cls = self.callback.cls
-
- def is_method_allowed(method_name):
- return hasattr(callback_cls, method_name) or (
- issubclass(callback_cls, ModelViewSet) and
- method_name in VIEWSET_METHODS.get(self.callback.suffix, []))
-
- return sorted(
- [force_str(name).upper() for name in callback_cls.http_method_names if is_method_allowed(name)],
- key=lambda e: METHODS_ORDER.index(e))
 
  viewset_methods = []
- if self.drf_router:
- for prefix, viewset, basename in self.drf_router.registry:
+ for router in self.drf_router:
+ for prefix, viewset, basename in router.registry:
  if self.callback.cls != viewset:
  continue
 
- lookup = self.drf_router.get_lookup_regex(viewset)
- routes = self.drf_router.get_routes(viewset)
+ lookup = router.get_lookup_regex(viewset)
+ routes = router.get_routes(viewset)
 
  for route in routes:
 
  # Only actions which actually exist on the viewset will be bound
- mapping = self.drf_router.get_method_map(viewset, route.mapping)
+ mapping = router.get_method_map(viewset, route.mapping)
  if not mapping:
  continue
 
  # Build the url pattern
  regex = route.url.format(
  prefix=prefix,
  lookup=lookup,
- trailing_slash=self.drf_router.trailing_slash
+ trailing_slash=router.trailing_slash
  )
  if self.pattern.regex.pattern == regex:
  funcs, viewset_methods = zip(
@@ -92,7 +74,8 @@ def is_method_allowed(method_name):
  if len(set(funcs)) == 1:
  self.docstring = inspect.getdoc(getattr(self.callback.cls, funcs[0]))
 
- view_methods = [force_str(m).upper() for m in self.callback.cls.http_method_names if hasattr(self.callback.cls, m)]
+ view_methods = [force_str(m).upper() for m in self.callback.cls.http_method_names if
+ hasattr(self.callback.cls, m)]
  return viewset_methods + view_methods
 
  def __get_docstring__(self):
@@ -102,22 +85,6 @@ def __get_permissions_class__(self):
  for perm_class in self.pattern.callback.cls.permission_classes:
  return perm_class.__name__
 
- def __get_serializer_fields__(self):
- fields = []
- serializer = None
-
- if hasattr(self.callback.cls, 'serializer_class'):
- serializer = self.callback.cls.serializer_class
-
- elif hasattr(self.callback.cls, 'get_serializer_class'):
- serializer = self.callback.cls.get_serializer_class(self.pattern.callback.cls())
-
- if hasattr(serializer, 'get_fields'):
- try:
- fields = self.__get_fields__(serializer)
- except KeyError as e:
- self.errors = e
- fields = []
  def __get_serializer__(self):
  try:
  return self.serializer_class()

tests/tests.py

@@ -28,10 +28,10 @@ def test_index_view_with_endpoints(self):
  response = self.client.get(reverse('drfdocs'))
 
  self.assertEqual(response.status_code, 200)
- self.assertEqual(len(response.context["endpoints"]), 15)
+ self.assertEqual(len(response.context["endpoints"]), 16)
 
  # Test the login view
- endpoint = response.context["endpoints"][1]
+ endpoint = response.context["endpoints"][4]
  self.assertEqual(endpoint.name_parent, "accounts")
  self.assertEqual(endpoint.allowed_methods, ['POST', 'OPTIONS'])
  self.assertEqual(endpoint.path, "/accounts/login/")
@@ -41,7 +41,7 @@ def test_index_view_with_endpoints(self):
  self.assertTrue(endpoint.fields[0]["required"])
 
  # The view "OrganisationErroredView" (organisations/(?P<slug>[\w-]+)/errored/) should contain an error.
- endpoint = response.context["endpoints"][8]
+ endpoint = response.context["endpoints"][12]
  self.assertEqual(str(endpoint.errors), "'test_value'")
 
  def test_index_search_with_endpoints(self):
@@ -81,10 +81,10 @@ def test_index_view_with_existent_namespace(self):
  # Test 'organisations' namespace
  response = self.client.get(reverse('drfdocs-filter', args=['organisations']))
  self.assertEqual(response.status_code, 200)
- self.assertEqual(len(response.context["endpoints"]), 3)
+ self.assertEqual(len(response.context["endpoints"]), 5)
 
  # The view "OrganisationErroredView" (organisations/(?P<slug>[\w-]+)/errored/) should contain an error.
- self.assertEqual(str(response.context["endpoints"][0].errors), "'test_value'")
+ self.assertEqual(str(response.context["endpoints"][1].errors), "'test_value'")
 
  # Test 'members' namespace
  response = self.client.get(reverse('drfdocs-filter', args=['members']))
@@ -107,9 +107,9 @@ def test_index_view_with_existent_app_name(self):
  # Test 'organisations_app' app_name
  response = self.client.get(reverse('drfdocs-filter', args=['organisations_app']))
  self.assertEqual(response.status_code, 200)
- self.assertEqual(len(response.context["endpoints"]), 4)
+ self.assertEqual(len(response.context["endpoints"]), 6)
  parents_name = [e.name_parent for e in response.context["endpoints"]]
- self.assertEquals(parents_name.count('organisations'), 3)
+ self.assertEquals(parents_name.count('organisations'), 5)
  self.assertEquals(parents_name.count('members'), 1)
 
  def test_index_search_with_existent_app_name(self):
@@ -118,7 +118,7 @@ def test_index_search_with_existent_app_name(self):
  self.assertEqual(response.status_code, 200)
  self.assertEqual(len(response.context["endpoints"]), 1)
  self.assertEqual(response.context["endpoints"][0].path, "/organisations/create/")
- self.assertEqual(len(response.context["endpoints"][0].fields), 2)
+ self.assertEqual(len(response.context["endpoints"][0].fields), 3)
 
  def test_index_view_with_non_existent_namespace_or_app_name(self):
  """
@@ -130,14 +130,10 @@ def test_index_view_with_non_existent_namespace_or_app_name(self):
 
  def test_model_viewset(self):
  response = self.client.get(reverse('drfdocs'))
-
  self.assertEqual(response.status_code, 200)
-
- self.assertEqual(response.context["endpoints"][10].path, '/organisations/<slug>/')
- self.assertEqual(response.context['endpoints'][6].fields[2]['to_many_relation'], True)
- self.assertEqual(response.context["endpoints"][11].path, '/organisation-model-viewsets/')
- self.assertEqual(response.context["endpoints"][12].path, '/organisation-model-viewsets/<pk>/')
- self.assertEqual(response.context["endpoints"][11].allowed_methods, ['GET', 'POST', 'OPTIONS'])
- self.assertEqual(response.context["endpoints"][12].allowed_methods, ['GET', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'])
- self.assertEqual(response.context["endpoints"][13].allowed_methods, ['POST', 'OPTIONS'])
- self.assertEqual(response.context["endpoints"][13].docstring, 'This is a test.')
+ self.assertEqual(response.context["endpoints"][1].path, '/organisation-model-viewsets/')
+ self.assertEqual(response.context["endpoints"][2].path, '/organisation-model-viewsets/<pk>/')
+ self.assertEqual(response.context["endpoints"][1].allowed_methods, ['GET', 'POST', 'OPTIONS'])
+ self.assertEqual(response.context["endpoints"][2].allowed_methods, ['GET', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'])
+ self.assertEqual(response.context["endpoints"][4].allowed_methods, ['POST', 'OPTIONS'])
+ self.assertEqual(response.context["endpoints"][3].docstring, 'This is a test.')

tests/urls.py

@@ -7,6 +7,7 @@
 from rest_framework_docs.views import DRFDocsView
 from tests import views
 
+
 accounts_urls = [
  url(r'^login/$', views.LoginView.as_view(), name="login"),
  url(r'^login2/$', views.LoginWithSerilaizerClassView.as_view(), name="login2"),
@@ -36,12 +37,14 @@
 
 urlpatterns = [
  url(r'^admin/', include(admin.site.urls)),
- url(r'^docs/', DRFDocsView.as_view(drf_router=router), name='drfdocs'),
+
+ # url(r'^docs/', include('rest_framework_docs.urls')),
+ url(r'^docs/(?P<filter_param>[\w-]+)/$', DRFDocsView.as_view(drf_router=router), name='drfdocs-filter'),
+ url(r'^docs/$', DRFDocsView.as_view(drf_router=router), name='drfdocs'),
 
  # API
- url(r'^accounts/', view=include(accounts_urls, namespace="accounts")),
- url(r'^accounts/', view=include(accounts_urls, namespace='accounts')),
- url(r'^organisations/', view=include(organisations_urls, namespace='organisations')),
+ # url(r'^accounts/', view=include(accounts_urls, namespace="accounts")),
+ # url(r'^organisations/', view=include(organisations_urls, namespace='organisations')),
  url(r'^', include(router.urls)),
 
  # Endpoints without parents/namespaces
@@ -55,11 +58,13 @@
  organisations_urls = (organisations_urls, 'organisations_app', )
  members_urls = (members_urls, 'organisations_app', )
  urlpatterns.extend([
+ url(r'^accounts/', view=include(accounts_urls, namespace="accounts")),
  url(r'^organisations/', view=include(organisations_urls, namespace='organisations')),
  url(r'^members/', view=include(members_urls, namespace='members')),
  ])
 else:
  urlpatterns.extend([
+ url(r'^accounts/', view=include(accounts_urls, namespace="accounts", app_name='accounts_app')),
  url(r'^organisations/', view=include(organisations_urls, namespace='organisations', app_name='organisations_app')),
  url(r'^members/', view=include(members_urls, namespace='members', app_name='organisations_app')),
  ])