Implemented support for Django 2.0

Author: jasperlittle

demo/project/accounts/urls.py

@@ -1,6 +1,7 @@
 from django.conf.urls import url
 from project.accounts import views
 
+app_name = "accounts"
 
 urlpatterns = [
     url(r'^test/$', views.TestView.as_view(), name="test-view"),

demo/project/organisations/models.py

@@ -29,7 +29,7 @@ class Meta:
     id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
     joined = models.DateTimeField(auto_now_add=True)
 
-    organisation = models.ForeignKey(Organisation)
-    user = models.ForeignKey(User)
+    organisation = models.ForeignKey(Organisation, on_delete=models.CASCADE)
+    user = models.ForeignKey(User, on_delete=models.CASCADE)
     role = models.CharField(choices=MEMBER_ROLES, max_length=20, default="USER")
     is_owner = models.BooleanField(default=False)

demo/project/organisations/urls.py

@@ -1,6 +1,7 @@
 from django.conf.urls import url
 from project.organisations import views
 
+app_name = "organisations"
 
 urlpatterns = [
 

demo/project/urls.py

@@ -17,7 +17,7 @@
 from django.contrib import admin
 
 urlpatterns = [
-    url(r'^admin/', include(admin.site.urls)),
+    url(r'^admin/', admin.site.urls),
     url(r'^docs/', include('rest_framework_docs.urls')),
 
     # API

rest_framework_docs/api_docs.py

@@ -1,9 +1,20 @@
 from importlib import import_module
 from django.conf import settings
-from django.core.urlresolvers import RegexURLResolver, RegexURLPattern
+try:
+    from django.urls import (
+        URLPattern,
+        URLResolver,
+    )
+except ImportError:
+    # Will be removed in Django 2.0
+    from django.urls import (
+        RegexURLPattern as URLPattern,
+        RegexURLResolver as URLResolver,
+    )
 from django.utils.module_loading import import_string
 from rest_framework.views import APIView
 from rest_framework_docs.api_endpoint import ApiEndpoint
+from rest_framework.compat import get_regex_pattern
 
 
 class ApiDocumentation(object):
@@ -23,10 +34,10 @@ def __init__(self, drf_router=None):
 
     def get_all_view_names(self, urlpatterns, parent_regex=''):
         for pattern in urlpatterns:
-            if isinstance(pattern, RegexURLResolver):
-                regex = '' if pattern._regex == "^" else pattern._regex
+            if isinstance(pattern, URLResolver):
+                regex = '' if get_regex_pattern(pattern) == "^" else get_regex_pattern(pattern)
                 self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_regex=parent_regex + regex)
-            elif isinstance(pattern, RegexURLPattern) and self._is_drf_view(pattern) and not self._is_format_endpoint(pattern):
+            elif isinstance(pattern, URLPattern) and self._is_drf_view(pattern) and not self._is_format_endpoint(pattern):
                 api_endpoint = ApiEndpoint(pattern, parent_regex, self.drf_router)
                 self.endpoints.append(api_endpoint)
 
@@ -40,7 +51,7 @@ def _is_format_endpoint(self, pattern):
         """
         Exclude endpoints with a "format" parameter
         """
-        return '?P<format>' in pattern._regex
+        return '?P<format>' in get_regex_pattern(pattern)
 
     def get_endpoints(self):
         return self.endpoints

rest_framework_docs/api_endpoint.py

@@ -6,6 +6,7 @@
 
 from rest_framework.viewsets import ModelViewSet
 from rest_framework.serializers import BaseSerializer
+from rest_framework.compat import get_regex_pattern
 
 VIEWSET_METHODS = {
     'List': ['get', 'post'],
@@ -35,9 +36,10 @@ def __init__(self, pattern, parent_regex=None, drf_router=None):
         self.permissions = self.__get_permissions_class__()
 
     def __get_path__(self, parent_regex):
+        regex = get_regex_pattern(self.pattern)
         if parent_regex:
-            return "/{0}{1}".format(self.name_parent, simplify_regex(self.pattern.regex.pattern))
-        return simplify_regex(self.pattern.regex.pattern)
+            return "/{0}{1}".format(self.name_parent, simplify_regex(regex))
+        return simplify_regex(regex)
 
     def is_method_allowed(self, callback_cls, method_name):
         has_attr = hasattr(callback_cls, method_name)
@@ -69,7 +71,7 @@ def __get_allowed_methods__(self):
                         lookup=lookup,
                         trailing_slash=self.drf_router.trailing_slash
                     )
-                    if self.pattern.regex.pattern == regex:
+                    if get_regex_pattern(self.pattern) == regex:
                         funcs, viewset_methods = zip(
                             *[(mapping[m], m.upper())
                               for m in self.callback.cls.http_method_names

tests/models.py

@@ -43,7 +43,7 @@ class Meta:
     id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
     joined = models.DateTimeField(auto_now_add=True)
 
-    organisation = models.ForeignKey(Organisation)
-    user = models.ForeignKey(User)
+    organisation = models.ForeignKey(Organisation, on_delete=models.CASCADE)
+    user = models.ForeignKey(User, on_delete=models.CASCADE)
     role = models.CharField(choices=MEMBER_ROLES, max_length=20, default="USER")
     is_owner = models.BooleanField(default=False)

tests/settings.py

@@ -39,3 +39,20 @@
 # https://docs.djangoproject.com/en/1.8/howto/static-files/
 
 STATIC_URL = '/static/'
+
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]

tests/tests.py

@@ -1,4 +1,9 @@
-from django.core.urlresolvers import reverse
+try:
+    from django.urls import reverse
+except ImportError:
+    # Will be removed in Django 2.0
+    from django.core.urlresolvers import reverse
+
 from django.test import TestCase, override_settings
 from rest_framework_docs.settings import DRFSettings
 

tests/urls.py

@@ -30,12 +30,12 @@
 router.register('organisation-model-viewsets', views.TestModelViewSet, base_name='organisation')
 
 urlpatterns = [
-    url(r'^admin/', include(admin.site.urls)),
+    url(r'^admin/', admin.site.urls),
     url(r'^docs/', DRFDocsView.as_view(drf_router=router), name='drfdocs'),
 
     # API
-    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, "accounts"), namespace='accounts')),
+    url(r'^organisations/', view=include((organisations_urls, "organisations"), namespace='organisations')),
     url(r'^', include(router.urls)),
 
     # Endpoints without parents/namespaces