Django 1.10 support. (#4158)

* Added TEMPLATES setting to tests
* Remove deprecated view-string in URL conf
* Replace 'urls = ...' in test classes with override_settings('ROOT_URLCONF=...')
* Refactor UsingURLPatterns to use override_settings(ROOT_URLCONF=...) style
* Get model managers and names in a version-compatible manner.
* Apply override_settings to a TestCase, not a mixin class
* Use '.callback' property instead of private attributes when inspecting urlpatterns
* Pass 'user' to template explicitly
* Correct sorting of import statements.
* Remove unused TEMPLATE_LOADERS setting, in favor of TEMPLATES.
* Remove code style issue
* BaseFilter test requires a concrete model
* Resolve tox.ini issues
* Resolve isort differences between local and tox environments

Author: tomchristie

rest_framework/compat.py

@@ -58,6 +58,23 @@ def distinct(queryset, base):
     return queryset.distinct()
 
 
+def get_names_and_managers(options):
+    if django.VERSION >= (1, 10):
+        # Django 1.10 onwards provides a `.managers` property on the Options.
+        return [
+            (manager.name, manager)
+            for manager
+            in options.managers
+        ]
+    # For Django 1.8 and 1.9, use the three-tuple information provided
+    # by .concrete_managers and .abstract_managers
+    return [
+        (manager_info[1], manager_info[2])
+        for manager_info
+        in (options.concrete_managers + options.abstract_managers)
+    ]
+
+
 # contrib.postgres only supported from 1.8 onwards.
 try:
     from django.contrib.postgres import fields as postgres_fields

rest_framework/renderers.py

@@ -635,6 +635,7 @@ def get_context(self, data, accepted_media_type, renderer_context):
             'view': view,
             'request': request,
             'response': response,
+            'user': request.user,
             'description': self.get_description(view, response.status_code),
             'name': self.get_name(view),
             'version': VERSION,

rest_framework/urlpatterns.py

@@ -24,7 +24,7 @@ def apply_suffix_patterns(urlpatterns, suffix_pattern, suffix_required):
         else:
             # Regular URL pattern
             regex = urlpattern.regex.pattern.rstrip('$').rstrip('/') + suffix_pattern
-            view = urlpattern._callback or urlpattern._callback_str
+            view = urlpattern.callback
             kwargs = urlpattern.default_args
             name = urlpattern.name
             # Add in both the existing and the new urlpattern

rest_framework/utils/representation.py

@@ -10,15 +10,15 @@
 from django.utils.encoding import force_text
 from django.utils.functional import Promise
 
-from rest_framework.compat import unicode_repr
+from rest_framework.compat import get_names_and_managers, unicode_repr
 
 
 def manager_repr(value):
     model = value.model
     opts = model._meta
-    for _, name, manager in opts.concrete_managers + opts.abstract_managers:
-        if manager == value:
-            return '%s.%s.all()' % (model._meta.object_name, name)
+    for manager_name, manager_instance in get_names_and_managers(opts):
+        if manager_instance == value:
+            return '%s.%s.all()' % (model._meta.object_name, manager_name)
     return repr(value)
 
 

runtests.py

@@ -14,7 +14,7 @@
 
 FLAKE8_ARGS = ['rest_framework', 'tests', '--ignore=E501']
 
-ISORT_ARGS = ['--recursive', '--check-only', 'rest_framework', 'tests']
+ISORT_ARGS = ['--recursive', '--check-only', '-p', 'tests', 'rest_framework', 'tests']
 
 sys.path.append(os.path.dirname(__file__))
 

tests/browsable_api/test_browsable_api.py

@@ -1,16 +1,14 @@
 from __future__ import unicode_literals
 
 from django.contrib.auth.models import User
-from django.test import TestCase
+from django.test import TestCase, override_settings
 
 from rest_framework.test import APIClient
 
 
+@override_settings(ROOT_URLCONF='tests.browsable_api.auth_urls')
 class DropdownWithAuthTests(TestCase):
     """Tests correct dropdown behaviour with Auth views enabled."""
-
-    urls = 'tests.browsable_api.auth_urls'
-
     def setUp(self):
         self.client = APIClient(enforce_csrf_checks=True)
         self.username = 'john'
@@ -40,11 +38,9 @@ def test_login_shown_when_logged_out(self):
         self.assertContains(response, '>Log in<')
 
 
+@override_settings(ROOT_URLCONF='tests.browsable_api.no_auth_urls')
 class NoDropdownWithoutAuthTests(TestCase):
     """Tests correct dropdown behaviour with Auth views NOT enabled."""
-
-    urls = 'tests.browsable_api.no_auth_urls'
-
     def setUp(self):
         self.client = APIClient(enforce_csrf_checks=True)
         self.username = 'john'

tests/browsable_api/views.py

@@ -6,9 +6,8 @@
 
 
 class MockView(APIView):
-
     authentication_classes = (authentication.SessionAuthentication,)
-    renderer_classes = (renderers.BrowsableAPIRenderer,)
+    renderer_classes = (renderers.BrowsableAPIRenderer, renderers.JSONRenderer)
 
     def get(self, request):
         return Response({'a': 1, 'b': 2, 'c': 3})

tests/conftest.py

@@ -3,18 +3,24 @@ def pytest_configure():
 
     settings.configure(
         DEBUG_PROPAGATE_EXCEPTIONS=True,
-        DATABASES={'default': {'ENGINE': 'django.db.backends.sqlite3',
-                               'NAME': ':memory:'}},
+        DATABASES={
+            'default': {
+                'ENGINE': 'django.db.backends.sqlite3',
+                'NAME': ':memory:'
+            }
+        },
         SITE_ID=1,
         SECRET_KEY='not very secret in tests',
         USE_I18N=True,
         USE_L10N=True,
         STATIC_URL='/static/',
         ROOT_URLCONF='tests.urls',
-        TEMPLATE_LOADERS=(
-            'django.template.loaders.filesystem.Loader',
-            'django.template.loaders.app_directories.Loader',
-        ),
+        TEMPLATES=[
+            {
+                'BACKEND': 'django.template.backends.django.DjangoTemplates',
+                'APP_DIRS': True,
+            },
+        ],
         MIDDLEWARE_CLASSES=(
             'django.middleware.common.CommonMiddleware',
             'django.contrib.sessions.middleware.SessionMiddleware',
@@ -27,7 +33,6 @@ def pytest_configure():
             'django.contrib.sessions',
             'django.contrib.sites',
             'django.contrib.staticfiles',
-
             'rest_framework',
             'rest_framework.authtoken',
             'tests',

tests/models.py

@@ -27,9 +27,6 @@ class BasicModel(RESTFrameworkModel):
 class BaseFilterableItem(RESTFrameworkModel):
     text = models.CharField(max_length=100)
 
-    class Meta:
-        abstract = True
-
 
 class FilterableItem(BaseFilterableItem):
     decimal = models.DecimalField(max_digits=4, decimal_places=2)

tests/test_authentication.py

@@ -8,7 +8,7 @@
 from django.contrib.auth.models import User
 from django.db import models
 from django.http import HttpResponse
-from django.test import TestCase
+from django.test import TestCase, override_settings
 from django.utils import six
 
 from rest_framework import (
@@ -19,6 +19,7 @@
     TokenAuthentication
 )
 from rest_framework.authtoken.models import Token
+from rest_framework.authtoken.views import obtain_auth_token
 from rest_framework.response import Response
 from rest_framework.test import APIClient, APIRequestFactory
 from rest_framework.views import APIView
@@ -75,15 +76,14 @@ def put(self, request):
             authentication_classes=[CustomKeywordTokenAuthentication]
         )
     ),
-    url(r'^auth-token/$', 'rest_framework.authtoken.views.obtain_auth_token'),
+    url(r'^auth-token/$', obtain_auth_token),
     url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')),
 ]
 
 
+@override_settings(ROOT_URLCONF='tests.test_authentication')
 class BasicAuthTests(TestCase):
     """Basic authentication"""
-    urls = 'tests.test_authentication'
-
     def setUp(self):
         self.csrf_client = APIClient(enforce_csrf_checks=True)
         self.username = 'john'
@@ -151,10 +151,9 @@ def test_post_json_failing_basic_auth(self):
         self.assertEqual(response['WWW-Authenticate'], 'Basic realm="api"')
 
 
+@override_settings(ROOT_URLCONF='tests.test_authentication')
 class SessionAuthTests(TestCase):
     """User session authentication"""
-    urls = 'tests.test_authentication'
-
     def setUp(self):
         self.csrf_client = APIClient(enforce_csrf_checks=True)
         self.non_csrf_client = APIClient(enforce_csrf_checks=False)
@@ -223,7 +222,6 @@ def test_post_form_session_auth_failing(self):
 
 class BaseTokenAuthTests(object):
     """Token authentication"""
-    urls = 'tests.test_authentication'
     model = None
     path = None
     header_prefix = 'Token '
@@ -311,6 +309,7 @@ def test_post_json_failing_token_auth(self):
         self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED)
 
 
+@override_settings(ROOT_URLCONF='tests.test_authentication')
 class TokenAuthTests(BaseTokenAuthTests, TestCase):
     model = Token
     path = '/token/'
@@ -367,11 +366,13 @@ def test_token_login_form(self):
         self.assertEqual(response.data['token'], self.key)
 
 
+@override_settings(ROOT_URLCONF='tests.test_authentication')
 class CustomTokenAuthTests(BaseTokenAuthTests, TestCase):
     model = CustomToken
     path = '/customtoken/'
 
 
+@override_settings(ROOT_URLCONF='tests.test_authentication')
 class CustomKeywordTokenAuthTests(BaseTokenAuthTests, TestCase):
     model = Token
     path = '/customkeywordtoken/'

tests/test_filters.py

@@ -274,12 +274,11 @@ def test_unknown_filter(self):
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
 
+@override_settings(ROOT_URLCONF='tests.test_filters')
 class IntegrationTestDetailFiltering(CommonFilteringTestCase):
     """
     Integration tests for filtered detail views.
     """
-    urls = 'tests.test_filters'
-
     def _get_url(self, item):
         return reverse('detail-view', kwargs=dict(pk=item.pk))
 

tests/test_htmlrenderer.py

@@ -5,7 +5,7 @@
 from django.core.exceptions import PermissionDenied
 from django.http import Http404
 from django.template import Template, TemplateDoesNotExist
-from django.test import TestCase
+from django.test import TestCase, override_settings
 from django.utils import six
 
 from rest_framework import status
@@ -43,9 +43,8 @@ def not_found(request):
 ]
 
 
+@override_settings(ROOT_URLCONF='tests.test_htmlrenderer')
 class TemplateHTMLRendererTests(TestCase):
-    urls = 'tests.test_htmlrenderer'
-
     def setUp(self):
         """
         Monkeypatch get_template
@@ -89,9 +88,8 @@ def test_permission_denied_html_view(self):
         self.assertEqual(response['Content-Type'], 'text/html; charset=utf-8')
 
 
+@override_settings(ROOT_URLCONF='tests.test_htmlrenderer')
 class TemplateHTMLRendererExceptionTests(TestCase):
-    urls = 'tests.test_htmlrenderer'
-
     def setUp(self):
         """
         Monkeypatch get_template

tests/test_middleware.py

@@ -1,6 +1,6 @@
-
 from django.conf.urls import url
 from django.contrib.auth.models import User
+from django.test import override_settings
 
 from rest_framework.authentication import TokenAuthentication
 from rest_framework.authtoken.models import Token
@@ -20,10 +20,8 @@ def process_response(self, request, response):
         return response
 
 
+@override_settings(ROOT_URLCONF='tests.test_middleware')
 class TestMiddleware(APITestCase):
-
-    urls = 'tests.test_middleware'
-
     def test_middleware_can_access_user_when_processing_response(self):
         user = User.objects.create_user('john', '[email protected]', 'password')
         key = 'abcd1234'

tests/test_relations_hyperlink.py

@@ -1,7 +1,7 @@
 from __future__ import unicode_literals
 
 from django.conf.urls import url
-from django.test import TestCase
+from django.test import TestCase, override_settings
 
 from rest_framework import serializers
 from rest_framework.test import APIRequestFactory
@@ -71,10 +71,8 @@ class Meta:
 
 
 # TODO: Add test that .data cannot be accessed prior to .is_valid
-
+@override_settings(ROOT_URLCONF='tests.test_relations_hyperlink')
 class HyperlinkedManyToManyTests(TestCase):
-    urls = 'tests.test_relations_hyperlink'
-
     def setUp(self):
         for idx in range(1, 4):
             target = ManyToManyTarget(name='target-%d' % idx)
@@ -188,9 +186,8 @@ def test_reverse_many_to_many_create(self):
         self.assertEqual(serializer.data, expected)
 
 
+@override_settings(ROOT_URLCONF='tests.test_relations_hyperlink')
 class HyperlinkedForeignKeyTests(TestCase):
-    urls = 'tests.test_relations_hyperlink'
-
     def setUp(self):
         target = ForeignKeyTarget(name='target-1')
         target.save()
@@ -318,9 +315,8 @@ def test_foreign_key_update_with_invalid_null(self):
         self.assertEqual(serializer.errors, {'target': ['This field may not be null.']})
 
 
+@override_settings(ROOT_URLCONF='tests.test_relations_hyperlink')
 class HyperlinkedNullableForeignKeyTests(TestCase):
-    urls = 'tests.test_relations_hyperlink'
-
     def setUp(self):
         target = ForeignKeyTarget(name='target-1')
         target.save()
@@ -425,9 +421,8 @@ def test_foreign_key_update_with_valid_emptystring(self):
         self.assertEqual(serializer.data, expected)
 
 
+@override_settings(ROOT_URLCONF='tests.test_relations_hyperlink')
 class HyperlinkedNullableOneToOneTests(TestCase):
-    urls = 'tests.test_relations_hyperlink'
-
     def setUp(self):
         target = OneToOneTarget(name='target-1')
         target.save()

tests/test_renderers.py

@@ -8,7 +8,7 @@
 from django.conf.urls import include, url
 from django.core.cache import cache
 from django.db import models
-from django.test import TestCase
+from django.test import TestCase, override_settings
 from django.utils import six
 from django.utils.safestring import SafeText
 from django.utils.translation import ugettext_lazy as _
@@ -148,13 +148,11 @@ def test_only_permitted_forms_are_displayed(self):
         self.assertContains(response, '>PATCH<')
 
 
+@override_settings(ROOT_URLCONF='tests.test_renderers')
 class RendererEndToEndTests(TestCase):
     """
     End-to-end testing of renderers using an RendererMixin on a generic view.
     """
-
-    urls = 'tests.test_renderers'
-
     def test_default_renderer_serializes_content(self):
         """If the Accept header is not set the default renderer should serialize the response."""
         resp = self.client.get('/')
@@ -397,13 +395,11 @@ class AsciiJSONRenderer(JSONRenderer):
 
 
 # Tests for caching issue, #346
+@override_settings(ROOT_URLCONF='tests.test_renderers')
 class CacheRenderTest(TestCase):
     """
     Tests specific to caching responses
     """
-
-    urls = 'tests.test_renderers'
-
     def test_head_caching(self):
         """
         Test caching of HEAD requests